`@codesoul-co/hypha-mcp` / `connection-manager`

包索引: @codesoul-co/hypha-mcp
源码: packages/mcp/src/connection-manager.ts
导出数: 18

模块用法

用于使用该功能边界的公共契约与操作。Connection manager 模块公开 2 类、4 常量、2 函数、9 接口、1 类型。

从包入口导入

import {
  MCPConnectionManager,
  SDKMCPConnectionSessionFactory,
  mcpConnectionRecordDefinition,
  mcpConnectionRecordExample,
  mcpConnectionRecordJsonSchema,
  mcpConnectionRecordSchema,
  assertRemoteEgressAllowed,
  createGuardedMCPFetch,
} from '@codesoul-co/hypha-mcp';

import type {
  GuardedMCPFetchOptions,
  MCPConnectionManagerOptions,
  MCPConnectionRecord,
  MCPConnectionSession,
  MCPConnectionSessionFactory,
  MCPConnectionStatus,
  MCPRemoteContentArtifact,
  MCPRemoteContentArtifactPort,
} from '@codesoul-co/hypha-mcp';

// 完整导出列表见下方。

使用要点

10 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
2 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
2 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
4 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

运行时校验示例

import { mcpConnectionRecordSchema } from '@codesoul-co/hypha-mcp';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = mcpConnectionRecordSchema.parse(input);

配置、网络请求或持久化数据等不可信输入应先通过 Runtime Schema，再传给只接受已校验契约的函数或类。

公共导出

Symbol	种类	签名	说明
`MCPConnectionManager`	类	`new MCPConnectionManager(options: MCPConnectionManagerOptions): MCPConnectionManager`	MCP Connection Manager 类，共公开 16 个构造函数或成员；精确签名见本条目的声明与成员表。
`SDKMCPConnectionSessionFactory`	类	`new SDKMCPConnectionSessionFactory(options?: SDKMCPConnectionSessionFactoryOptions): SDKMCPConnectionSessionFactory`	SDKMCP Connection Session Factory 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
`mcpConnectionRecordDefinition`	常量	`const mcpConnectionRecordDefinition: SpecSchemaDefinition<MCPConnectionRecord>`	由 `connection-manager` 模块导出的 MCP Connection Record Definition 常量。
`mcpConnectionRecordExample`	常量	`const mcpConnectionRecordExample: MCPConnectionRecord`	MCP Connection Record 的有效示例值。
`mcpConnectionRecordJsonSchema`	常量	`const mcpConnectionRecordJsonSchema: JsonSchema`	MCP Connection Record 的 JSON Schema。
`mcpConnectionRecordSchema`	常量	`const mcpConnectionRecordSchema: z.ZodObject<{ id: z.ZodString; serverId: z.ZodString; revision: z.ZodNumber; state: z.ZodEnum<["disconnected", "starting", "initializing", "ready", "degraded", "reconnecting", "closing", "closed", "failed"]>; transportType: z.ZodEnum<["stdio", "streamable_http", "custom"]>; negotiatedProtocolVersion: z.ZodOptional<z.ZodString>; clientInfo: z.ZodOptional<z.ZodRecord<z.ZodString, z.Z...`	MCP Connection Record 的运行时 Schema。
`assertRemoteEgressAllowed`	函数	`assertRemoteEgressAllowed(endpoint: string, policy: MCPServerProfile["egressPolicy"]): Promise<void>`	Assert Remote Egress Allowed 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createGuardedMCPFetch`	函数	`createGuardedMCPFetch(options?: GuardedMCPFetchOptions): MCPFetch`	Applies the remote MCP egress policy to every request and redirect hop. Credentials are resolved immediately before each request so rotations take effect without rebuilding declarative profiles.
`GuardedMCPFetchOptions`	接口	`interface GuardedMCPFetchOptions`	Guarded MCP Fetch Options 接口，共包含 4 个公开字段或方法。
`MCPConnectionManagerOptions`	接口	`interface MCPConnectionManagerOptions`	MCP Connection Manager Options 接口，共包含 12 个公开字段或方法。
`MCPConnectionRecord`	接口	`interface MCPConnectionRecord`	MCP Connection Record 接口，共包含 18 个公开字段或方法。
`MCPConnectionSession`	接口	`interface MCPConnectionSession`	MCP Connection Session 接口，共包含 9 个公开字段或方法。
`MCPConnectionSessionFactory`	接口	`interface MCPConnectionSessionFactory`	MCP Connection Session Factory 接口，共包含 1 个公开字段或方法。
`MCPConnectionStatus`	接口	`interface MCPConnectionStatus`	MCP Connection Status 接口，共包含 2 个公开字段或方法。
`MCPRemoteContentArtifact`	接口	`interface MCPRemoteContentArtifact`	MCP Remote Content Artifact 接口，共包含 3 个公开字段或方法。
`MCPRemoteContentArtifactPort`	接口	`interface MCPRemoteContentArtifactPort`	MCP Remote Content Artifact Port 接口，共包含 1 个公开字段或方法。
`SDKMCPConnectionSessionFactoryOptions`	接口	`interface SDKMCPConnectionSessionFactoryOptions`	SDKMCP Connection Session Factory Options 接口，共包含 5 个公开字段或方法。
`MCPConnectionState`	类型	`type MCPConnectionState = 'disconnected' \| 'starting' \| 'initializing' \| 'ready' \| 'degraded' \| 'reconnecting' \| 'closing' \| 'closed' \| 'failed'`	MCP Connection State 公共类型别名；完整类型表达式见声明。

`MCPConnectionManager`

MCP Connection Manager 类，共公开 16 个构造函数或成员；精确签名见本条目的声明与成员表。

种类: 类
导入: import { MCPConnectionManager } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare class MCPConnectionManager implements MCPGateway {
    constructor(options: MCPConnectionManagerOptions);
    onListChanged(listener: (serverId: string) => Promise<void> | void): () => void;
    register(profile: MCPServerProfile): MCPConnectionRecord;
    connect(serverId: string): Promise<MCPConnectionRecord>;
    get(serverId: string): Promise<MCPConnectionRecord | null>;
    status(serverId: string): Promise<MCPConnectionStatus>;
    health(serverId?: string): Promise<Record<string, ProviderHealth>>;
    reconnect(serverId: string): Promise<MCPConnectionRecord>;
    cancelRequest(requestId: string): Promise<void>;
    disconnect(serverId: string, reason?: string): Promise<void>;
    closeAll(): Promise<void>;
    discover(integration: MCPIntegrationSpec): Promise<MCPCapabilityDescriptor[]>;
    normalize(capability: MCPCapabilityDescriptor): Promise<NormalizedMCPCapability>;
    call(request: MCPToolCallRequest): Promise<unknown>;
    readResource(request: MCPResourceReadRequest): Promise<MCPResourceResult>;
    getPrompt(request: MCPPromptRequest): Promise<MCPPromptResult>;
}

公开成员

成员	种类	签名	说明
`call`	方法	`call(request: MCPToolCallRequest): Promise<unknown>`	公开方法；参数与返回类型以签名列为准。
`cancelRequest`	方法	`cancelRequest(requestId: string): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`closeAll`	方法	`closeAll(): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`connect`	方法	`connect(serverId: string): Promise<MCPConnectionRecord>`	公开方法；参数与返回类型以签名列为准。
`constructor`	构造函数	`(options: MCPConnectionManagerOptions): MCPConnectionManager`	创建该类的实例。
`disconnect`	方法	`disconnect(serverId: string, reason?: string): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`discover`	方法	`discover(integration: MCPIntegrationSpec): Promise<MCPCapabilityDescriptor[]>`	公开方法；参数与返回类型以签名列为准。
`get`	方法	`get(serverId: string): Promise<MCPConnectionRecord \| null>`	公开方法；参数与返回类型以签名列为准。
`getPrompt`	方法	`getPrompt(request: MCPPromptRequest): Promise<MCPPromptResult>`	公开方法；参数与返回类型以签名列为准。
`health`	方法	`health(serverId?: string): Promise<Record<string, ProviderHealth>>`	公开方法；参数与返回类型以签名列为准。
`normalize`	方法	`normalize(capability: MCPCapabilityDescriptor): Promise<NormalizedMCPCapability>`	公开方法；参数与返回类型以签名列为准。
`onListChanged`	方法	`onListChanged(listener: (serverId: string) => Promise<void> \| void): () => void`	公开方法；参数与返回类型以签名列为准。
`readResource`	方法	`readResource(request: MCPResourceReadRequest): Promise<MCPResourceResult>`	公开方法；参数与返回类型以签名列为准。
`reconnect`	方法	`reconnect(serverId: string): Promise<MCPConnectionRecord>`	公开方法；参数与返回类型以签名列为准。
`register`	方法	`register(profile: MCPServerProfile): MCPConnectionRecord`	公开方法；参数与返回类型以签名列为准。
`status`	方法	`status(serverId: string): Promise<MCPConnectionStatus>`	公开方法；参数与返回类型以签名列为准。

`SDKMCPConnectionSessionFactory`

SDKMCP Connection Session Factory 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

种类: 类
导入: import { SDKMCPConnectionSessionFactory } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare class SDKMCPConnectionSessionFactory implements MCPConnectionSessionFactory {
    constructor(options?: SDKMCPConnectionSessionFactoryOptions);
    create(profile: MCPServerProfile): MCPConnectionSession;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(options?: SDKMCPConnectionSessionFactoryOptions): SDKMCPConnectionSessionFactory`	创建该类的实例。
`create`	方法	`create(profile: MCPServerProfile): MCPConnectionSession`	公开方法；参数与返回类型以签名列为准。

`mcpConnectionRecordDefinition`

由 connection-manager 模块导出的 MCP Connection Record Definition 常量。

种类: 常量
导入: import { mcpConnectionRecordDefinition } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare const mcpConnectionRecordDefinition: SpecSchemaDefinition<MCPConnectionRecord>;

`mcpConnectionRecordExample`

MCP Connection Record 的有效示例值。

种类: 常量
导入: import { mcpConnectionRecordExample } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare const mcpConnectionRecordExample: MCPConnectionRecord;

`mcpConnectionRecordJsonSchema`

MCP Connection Record 的 JSON Schema。

种类: 常量
导入: import { mcpConnectionRecordJsonSchema } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare const mcpConnectionRecordJsonSchema: JsonSchema;

`mcpConnectionRecordSchema`

MCP Connection Record 的运行时 Schema。

种类: 常量
导入: import { mcpConnectionRecordSchema } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const mcpConnectionRecordSchema: (typeof import('@codesoul-co/hypha-mcp'))['mcpConnectionRecordSchema'];

该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。

`assertRemoteEgressAllowed`

Assert Remote Egress Allowed 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { assertRemoteEgressAllowed } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare function assertRemoteEgressAllowed(endpoint: string, policy: MCPServerProfile['egressPolicy']): Promise<void>;

调用签名

text

assertRemoteEgressAllowed(endpoint: string, policy: MCPServerProfile["egressPolicy"]): Promise<void>

参数

参数	类型	必需	说明
`endpoint`	`string`	是	必需参数；接受的值由类型列定义。
`policy`	`{ allowedHosts?: string[]; denyPrivateNetworks?: boolean; requireTls?: boolean; maxRedirects?: number; allowCrossOriginRedirects?: boolean; }`	是	必需参数；接受的值由类型列定义。

返回值

类型: Promise<void>
说明: 返回值契约由上述类型定义。

`createGuardedMCPFetch`

Applies the remote MCP egress policy to every request and redirect hop. Credentials are resolved immediately before each request so rotations take effect without rebuilding declarative profiles.

种类: 函数
导入: import { createGuardedMCPFetch } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export declare function createGuardedMCPFetch(options?: GuardedMCPFetchOptions): MCPFetch;

调用签名

text

createGuardedMCPFetch(options?: GuardedMCPFetchOptions): MCPFetch

Applies the remote MCP egress policy to every request and redirect hop. Credentials are resolved immediately before each request so rotations take effect without rebuilding declarative profiles.

参数

参数	类型	必需	说明
`options`	`GuardedMCPFetchOptions`	否	可选参数；接受的值由类型列定义。

返回值

类型: MCPFetch
说明: 返回值契约由上述类型定义。

`GuardedMCPFetchOptions`

Guarded MCP Fetch Options 接口，共包含 4 个公开字段或方法。

种类: 接口
导入: import type { GuardedMCPFetchOptions } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface GuardedMCPFetchOptions {
    policy?: MCPServerProfile['egressPolicy'];
    fetch?: MCPFetch;
    resolveHeaders?: () => Promise<Record<string, string>> | Record<string, string>;
    resolveAuthorization?: () => Promise<string | undefined> | string | undefined;
}

契约成员

成员	种类	签名	说明
`fetch`	方法	`fetch?(input: string \| URL \| Request, init?: RequestInit): Promise<Response>`	公开方法；参数与返回类型以签名列为准。
`policy`	属性	`policy?: { allowedHosts?: string[]; denyPrivateNetworks?: boolean; requireTls?: boolean; maxRedirects?: number; allowCrossOriginRedirects?: boolean; }`	公开属性；类型、只读和可选状态以签名列为准。
`resolveAuthorization`	方法	`resolveAuthorization?(): Promise<string \| undefined> \| string \| undefined`	公开方法；参数与返回类型以签名列为准。
`resolveHeaders`	方法	`resolveHeaders?(): Promise<Record<string, string>> \| Record<string, string>`	公开方法；参数与返回类型以签名列为准。

`MCPConnectionManagerOptions`

MCP Connection Manager Options 接口，共包含 12 个公开字段或方法。

种类: 接口
导入: import type { MCPConnectionManagerOptions } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPConnectionManagerOptions {
    sessionFactory: MCPConnectionSessionFactory;
    trace?: TraceRecorder;
    traceContext?: {
        runId: string;
        stepId?: string;
        sessionId?: string;
    };
    now?: () => string;
    monotonicNow?: () => number;
    sleep?: (ms: number) => Promise<void>;
    random?: () => number;
    onListChanged?: (serverId: string) => Promise<void> | void;
    telemetry?: TelemetryRecorder;
    contentArtifacts?: MCPRemoteContentArtifactPort;
    reconnectCoordinator?: MCPReconnectCoordinator;
    reconnectOwnerId?: string;
}

契约成员

成员	种类	签名	说明
`contentArtifacts`	属性	`contentArtifacts?: MCPRemoteContentArtifactPort`	公开属性；类型、只读和可选状态以签名列为准。
`monotonicNow`	方法	`monotonicNow?(): number`	公开方法；参数与返回类型以签名列为准。
`now`	方法	`now?(): string`	公开方法；参数与返回类型以签名列为准。
`onListChanged`	方法	`onListChanged?(serverId: string): Promise<void> \| void`	公开方法；参数与返回类型以签名列为准。
`random`	方法	`random?(): number`	公开方法；参数与返回类型以签名列为准。
`reconnectCoordinator`	属性	`reconnectCoordinator?: MCPReconnectCoordinator`	公开属性；类型、只读和可选状态以签名列为准。
`reconnectOwnerId`	属性	`reconnectOwnerId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sessionFactory`	属性	`sessionFactory: MCPConnectionSessionFactory`	公开属性；类型、只读和可选状态以签名列为准。
`sleep`	方法	`sleep?(ms: number): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`telemetry`	属性	`telemetry?: TelemetryRecorder`	公开属性；类型、只读和可选状态以签名列为准。
`trace`	属性	`trace?: TraceRecorder`	公开属性；类型、只读和可选状态以签名列为准。
`traceContext`	属性	`traceContext?: { runId: string; stepId?: string; sessionId?: string; }`	公开属性；类型、只读和可选状态以签名列为准。

`MCPConnectionRecord`

MCP Connection Record 接口，共包含 18 个公开字段或方法。

种类: 接口
导入: import type { MCPConnectionRecord } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPConnectionRecord {
    id: string;
    serverId: string;
    revision: number;
    state: MCPConnectionState;
    transportType: MCPTransportSpec['type'];
    negotiatedProtocolVersion?: string;
    clientInfo?: Record<string, unknown>;
    serverInfo?: Record<string, unknown>;
    serverCapabilities?: Record<string, unknown>;
    startedAt?: string;
    readyAt?: string;
    lastActivityAt?: string;
    lastHealthCheckAt?: string;
    closedAt?: string;
    activeRequestCount: number;
    reconnectAttempts: number;
    error?: NormalizedMCPError;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`activeRequestCount`	属性	`activeRequestCount: number`	公开属性；类型、只读和可选状态以签名列为准。
`clientInfo`	属性	`clientInfo?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`closedAt`	属性	`closedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`error`	属性	`error?: NormalizedMCPError`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`lastActivityAt`	属性	`lastActivityAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`lastHealthCheckAt`	属性	`lastHealthCheckAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`negotiatedProtocolVersion`	属性	`negotiatedProtocolVersion?: string`	公开属性；类型、只读和可选状态以签名列为准。
`readyAt`	属性	`readyAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`reconnectAttempts`	属性	`reconnectAttempts: number`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision: number`	公开属性；类型、只读和可选状态以签名列为准。
`serverCapabilities`	属性	`serverCapabilities?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。
`serverInfo`	属性	`serverInfo?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`startedAt`	属性	`startedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`state`	属性	`state: MCPConnectionState`	公开属性；类型、只读和可选状态以签名列为准。
`transportType`	属性	`transportType: "custom" \| "stdio" \| "streamable_http"`	公开属性；类型、只读和可选状态以签名列为准。

`MCPConnectionSession`

MCP Connection Session 接口，共包含 9 个公开字段或方法。

种类: 接口
导入: import type { MCPConnectionSession } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPConnectionSession {
    connect(signal?: AbortSignal): Promise<{
        negotiatedProtocolVersion?: string;
        serverInfo?: Record<string, unknown>;
        serverCapabilities?: Record<string, unknown>;
    }>;
    listCapabilities(signal?: AbortSignal): Promise<MCPCapabilityDescriptor[]>;
    callTool(capabilityId: string, input: unknown, options?: {
        signal?: AbortSignal;
        timeoutMs?: number;
        onProgress?: (progress: unknown) => void;
    }): Promise<unknown>;
    readResource?(uri: string, options?: {
        signal?: AbortSignal;
        timeoutMs?: number;
    }): Promise<MCPResourceResult>;
    getPrompt?(name: string, args?: Record<string, string>, options?: {
        signal?: AbortSignal;
        timeoutMs?: number;
    }): Promise<MCPPromptResult>;
    ping(signal?: AbortSignal): Promise<void>;
    close(): Promise<void>;
    onClose?: (error?: Error) => void;
    onListChanged?: () => void;
}

契约成员

成员	种类	签名	说明
`callTool`	方法	`callTool(capabilityId: string, input: unknown, options?: { signal?: AbortSignal; timeoutMs?: number; onProgress?: (progress: unknown) => void; }): Promise<unknown>`	公开方法；参数与返回类型以签名列为准。
`close`	方法	`close(): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`connect`	方法	`connect(signal?: AbortSignal): Promise<{ negotiatedProtocolVersion?: string; serverInfo?: Record<string, unknown>; serverCapabilities?: Record<string, unknown>; }>`	公开方法；参数与返回类型以签名列为准。
`getPrompt`	方法	`getPrompt?(name: string, args?: Record<string, string>, options?: { signal?: AbortSignal; timeoutMs?: number; }): Promise<MCPPromptResult>`	公开方法；参数与返回类型以签名列为准。
`listCapabilities`	方法	`listCapabilities(signal?: AbortSignal): Promise<MCPCapabilityDescriptor[]>`	公开方法；参数与返回类型以签名列为准。
`onClose`	方法	`onClose?(error?: Error): void`	公开方法；参数与返回类型以签名列为准。
`onListChanged`	方法	`onListChanged?(): void`	公开方法；参数与返回类型以签名列为准。
`ping`	方法	`ping(signal?: AbortSignal): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`readResource`	方法	`readResource?(uri: string, options?: { signal?: AbortSignal; timeoutMs?: number; }): Promise<MCPResourceResult>`	公开方法；参数与返回类型以签名列为准。

`MCPConnectionSessionFactory`

MCP Connection Session Factory 接口，共包含 1 个公开字段或方法。

种类: 接口
导入: import type { MCPConnectionSessionFactory } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPConnectionSessionFactory {
    create(profile: MCPServerProfile): MCPConnectionSession;
}

契约成员

成员	种类	签名	说明
`create`	方法	`create(profile: MCPServerProfile): MCPConnectionSession`	公开方法；参数与返回类型以签名列为准。

`MCPConnectionStatus`

MCP Connection Status 接口，共包含 2 个公开字段或方法。

种类: 接口
导入: import type { MCPConnectionStatus } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPConnectionStatus {
    record: MCPConnectionRecord | null;
    health: ProviderHealth;
}

契约成员

成员	种类	签名	说明
`health`	属性	`health: ProviderHealth`	公开属性；类型、只读和可选状态以签名列为准。
`record`	属性	`record: MCPConnectionRecord`	公开属性；类型、只读和可选状态以签名列为准。

`MCPRemoteContentArtifact`

MCP Remote Content Artifact 接口，共包含 3 个公开字段或方法。

种类: 接口
导入: import type { MCPRemoteContentArtifact } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPRemoteContentArtifact {
    artifactRef: string;
    contentHash: string;
    sizeBytes: number;
}

契约成员

成员	种类	签名	说明
`artifactRef`	属性	`artifactRef: string`	公开属性；类型、只读和可选状态以签名列为准。
`contentHash`	属性	`contentHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`sizeBytes`	属性	`sizeBytes: number`	公开属性；类型、只读和可选状态以签名列为准。

`MCPRemoteContentArtifactPort`

MCP Remote Content Artifact Port 接口，共包含 1 个公开字段或方法。

种类: 接口
导入: import type { MCPRemoteContentArtifactPort } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface MCPRemoteContentArtifactPort {
    store(input: {
        serverId: string;
        kind: 'resource' | 'prompt';
        capabilityId: string;
        mediaType: string;
        bytes: Uint8Array;
        contentHash: string;
        provenance: Record<string, unknown>;
    }): Promise<MCPRemoteContentArtifact>;
}

契约成员

成员	种类	签名	说明
`store`	方法	`store(input: { serverId: string; kind: "resource" \| "prompt"; capabilityId: string; mediaType: string; bytes: Uint8Array; contentHash: string; provenance: Record<string, unknown>; }): Promise<MCPRemoteContentArtifact>`	公开方法；参数与返回类型以签名列为准。

`SDKMCPConnectionSessionFactoryOptions`

SDKMCP Connection Session Factory Options 接口，共包含 5 个公开字段或方法。

种类: 接口
导入: import type { SDKMCPConnectionSessionFactoryOptions } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export interface SDKMCPConnectionSessionFactoryOptions {
    clientInfo?: {
        name: string;
        version: string;
    };
    resolveHeadersRef?: (ref: string) => Promise<Record<string, string>> | Record<string, string>;
    resolveAuthorizationRef?: (ref: string) => Promise<string> | string;
    resolveWorkingDirectoryRef?: (ref: string) => Promise<string> | string;
    resolveEnvironmentRefs?: (refs: string[]) => Promise<Record<string, string>> | Record<string, string>;
}

契约成员

成员	种类	签名	说明
`clientInfo`	属性	`clientInfo?: { name: string; version: string; }`	公开属性；类型、只读和可选状态以签名列为准。
`resolveAuthorizationRef`	方法	`resolveAuthorizationRef?(ref: string): Promise<string> \| string`	公开方法；参数与返回类型以签名列为准。
`resolveEnvironmentRefs`	方法	`resolveEnvironmentRefs?(refs: string[]): Promise<Record<string, string>> \| Record<string, string>`	公开方法；参数与返回类型以签名列为准。
`resolveHeadersRef`	方法	`resolveHeadersRef?(ref: string): Promise<Record<string, string>> \| Record<string, string>`	公开方法；参数与返回类型以签名列为准。
`resolveWorkingDirectoryRef`	方法	`resolveWorkingDirectoryRef?(ref: string): Promise<string> \| string`	公开方法；参数与返回类型以签名列为准。

`MCPConnectionState`

MCP Connection State 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { MCPConnectionState } from '@codesoul-co/hypha-mcp';
源码模块: connection-manager

声明

text

export type MCPConnectionState = 'disconnected' | 'starting' | 'initializing' | 'ready' | 'degraded' | 'reconnecting' | 'closing' | 'closed' | 'failed';

@codesoul-co/hypha-mcp / connection-manager ​

模块用法 ​

从包入口导入 ​

使用要点 ​

运行时校验示例 ​

公共导出 ​

MCPConnectionManager ​

声明 ​

公开成员 ​

SDKMCPConnectionSessionFactory ​

声明 ​

公开成员 ​

mcpConnectionRecordDefinition ​

声明 ​

mcpConnectionRecordExample ​

声明 ​

mcpConnectionRecordJsonSchema ​

声明 ​

mcpConnectionRecordSchema ​

声明 ​

assertRemoteEgressAllowed ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createGuardedMCPFetch ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

GuardedMCPFetchOptions ​

声明 ​

契约成员 ​

MCPConnectionManagerOptions ​

声明 ​

契约成员 ​

MCPConnectionRecord ​

声明 ​

契约成员 ​

MCPConnectionSession ​

声明 ​

契约成员 ​

MCPConnectionSessionFactory ​

声明 ​

契约成员 ​

MCPConnectionStatus ​

声明 ​

契约成员 ​

MCPRemoteContentArtifact ​

声明 ​

契约成员 ​

MCPRemoteContentArtifactPort ​

声明 ​

契约成员 ​

SDKMCPConnectionSessionFactoryOptions ​

声明 ​

契约成员 ​

MCPConnectionState ​

声明 ​

`@codesoul-co/hypha-mcp` / `connection-manager`

模块用法

从包入口导入

使用要点

运行时校验示例

公共导出

`MCPConnectionManager`

声明

公开成员

`SDKMCPConnectionSessionFactory`

声明

公开成员

`mcpConnectionRecordDefinition`

声明

`mcpConnectionRecordExample`

声明

`mcpConnectionRecordJsonSchema`

声明

`mcpConnectionRecordSchema`

声明

`assertRemoteEgressAllowed`

声明

调用签名

参数

返回值

`createGuardedMCPFetch`

声明

调用签名

参数

返回值

`GuardedMCPFetchOptions`

声明

契约成员

`MCPConnectionManagerOptions`

声明

契约成员

`MCPConnectionRecord`

声明

契约成员

`MCPConnectionSession`

声明

契约成员

`MCPConnectionSessionFactory`

声明

契约成员

`MCPConnectionStatus`

声明

契约成员

`MCPRemoteContentArtifact`

声明

契约成员

`MCPRemoteContentArtifactPort`

声明

契约成员

`SDKMCPConnectionSessionFactoryOptions`

声明

契约成员

`MCPConnectionState`

声明