`@codesoul-co/hypha-mcp` / `catalog`

模块用法

用于注册并解析版本化能力或实现。Catalog 模块公开 6 类、4 常量、1 函数、11 接口、2 类型。

从包入口导入

import {
  InMemoryMCPCapabilityCatalogStore,
  InMemoryToolContractSnapshotStore,
  MCPCapabilityCatalog,
  MCPSchemaCache,
  RedisMCPCapabilityCatalogStore,
  RedisToolContractSnapshotStore,
  mcpCapabilityRecordDefinition,
  mcpCapabilityRecordExample,
} from '@codesoul-co/hypha-mcp';

import type {
  MCPCapabilityApprovalRequest,
  MCPCapabilityCatalogOptions,
  MCPCapabilityCatalogStore,
  MCPCapabilityListRequest,
  MCPCapabilityQuarantineRequest,
  MCPCapabilityRecord,
  MCPCapabilityRef,
  MCPCatalogSnapshot,
} from '@codesoul-co/hypha-mcp';

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

使用要点

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

公共导出

Symbol	种类	签名	说明
`InMemoryMCPCapabilityCatalogStore`	类	`new InMemoryMCPCapabilityCatalogStore(): InMemoryMCPCapabilityCatalogStore`	In Memory MCP Capability Catalog Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
`InMemoryToolContractSnapshotStore`	类	`new InMemoryToolContractSnapshotStore(): InMemoryToolContractSnapshotStore`	In Memory Tool Contract Snapshot Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
`MCPCapabilityCatalog`	类	`new MCPCapabilityCatalog(options: MCPCapabilityCatalogOptions): MCPCapabilityCatalog`	MCP Capability Catalog 类，共公开 10 个构造函数或成员；精确签名见本条目的声明与成员表。
`MCPSchemaCache`	类	`new MCPSchemaCache(options?: MCPSchemaCacheOptions): MCPSchemaCache`	MCP Schema Cache 类，共公开 5 个构造函数或成员；精确签名见本条目的声明与成员表。
`RedisMCPCapabilityCatalogStore`	类	`new RedisMCPCapabilityCatalogStore(client: RedisLikeMCPStoreClient, namespace?: string): RedisMCPCapabilityCatalogStore`	Multi-worker catalog store. Redis key operations are idempotent per capability id.
`RedisToolContractSnapshotStore`	类	`new RedisToolContractSnapshotStore(client: Pick<RedisLikeMCPStoreClient, "get" \| "set">, namespace?: string): RedisToolContractSnapshotStore`	Redis Tool Contract Snapshot Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
`mcpCapabilityRecordDefinition`	常量	`const mcpCapabilityRecordDefinition: SpecSchemaDefinition<MCPCapabilityRecord>`	由 `catalog` 模块导出的 MCP Capability Record Definition 常量。
`mcpCapabilityRecordExample`	常量	`const mcpCapabilityRecordExample: MCPCapabilityRecord`	MCP Capability Record 的有效示例值。
`mcpCapabilityRecordJsonSchema`	常量	`const mcpCapabilityRecordJsonSchema: JsonSchema`	MCP Capability Record 的 JSON Schema。
`mcpCapabilityRecordSchema`	常量	`const mcpCapabilityRecordSchema: ZodType<MCPCapabilityRecord, ZodTypeDef, MCPCapabilityRecord>`	MCP Capability Record 的运行时 Schema。
`normalizeMCPToolOutput`	函数	`normalizeMCPToolOutput(result: unknown): unknown`	MCP CallToolResult is a transport envelope. A declared Tool output schema applies to structuredContent, not to the protocol's content/isError fields.
`MCPCapabilityApprovalRequest`	接口	`interface MCPCapabilityApprovalRequest extends MCPCapabilityRef`	MCP Capability Approval Request 接口，共包含 8 个公开字段或方法。
`MCPCapabilityCatalogOptions`	接口	`interface MCPCapabilityCatalogOptions`	MCP Capability Catalog Options 接口，共包含 10 个公开字段或方法。
`MCPCapabilityCatalogStore`	接口	`interface MCPCapabilityCatalogStore`	MCP Capability Catalog Store 接口，共包含 2 个公开字段或方法。
`MCPCapabilityListRequest`	接口	`interface MCPCapabilityListRequest`	MCP Capability List Request 接口，共包含 9 个公开字段或方法。
`MCPCapabilityQuarantineRequest`	接口	`interface MCPCapabilityQuarantineRequest extends MCPCapabilityRef`	MCP Capability Quarantine Request 接口，共包含 5 个公开字段或方法。
`MCPCapabilityRecord`	接口	`interface MCPCapabilityRecord`	MCP Capability Record 接口，共包含 21 个公开字段或方法。
`MCPCapabilityRef`	接口	`interface MCPCapabilityRef`	MCP Capability Ref 接口，共包含 4 个公开字段或方法。
`MCPCatalogSnapshot`	接口	`interface MCPCatalogSnapshot`	MCP Catalog Snapshot 接口，共包含 7 个公开字段或方法。
`MCPSchemaCacheEntry`	接口	`interface MCPSchemaCacheEntry`	MCP Schema Cache Entry 接口，共包含 7 个公开字段或方法。
`MCPSchemaCacheOptions`	接口	`interface MCPSchemaCacheOptions`	MCP Schema Cache Options 接口，共包含 2 个公开字段或方法。
`RedisLikeMCPStoreClient`	接口	`interface RedisLikeMCPStoreClient`	Redis Like MCP Store Client 接口，共包含 5 个公开字段或方法。
`MCPCapabilityDriftType`	类型	`type MCPCapabilityDriftType = 'description_changed' \| 'input_schema_changed' \| 'output_schema_changed' \| 'annotations_changed' \| 'capability_added' \| 'capability_removed' \| 'server_identity_changed' \| 'protocol_version_changed'`	MCP Capability Drift Type 公共类型别名；完整类型表达式见声明。
`MCPCapabilityKind`	类型	`type MCPCapabilityKind = 'tool' \| 'resource' \| 'prompt'`	MCP Capability Kind 公共类型别名；完整类型表达式见声明。

`InMemoryMCPCapabilityCatalogStore`

In Memory MCP Capability Catalog Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

text

export declare class InMemoryMCPCapabilityCatalogStore implements MCPCapabilityCatalogStore {
    list(serverId?: string): Promise<MCPCapabilityRecord[]>;
    save(record: MCPCapabilityRecord, options?: {
            expected?: MCPCapabilityRecord | null;
        }): Promise<boolean>;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(): InMemoryMCPCapabilityCatalogStore`	创建该类的实例。
`list`	方法	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	公开方法；参数与返回类型以签名列为准。
`save`	方法	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	公开方法；参数与返回类型以签名列为准。

`InMemoryToolContractSnapshotStore`

In Memory Tool Contract Snapshot Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

text

export declare class InMemoryToolContractSnapshotStore implements ToolContractSnapshotStore {
    get(snapshotId: string): Promise<ToolContractSnapshot | null>;
    save(snapshot: ToolContractSnapshot): Promise<void>;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(): InMemoryToolContractSnapshotStore`	创建该类的实例。
`get`	方法	`get(snapshotId: string): Promise<ToolContractSnapshot \| null>`	公开方法；参数与返回类型以签名列为准。
`save`	方法	`save(snapshot: ToolContractSnapshot): Promise<void>`	公开方法；参数与返回类型以签名列为准。

`MCPCapabilityCatalog`

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

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

声明

text

export declare class MCPCapabilityCatalog {
    readonly snapshotStore: ToolContractSnapshotStore;
    constructor(options: MCPCapabilityCatalogOptions);
    bindConnectionManager(manager: MCPConnectionManager): () => void;
    refresh(serverId: string, reason?: string): Promise<MCPCatalogSnapshot>;
    getCapability(ref: MCPCapabilityRef): Promise<MCPCapabilityRecord | null>;
    list(request?: MCPCapabilityListRequest): Promise<MCPCapabilityRecord[]>;
    quarantine(request: MCPCapabilityQuarantineRequest): Promise<void>;
    approveRevision(request: MCPCapabilityApprovalRequest): Promise<void>;
    importTools(registry: ToolRegistry, refs: MCPCapabilityRef[], context?: Partial<ToolCallContext>): Promise<ToolSpec[]>;
    snapshot(runId: string, refs: MCPCapabilityRef[]): Promise<ToolContractSnapshot>;
}

公开成员

成员	种类	签名	说明
`approveRevision`	方法	`approveRevision(request: MCPCapabilityApprovalRequest): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`bindConnectionManager`	方法	`bindConnectionManager(manager: MCPConnectionManager): () => void`	公开方法；参数与返回类型以签名列为准。
`constructor`	构造函数	`(options: MCPCapabilityCatalogOptions): MCPCapabilityCatalog`	创建该类的实例。
`getCapability`	方法	`getCapability(ref: MCPCapabilityRef): Promise<MCPCapabilityRecord \| null>`	公开方法；参数与返回类型以签名列为准。
`importTools`	方法	`importTools(registry: ToolRegistry, refs: MCPCapabilityRef[], context?: Partial<ToolCallContext>): Promise<ToolSpec[]>`	公开方法；参数与返回类型以签名列为准。
`list`	方法	`list(request?: MCPCapabilityListRequest): Promise<MCPCapabilityRecord[]>`	公开方法；参数与返回类型以签名列为准。
`quarantine`	方法	`quarantine(request: MCPCapabilityQuarantineRequest): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`refresh`	方法	`refresh(serverId: string, reason?: string): Promise<MCPCatalogSnapshot>`	公开方法；参数与返回类型以签名列为准。
`snapshot`	方法	`snapshot(runId: string, refs: MCPCapabilityRef[]): Promise<ToolContractSnapshot>`	公开方法；参数与返回类型以签名列为准。
`snapshotStore`	属性	`readonly snapshotStore: ToolContractSnapshotStore`	公开属性；类型、只读和可选状态以签名列为准。

`MCPSchemaCache`

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

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

声明

text

export declare class MCPSchemaCache {
    constructor(options?: MCPSchemaCacheOptions);
    get(ref: MCPCapabilityRef & {
            protocolVersion?: string;
        }): MCPSchemaCacheEntry | null;
    set(record: MCPCapabilityRecord): MCPSchemaCacheEntry;
    invalidate(serverId: string, capabilityId?: string): number;
    size(): number;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(options?: MCPSchemaCacheOptions): MCPSchemaCache`	创建该类的实例。
`get`	方法	`get(ref: MCPCapabilityRef & { protocolVersion?: string; }): MCPSchemaCacheEntry \| null`	公开方法；参数与返回类型以签名列为准。
`invalidate`	方法	`invalidate(serverId: string, capabilityId?: string): number`	公开方法；参数与返回类型以签名列为准。
`set`	方法	`set(record: MCPCapabilityRecord): MCPSchemaCacheEntry`	公开方法；参数与返回类型以签名列为准。
`size`	方法	`size(): number`	公开方法；参数与返回类型以签名列为准。

`RedisMCPCapabilityCatalogStore`

Multi-worker catalog store. Redis key operations are idempotent per capability id.

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

声明

text

export declare class RedisMCPCapabilityCatalogStore implements MCPCapabilityCatalogStore {
    constructor(client: RedisLikeMCPStoreClient, namespace?: string);
    list(serverId?: string): Promise<MCPCapabilityRecord[]>;
    save(record: MCPCapabilityRecord, options?: {
            expected?: MCPCapabilityRecord | null;
        }): Promise<boolean>;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(client: RedisLikeMCPStoreClient, namespace?: string): RedisMCPCapabilityCatalogStore`	创建该类的实例。
`list`	方法	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	公开方法；参数与返回类型以签名列为准。
`save`	方法	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	公开方法；参数与返回类型以签名列为准。

`RedisToolContractSnapshotStore`

Redis Tool Contract Snapshot Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

text

export declare class RedisToolContractSnapshotStore implements ToolContractSnapshotStore {
    constructor(client: Pick<RedisLikeMCPStoreClient, 'get' | 'set'>, namespace?: string);
    get(snapshotId: string): Promise<ToolContractSnapshot | null>;
    save(snapshot: ToolContractSnapshot): Promise<void>;
}

公开成员

成员	种类	签名	说明
`constructor`	构造函数	`(client: Pick<RedisLikeMCPStoreClient, "get" \| "set">, namespace?: string): RedisToolContractSnapshotStore`	创建该类的实例。
`get`	方法	`get(snapshotId: string): Promise<ToolContractSnapshot \| null>`	公开方法；参数与返回类型以签名列为准。
`save`	方法	`save(snapshot: ToolContractSnapshot): Promise<void>`	公开方法；参数与返回类型以签名列为准。

`mcpCapabilityRecordDefinition`

由 catalog 模块导出的 MCP Capability Record Definition 常量。

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

声明

text

export declare const mcpCapabilityRecordDefinition: SpecSchemaDefinition<MCPCapabilityRecord>;

`mcpCapabilityRecordExample`

MCP Capability Record 的有效示例值。

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

声明

text

export declare const mcpCapabilityRecordExample: MCPCapabilityRecord;

`mcpCapabilityRecordJsonSchema`

MCP Capability Record 的 JSON Schema。

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

声明

text

export declare const mcpCapabilityRecordJsonSchema: JsonSchema;

`mcpCapabilityRecordSchema`

MCP Capability Record 的运行时 Schema。

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

声明

text

export declare const mcpCapabilityRecordSchema: ZodType<MCPCapabilityRecord, ZodTypeDef, MCPCapabilityRecord>;

`normalizeMCPToolOutput`

MCP CallToolResult is a transport envelope. A declared Tool output schema applies to structuredContent, not to the protocol's content/isError fields.

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

声明

text

export declare function normalizeMCPToolOutput(result: unknown): unknown;

调用签名

text

normalizeMCPToolOutput(result: unknown): unknown

MCP CallToolResult is a transport envelope. A declared Tool output schema applies to structuredContent, not to the protocol's content/isError fields.

参数

参数	类型	必需	说明
`result`	`unknown`	是	必需参数；接受的值由类型列定义。

返回值

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

`MCPCapabilityApprovalRequest`

MCP Capability Approval Request 接口，共包含 8 个公开字段或方法。

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

声明

text

export interface MCPCapabilityApprovalRequest extends MCPCapabilityRef {
    approvedBy: string;
    expiresAt?: string;
    restrictions?: string[];
    sideEffectLevel?: SideEffectLevel;
}

契约成员

成员	种类	签名	说明
`approvedBy`	属性	`approvedBy: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityHash`	属性	`capabilityHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityId`	属性	`capabilityId: string`	公开属性；类型、只读和可选状态以签名列为准。
`expiresAt`	属性	`expiresAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind?: MCPCapabilityKind`	公开属性；类型、只读和可选状态以签名列为准。
`restrictions`	属性	`restrictions?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。
`sideEffectLevel`	属性	`sideEffectLevel?: SideEffectLevel`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCapabilityCatalogOptions`

MCP Capability Catalog Options 接口，共包含 10 个公开字段或方法。

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

声明

text

export interface MCPCapabilityCatalogOptions {
    integration: MCPIntegrationSpec;
    gateway: MCPGateway;
    trustPolicy: MCPTrustPolicySpec;
    driftPolicy: MCPCapabilityDriftPolicySpec;
    store?: MCPCapabilityCatalogStore;
    schemaCache?: MCPSchemaCache;
    snapshotStore?: ToolContractSnapshotStore;
    now?: () => string;
    onEvent?: (type: string, payload: Record<string, unknown>) => Promise<void> | void;
    telemetry?: TelemetryRecorder;
}

契约成员

成员	种类	签名	说明
`driftPolicy`	属性	`driftPolicy: MCPCapabilityDriftPolicySpec`	公开属性；类型、只读和可选状态以签名列为准。
`gateway`	属性	`gateway: MCPGateway`	公开属性；类型、只读和可选状态以签名列为准。
`integration`	属性	`integration: MCPIntegrationSpec`	公开属性；类型、只读和可选状态以签名列为准。
`now`	方法	`now?(): string`	公开方法；参数与返回类型以签名列为准。
`onEvent`	方法	`onEvent?(type: string, payload: Record<string, unknown>): Promise<void> \| void`	公开方法；参数与返回类型以签名列为准。
`schemaCache`	属性	`schemaCache?: MCPSchemaCache`	公开属性；类型、只读和可选状态以签名列为准。
`snapshotStore`	属性	`snapshotStore?: ToolContractSnapshotStore`	公开属性；类型、只读和可选状态以签名列为准。
`store`	属性	`store?: MCPCapabilityCatalogStore`	公开属性；类型、只读和可选状态以签名列为准。
`telemetry`	属性	`telemetry?: TelemetryRecorder`	公开属性；类型、只读和可选状态以签名列为准。
`trustPolicy`	属性	`trustPolicy: MCPTrustPolicySpec`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCapabilityCatalogStore`

MCP Capability Catalog Store 接口，共包含 2 个公开字段或方法。

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

声明

text

export interface MCPCapabilityCatalogStore {
    list(serverId?: string): Promise<MCPCapabilityRecord[]>;
    save(record: MCPCapabilityRecord, options?: {
        expected?: MCPCapabilityRecord | null;
    }): Promise<boolean>;
}

契约成员

成员	种类	签名	说明
`list`	方法	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	公开方法；参数与返回类型以签名列为准。
`save`	方法	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	公开方法；参数与返回类型以签名列为准。

`MCPCapabilityListRequest`

MCP Capability List Request 接口，共包含 9 个公开字段或方法。

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

声明

text

export interface MCPCapabilityListRequest {
    serverId?: string;
    kind?: MCPCapabilityKind;
    states?: MCPCapabilityRecord['driftState'][];
    permissionScopes?: string[];
    tags?: string[];
    query?: string;
    loadDescriptors?: boolean;
    schemaTokenBudget?: number;
    limit?: number;
}

契约成员

成员	种类	签名	说明
`kind`	属性	`kind?: MCPCapabilityKind`	公开属性；类型、只读和可选状态以签名列为准。
`limit`	属性	`limit?: number`	公开属性；类型、只读和可选状态以签名列为准。
`loadDescriptors`	属性	`loadDescriptors?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`permissionScopes`	属性	`permissionScopes?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`query`	属性	`query?: string`	公开属性；类型、只读和可选状态以签名列为准。
`schemaTokenBudget`	属性	`schemaTokenBudget?: number`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`states`	属性	`states?: ("quarantined" \| "approved" \| "changed" \| "removed" \| "stable" \| "new")[]`	公开属性；类型、只读和可选状态以签名列为准。
`tags`	属性	`tags?: string[]`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCapabilityQuarantineRequest`

MCP Capability Quarantine Request 接口，共包含 5 个公开字段或方法。

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

声明

text

export interface MCPCapabilityQuarantineRequest extends MCPCapabilityRef {
    reason: string;
}

契约成员

成员	种类	签名	说明
`capabilityHash`	属性	`capabilityHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityId`	属性	`capabilityId: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind?: MCPCapabilityKind`	公开属性；类型、只读和可选状态以签名列为准。
`reason`	属性	`reason: string`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCapabilityRecord`

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

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

声明

text

export interface MCPCapabilityRecord {
    id: string;
    serverId: string;
    kind: MCPCapabilityKind;
    remoteName: string;
    stableToolId?: string;
    protocolVersion?: string;
    capabilityVersion?: string;
    capabilityHash: string;
    schemaHash?: string;
    descriptorHash: string;
    descriptor: Record<string, unknown>;
    normalizedToolSpec?: ToolSpec;
    trust: MCPCapabilityTrustRecord;
    driftState: 'stable' | 'new' | 'changed' | 'removed' | 'quarantined' | 'approved';
    driftTypes?: MCPCapabilityDriftType[];
    firstSeenAt: string;
    lastSeenAt: string;
    approvedAt?: string;
    approvalExpiresAt?: string;
    removedAt?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`approvalExpiresAt`	属性	`approvalExpiresAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`approvedAt`	属性	`approvedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityHash`	属性	`capabilityHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityVersion`	属性	`capabilityVersion?: string`	公开属性；类型、只读和可选状态以签名列为准。
`descriptor`	属性	`descriptor: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`descriptorHash`	属性	`descriptorHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`driftState`	属性	`driftState: "quarantined" \| "approved" \| "changed" \| "removed" \| "stable" \| "new"`	公开属性；类型、只读和可选状态以签名列为准。
`driftTypes`	属性	`driftTypes?: MCPCapabilityDriftType[]`	公开属性；类型、只读和可选状态以签名列为准。
`firstSeenAt`	属性	`firstSeenAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind: MCPCapabilityKind`	公开属性；类型、只读和可选状态以签名列为准。
`lastSeenAt`	属性	`lastSeenAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`normalizedToolSpec`	属性	`normalizedToolSpec?: ToolSpec`	公开属性；类型、只读和可选状态以签名列为准。
`protocolVersion`	属性	`protocolVersion?: string`	公开属性；类型、只读和可选状态以签名列为准。
`remoteName`	属性	`remoteName: string`	公开属性；类型、只读和可选状态以签名列为准。
`removedAt`	属性	`removedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`schemaHash`	属性	`schemaHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。
`stableToolId`	属性	`stableToolId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`trust`	属性	`trust: MCPCapabilityTrustRecord`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCapabilityRef`

MCP Capability Ref 接口，共包含 4 个公开字段或方法。

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

声明

text

export interface MCPCapabilityRef {
    serverId: string;
    capabilityId: string;
    kind?: MCPCapabilityKind;
    capabilityHash?: string;
}

契约成员

成员	种类	签名	说明
`capabilityHash`	属性	`capabilityHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityId`	属性	`capabilityId: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind?: MCPCapabilityKind`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。

`MCPCatalogSnapshot`

MCP Catalog Snapshot 接口，共包含 7 个公开字段或方法。

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

声明

text

export interface MCPCatalogSnapshot {
    id: string;
    serverId: string;
    revision: string;
    createdAt: string;
    reason?: string;
    capabilities: MCPCapabilityRecord[];
    drift: Array<{
        capabilityId: string;
        previousHash?: string;
        currentHash?: string;
        types: MCPCapabilityDriftType[];
    }>;
}

契约成员

成员	种类	签名	说明
`capabilities`	属性	`capabilities: MCPCapabilityRecord[]`	公开属性；类型、只读和可选状态以签名列为准。
`createdAt`	属性	`createdAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`drift`	属性	`drift: { capabilityId: string; previousHash?: string; currentHash?: string; types: MCPCapabilityDriftType[]; }[]`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`reason`	属性	`reason?: string`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision: string`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。

`MCPSchemaCacheEntry`

MCP Schema Cache Entry 接口，共包含 7 个公开字段或方法。

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

声明

text

export interface MCPSchemaCacheEntry {
    key: string;
    serverId: string;
    capabilityId: string;
    capabilityHash: string;
    protocolVersion?: string;
    schema?: JsonSchema;
    cachedAt: string;
}

契约成员

成员	种类	签名	说明
`cachedAt`	属性	`cachedAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityHash`	属性	`capabilityHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`capabilityId`	属性	`capabilityId: string`	公开属性；类型、只读和可选状态以签名列为准。
`key`	属性	`key: string`	公开属性；类型、只读和可选状态以签名列为准。
`protocolVersion`	属性	`protocolVersion?: string`	公开属性；类型、只读和可选状态以签名列为准。
`schema`	属性	`schema?: JsonSchema`	公开属性；类型、只读和可选状态以签名列为准。
`serverId`	属性	`serverId: string`	公开属性；类型、只读和可选状态以签名列为准。

`MCPSchemaCacheOptions`

MCP Schema Cache Options 接口，共包含 2 个公开字段或方法。

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

声明

text

export interface MCPSchemaCacheOptions {
    maxEntries?: number;
    now?: () => string;
}

契约成员

成员	种类	签名	说明
`maxEntries`	属性	`maxEntries?: number`	公开属性；类型、只读和可选状态以签名列为准。
`now`	方法	`now?(): string`	公开方法；参数与返回类型以签名列为准。

`RedisLikeMCPStoreClient`

Redis Like MCP Store Client 接口，共包含 5 个公开字段或方法。

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

声明

text

export interface RedisLikeMCPStoreClient {
    get(key: string): Promise<string | null>;
    set(key: string, value: string): Promise<unknown>;
    sadd(key: string, ...members: string[]): Promise<number>;
    smembers(key: string): Promise<string[]>;
    eval?(script: string, numberOfKeys: number, ...args: Array<string | number>): Promise<number | string | null>;
}

契约成员

成员	种类	签名	说明
`eval`	方法	`eval?(script: string, numberOfKeys: number, ...args: Array<string \| number>): Promise<number \| string \| null>`	公开方法；参数与返回类型以签名列为准。
`get`	方法	`get(key: string): Promise<string \| null>`	公开方法；参数与返回类型以签名列为准。
`sadd`	方法	`sadd(key: string, ...members: string[]): Promise<number>`	公开方法；参数与返回类型以签名列为准。
`set`	方法	`set(key: string, value: string): Promise<unknown>`	公开方法；参数与返回类型以签名列为准。
`smembers`	方法	`smembers(key: string): Promise<string[]>`	公开方法；参数与返回类型以签名列为准。

`MCPCapabilityDriftType`

MCP Capability Drift Type 公共类型别名；完整类型表达式见声明。

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

声明

text

export type MCPCapabilityDriftType = 'description_changed' | 'input_schema_changed' | 'output_schema_changed' | 'annotations_changed' | 'capability_added' | 'capability_removed' | 'server_identity_changed' | 'protocol_version_changed';

`MCPCapabilityKind`

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

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

声明

text

export type MCPCapabilityKind = 'tool' | 'resource' | 'prompt';

@codesoul-co/hypha-mcp / catalog ​

模块用法 ​

从包入口导入 ​

使用要点 ​

公共导出 ​

InMemoryMCPCapabilityCatalogStore ​

声明 ​

公开成员 ​

InMemoryToolContractSnapshotStore ​

声明 ​

公开成员 ​

MCPCapabilityCatalog ​

声明 ​

公开成员 ​

MCPSchemaCache ​

声明 ​

公开成员 ​

RedisMCPCapabilityCatalogStore ​

声明 ​

公开成员 ​

RedisToolContractSnapshotStore ​

声明 ​

公开成员 ​

mcpCapabilityRecordDefinition ​

声明 ​

mcpCapabilityRecordExample ​

声明 ​

mcpCapabilityRecordJsonSchema ​

声明 ​

mcpCapabilityRecordSchema ​

声明 ​

normalizeMCPToolOutput ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

MCPCapabilityApprovalRequest ​

声明 ​

契约成员 ​

MCPCapabilityCatalogOptions ​

声明 ​

契约成员 ​

MCPCapabilityCatalogStore ​

声明 ​

契约成员 ​

MCPCapabilityListRequest ​

声明 ​

契约成员 ​

MCPCapabilityQuarantineRequest ​

声明 ​

契约成员 ​

MCPCapabilityRecord ​

声明 ​

契约成员 ​

MCPCapabilityRef ​

声明 ​

契约成员 ​

MCPCatalogSnapshot ​

声明 ​

契约成员 ​

MCPSchemaCacheEntry ​

声明 ​

契约成员 ​

MCPSchemaCacheOptions ​

声明 ​

契约成员 ​

RedisLikeMCPStoreClient ​

声明 ​

契约成员 ​

MCPCapabilityDriftType ​

声明 ​

MCPCapabilityKind ​

声明 ​

`@codesoul-co/hypha-mcp` / `catalog`

模块用法

从包入口导入

使用要点

公共导出

`InMemoryMCPCapabilityCatalogStore`

声明

公开成员

`InMemoryToolContractSnapshotStore`

声明

公开成员

`MCPCapabilityCatalog`

声明

公开成员

`MCPSchemaCache`

声明

公开成员

`RedisMCPCapabilityCatalogStore`

声明

公开成员

`RedisToolContractSnapshotStore`

声明

公开成员

`mcpCapabilityRecordDefinition`

声明

`mcpCapabilityRecordExample`

声明

`mcpCapabilityRecordJsonSchema`

声明

`mcpCapabilityRecordSchema`

声明

`normalizeMCPToolOutput`

声明

调用签名

参数

返回值

`MCPCapabilityApprovalRequest`

声明

契约成员

`MCPCapabilityCatalogOptions`

声明

契约成员

`MCPCapabilityCatalogStore`

声明

契约成员

`MCPCapabilityListRequest`

声明

契约成员

`MCPCapabilityQuarantineRequest`

声明

契约成员

`MCPCapabilityRecord`

声明

契约成员

`MCPCapabilityRef`

声明

契约成员

`MCPCatalogSnapshot`

声明

契约成员

`MCPSchemaCacheEntry`

声明

契约成员

`MCPSchemaCacheOptions`

声明

契约成员

`RedisLikeMCPStoreClient`

声明

契约成员

`MCPCapabilityDriftType`

声明

`MCPCapabilityKind`

声明