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

Package index: @codesoul-co/hypha-mcp
Source: packages/mcp/src/catalog.ts
Exports: 24

Using this module

Use the Catalog module for registering and resolving versioned capabilities or implementations. It exports 6 classes, 4 constants, 1 function, 11 interfaces, 2 types.

Import from the package entrypoint

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';

// The complete export list is documented below.

Usage patterns

Use the 13 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
The module exposes 6 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
The module exposes 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
The 4 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
`InMemoryMCPCapabilityCatalogStore`	class	`new InMemoryMCPCapabilityCatalogStore(): InMemoryMCPCapabilityCatalogStore`	In Memory MCP Capability Catalog Store class with 3 public constructor or member entries; its exact declarations are listed below.
`InMemoryToolContractSnapshotStore`	class	`new InMemoryToolContractSnapshotStore(): InMemoryToolContractSnapshotStore`	In Memory Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.
`MCPCapabilityCatalog`	class	`new MCPCapabilityCatalog(options: MCPCapabilityCatalogOptions): MCPCapabilityCatalog`	MCP Capability Catalog class with 10 public constructor or member entries; its exact declarations are listed below.
`MCPSchemaCache`	class	`new MCPSchemaCache(options?: MCPSchemaCacheOptions): MCPSchemaCache`	MCP Schema Cache class with 5 public constructor or member entries; its exact declarations are listed below.
`RedisMCPCapabilityCatalogStore`	class	`new RedisMCPCapabilityCatalogStore(client: RedisLikeMCPStoreClient, namespace?: string): RedisMCPCapabilityCatalogStore`	Multi-worker catalog store. Redis key operations are idempotent per capability id.
`RedisToolContractSnapshotStore`	class	`new RedisToolContractSnapshotStore(client: Pick<RedisLikeMCPStoreClient, "get" \| "set">, namespace?: string): RedisToolContractSnapshotStore`	Redis Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.
`mcpCapabilityRecordDefinition`	constant	`const mcpCapabilityRecordDefinition: SpecSchemaDefinition<MCPCapabilityRecord>`	MCP Capability Record Definition constant exported by the `catalog` module.
`mcpCapabilityRecordExample`	constant	`const mcpCapabilityRecordExample: MCPCapabilityRecord`	Valid example value for MCP Capability Record.
`mcpCapabilityRecordJsonSchema`	constant	`const mcpCapabilityRecordJsonSchema: JsonSchema`	JSON Schema for MCP Capability Record.
`mcpCapabilityRecordSchema`	constant	`const mcpCapabilityRecordSchema: ZodType<MCPCapabilityRecord, ZodTypeDef, MCPCapabilityRecord>`	Runtime schema for MCP Capability Record.
`normalizeMCPToolOutput`	function	`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	`interface MCPCapabilityApprovalRequest extends MCPCapabilityRef`	MCP Capability Approval Request interface with 8 public fields or methods.
`MCPCapabilityCatalogOptions`	interface	`interface MCPCapabilityCatalogOptions`	MCP Capability Catalog Options interface with 10 public fields or methods.
`MCPCapabilityCatalogStore`	interface	`interface MCPCapabilityCatalogStore`	MCP Capability Catalog Store interface with 2 public fields or methods.
`MCPCapabilityListRequest`	interface	`interface MCPCapabilityListRequest`	MCP Capability List Request interface with 9 public fields or methods.
`MCPCapabilityQuarantineRequest`	interface	`interface MCPCapabilityQuarantineRequest extends MCPCapabilityRef`	MCP Capability Quarantine Request interface with 5 public fields or methods.
`MCPCapabilityRecord`	interface	`interface MCPCapabilityRecord`	MCP Capability Record interface with 21 public fields or methods.
`MCPCapabilityRef`	interface	`interface MCPCapabilityRef`	MCP Capability Ref interface with 4 public fields or methods.
`MCPCatalogSnapshot`	interface	`interface MCPCatalogSnapshot`	MCP Catalog Snapshot interface with 7 public fields or methods.
`MCPSchemaCacheEntry`	interface	`interface MCPSchemaCacheEntry`	MCP Schema Cache Entry interface with 7 public fields or methods.
`MCPSchemaCacheOptions`	interface	`interface MCPSchemaCacheOptions`	MCP Schema Cache Options interface with 2 public fields or methods.
`RedisLikeMCPStoreClient`	interface	`interface RedisLikeMCPStoreClient`	Redis Like MCP Store Client interface with 5 public fields or methods.
`MCPCapabilityDriftType`	type	`type MCPCapabilityDriftType = 'description_changed' \| 'input_schema_changed' \| 'output_schema_changed' \| 'annotations_changed' \| 'capability_added' \| 'capability_removed' \| 'server_identity_changed' \| 'protocol_version_changed'`	Public type alias for MCP Capability Drift Type; the declaration contains its complete type expression.
`MCPCapabilityKind`	type	`type MCPCapabilityKind = 'tool' \| 'resource' \| 'prompt'`	Public type alias for MCP Capability Kind; the declaration contains its complete type expression.

`InMemoryMCPCapabilityCatalogStore`

In Memory MCP Capability Catalog Store class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { InMemoryMCPCapabilityCatalogStore } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): InMemoryMCPCapabilityCatalogStore`	Creates an instance of this class.
`list`	method	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	Public method; parameters and return type are shown in the signature.

`InMemoryToolContractSnapshotStore`

In Memory Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { InMemoryToolContractSnapshotStore } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): InMemoryToolContractSnapshotStore`	Creates an instance of this class.
`get`	method	`get(snapshotId: string): Promise<ToolContractSnapshot \| null>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(snapshot: ToolContractSnapshot): Promise<void>`	Public method; parameters and return type are shown in the signature.

`MCPCapabilityCatalog`

MCP Capability Catalog class with 10 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { MCPCapabilityCatalog } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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>;
}

Public members

Member	Kind	Signature	Description
`approveRevision`	method	`approveRevision(request: MCPCapabilityApprovalRequest): Promise<void>`	Public method; parameters and return type are shown in the signature.
`bindConnectionManager`	method	`bindConnectionManager(manager: MCPConnectionManager): () => void`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(options: MCPCapabilityCatalogOptions): MCPCapabilityCatalog`	Creates an instance of this class.
`getCapability`	method	`getCapability(ref: MCPCapabilityRef): Promise<MCPCapabilityRecord \| null>`	Public method; parameters and return type are shown in the signature.
`importTools`	method	`importTools(registry: ToolRegistry, refs: MCPCapabilityRef[], context?: Partial<ToolCallContext>): Promise<ToolSpec[]>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(request?: MCPCapabilityListRequest): Promise<MCPCapabilityRecord[]>`	Public method; parameters and return type are shown in the signature.
`quarantine`	method	`quarantine(request: MCPCapabilityQuarantineRequest): Promise<void>`	Public method; parameters and return type are shown in the signature.
`refresh`	method	`refresh(serverId: string, reason?: string): Promise<MCPCatalogSnapshot>`	Public method; parameters and return type are shown in the signature.
`snapshot`	method	`snapshot(runId: string, refs: MCPCapabilityRef[]): Promise<ToolContractSnapshot>`	Public method; parameters and return type are shown in the signature.
`snapshotStore`	property	`readonly snapshotStore: ToolContractSnapshotStore`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPSchemaCache`

MCP Schema Cache class with 5 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { MCPSchemaCache } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options?: MCPSchemaCacheOptions): MCPSchemaCache`	Creates an instance of this class.
`get`	method	`get(ref: MCPCapabilityRef & { protocolVersion?: string; }): MCPSchemaCacheEntry \| null`	Public method; parameters and return type are shown in the signature.
`invalidate`	method	`invalidate(serverId: string, capabilityId?: string): number`	Public method; parameters and return type are shown in the signature.
`set`	method	`set(record: MCPCapabilityRecord): MCPSchemaCacheEntry`	Public method; parameters and return type are shown in the signature.
`size`	method	`size(): number`	Public method; parameters and return type are shown in the signature.

`RedisMCPCapabilityCatalogStore`

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

Kind: class
Import: import { RedisMCPCapabilityCatalogStore } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(client: RedisLikeMCPStoreClient, namespace?: string): RedisMCPCapabilityCatalogStore`	Creates an instance of this class.
`list`	method	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	Public method; parameters and return type are shown in the signature.

`RedisToolContractSnapshotStore`

Redis Tool Contract Snapshot Store class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { RedisToolContractSnapshotStore } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(client: Pick<RedisLikeMCPStoreClient, "get" \| "set">, namespace?: string): RedisToolContractSnapshotStore`	Creates an instance of this class.
`get`	method	`get(snapshotId: string): Promise<ToolContractSnapshot \| null>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(snapshot: ToolContractSnapshot): Promise<void>`	Public method; parameters and return type are shown in the signature.

`mcpCapabilityRecordDefinition`

MCP Capability Record Definition constant exported by the catalog module.

Kind: constant
Import: import { mcpCapabilityRecordDefinition } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

export declare const mcpCapabilityRecordDefinition: SpecSchemaDefinition<MCPCapabilityRecord>;

`mcpCapabilityRecordExample`

Valid example value for MCP Capability Record.

Kind: constant
Import: import { mcpCapabilityRecordExample } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

export declare const mcpCapabilityRecordExample: MCPCapabilityRecord;

`mcpCapabilityRecordJsonSchema`

JSON Schema for MCP Capability Record.

Kind: constant
Import: import { mcpCapabilityRecordJsonSchema } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

export declare const mcpCapabilityRecordJsonSchema: JsonSchema;

`mcpCapabilityRecordSchema`

Runtime schema for MCP Capability Record.

Kind: constant
Import: import { mcpCapabilityRecordSchema } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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.

Kind: function
Import: import { normalizeMCPToolOutput } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Call signature

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.

Parameters

Parameter	Type	Required	Description
`result`	`unknown`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: unknown
Description: The return contract is defined by the type shown above.

`MCPCapabilityApprovalRequest`

MCP Capability Approval Request interface with 8 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityApprovalRequest } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`approvedBy`	property	`approvedBy: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityHash`	property	`capabilityHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityId`	property	`capabilityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expiresAt`	property	`expiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind?: MCPCapabilityKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`restrictions`	property	`restrictions?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sideEffectLevel`	property	`sideEffectLevel?: SideEffectLevel`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCapabilityCatalogOptions`

MCP Capability Catalog Options interface with 10 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityCatalogOptions } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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;
}

Contract members

Member	Kind	Signature	Description
`driftPolicy`	property	`driftPolicy: MCPCapabilityDriftPolicySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`gateway`	property	`gateway: MCPGateway`	Public property; its type, readonly modifier and optionality are shown in the signature.
`integration`	property	`integration: MCPIntegrationSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`now`	method	`now?(): string`	Public method; parameters and return type are shown in the signature.
`onEvent`	method	`onEvent?(type: string, payload: Record<string, unknown>): Promise<void> \| void`	Public method; parameters and return type are shown in the signature.
`schemaCache`	property	`schemaCache?: MCPSchemaCache`	Public property; its type, readonly modifier and optionality are shown in the signature.
`snapshotStore`	property	`snapshotStore?: ToolContractSnapshotStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`store`	property	`store?: MCPCapabilityCatalogStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`telemetry`	property	`telemetry?: TelemetryRecorder`	Public property; its type, readonly modifier and optionality are shown in the signature.
`trustPolicy`	property	`trustPolicy: MCPTrustPolicySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCapabilityCatalogStore`

MCP Capability Catalog Store interface with 2 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityCatalogStore } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`list`	method	`list(serverId?: string): Promise<MCPCapabilityRecord[]>`	Public method; parameters and return type are shown in the signature.
`save`	method	`save(record: MCPCapabilityRecord, options?: { expected?: MCPCapabilityRecord \| null; }): Promise<boolean>`	Public method; parameters and return type are shown in the signature.

`MCPCapabilityListRequest`

MCP Capability List Request interface with 9 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityListRequest } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`kind`	property	`kind?: MCPCapabilityKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`limit`	property	`limit?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`loadDescriptors`	property	`loadDescriptors?: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`permissionScopes`	property	`permissionScopes?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`query`	property	`query?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`schemaTokenBudget`	property	`schemaTokenBudget?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`states`	property	`states?: ("quarantined" \| "approved" \| "changed" \| "removed" \| "stable" \| "new")[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tags`	property	`tags?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCapabilityQuarantineRequest`

MCP Capability Quarantine Request interface with 5 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityQuarantineRequest } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

export interface MCPCapabilityQuarantineRequest extends MCPCapabilityRef {
    reason: string;
}

Contract members

Member	Kind	Signature	Description
`capabilityHash`	property	`capabilityHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityId`	property	`capabilityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind?: MCPCapabilityKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reason`	property	`reason: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCapabilityRecord`

MCP Capability Record interface with 21 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityRecord } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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>;
}

Contract members

Member	Kind	Signature	Description
`approvalExpiresAt`	property	`approvalExpiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`approvedAt`	property	`approvedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityHash`	property	`capabilityHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityVersion`	property	`capabilityVersion?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`descriptor`	property	`descriptor: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`descriptorHash`	property	`descriptorHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`driftState`	property	`driftState: "quarantined" \| "approved" \| "changed" \| "removed" \| "stable" \| "new"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`driftTypes`	property	`driftTypes?: MCPCapabilityDriftType[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`firstSeenAt`	property	`firstSeenAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind: MCPCapabilityKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`lastSeenAt`	property	`lastSeenAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`normalizedToolSpec`	property	`normalizedToolSpec?: ToolSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`protocolVersion`	property	`protocolVersion?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`remoteName`	property	`remoteName: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`removedAt`	property	`removedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`schemaHash`	property	`schemaHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stableToolId`	property	`stableToolId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`trust`	property	`trust: MCPCapabilityTrustRecord`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCapabilityRef`

MCP Capability Ref interface with 4 public fields or methods.

Kind: interface
Import: import type { MCPCapabilityRef } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`capabilityHash`	property	`capabilityHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityId`	property	`capabilityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind?: MCPCapabilityKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPCatalogSnapshot`

MCP Catalog Snapshot interface with 7 public fields or methods.

Kind: interface
Import: import type { MCPCatalogSnapshot } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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[];
    }>;
}

Contract members

Member	Kind	Signature	Description
`capabilities`	property	`capabilities: MCPCapabilityRecord[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`createdAt`	property	`createdAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`drift`	property	`drift: { capabilityId: string; previousHash?: string; currentHash?: string; types: MCPCapabilityDriftType[]; }[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reason`	property	`reason?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPSchemaCacheEntry`

MCP Schema Cache Entry interface with 7 public fields or methods.

Kind: interface
Import: import type { MCPSchemaCacheEntry } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`cachedAt`	property	`cachedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityHash`	property	`capabilityHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityId`	property	`capabilityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`key`	property	`key: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`protocolVersion`	property	`protocolVersion?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`schema`	property	`schema?: JsonSchema`	Public property; its type, readonly modifier and optionality are shown in the signature.
`serverId`	property	`serverId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`MCPSchemaCacheOptions`

MCP Schema Cache Options interface with 2 public fields or methods.

Kind: interface
Import: import type { MCPSchemaCacheOptions } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

Contract members

Member	Kind	Signature	Description
`maxEntries`	property	`maxEntries?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`now`	method	`now?(): string`	Public method; parameters and return type are shown in the signature.

`RedisLikeMCPStoreClient`

Redis Like MCP Store Client interface with 5 public fields or methods.

Kind: interface
Import: import type { RedisLikeMCPStoreClient } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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>;
}

Contract members

Member	Kind	Signature	Description
`eval`	method	`eval?(script: string, numberOfKeys: number, ...args: Array<string \| number>): Promise<number \| string \| null>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get(key: string): Promise<string \| null>`	Public method; parameters and return type are shown in the signature.
`sadd`	method	`sadd(key: string, ...members: string[]): Promise<number>`	Public method; parameters and return type are shown in the signature.
`set`	method	`set(key: string, value: string): Promise<unknown>`	Public method; parameters and return type are shown in the signature.
`smembers`	method	`smembers(key: string): Promise<string[]>`	Public method; parameters and return type are shown in the signature.

`MCPCapabilityDriftType`

Public type alias for MCP Capability Drift Type; the declaration contains its complete type expression.

Kind: type
Import: import type { MCPCapabilityDriftType } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

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`

Public type alias for MCP Capability Kind; the declaration contains its complete type expression.

Kind: type
Import: import type { MCPCapabilityKind } from '@codesoul-co/hypha-mcp';
Source module: catalog

Declaration

text

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

@codesoul-co/hypha-mcp / catalog ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

InMemoryMCPCapabilityCatalogStore ​

Declaration ​

Public members ​

InMemoryToolContractSnapshotStore ​

Declaration ​

Public members ​

MCPCapabilityCatalog ​

Declaration ​

Public members ​

MCPSchemaCache ​

Declaration ​

Public members ​

RedisMCPCapabilityCatalogStore ​

Declaration ​

Public members ​

RedisToolContractSnapshotStore ​

Declaration ​

Public members ​

mcpCapabilityRecordDefinition ​

Declaration ​

mcpCapabilityRecordExample ​

Declaration ​

mcpCapabilityRecordJsonSchema ​

Declaration ​

mcpCapabilityRecordSchema ​

Declaration ​

normalizeMCPToolOutput ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

MCPCapabilityApprovalRequest ​

Declaration ​

Contract members ​

MCPCapabilityCatalogOptions ​

Declaration ​

Contract members ​

MCPCapabilityCatalogStore ​

Declaration ​

Contract members ​

MCPCapabilityListRequest ​

Declaration ​

Contract members ​

MCPCapabilityQuarantineRequest ​

Declaration ​

Contract members ​

MCPCapabilityRecord ​

Declaration ​

Contract members ​

MCPCapabilityRef ​

Declaration ​

Contract members ​

MCPCatalogSnapshot ​

Declaration ​

Contract members ​

MCPSchemaCacheEntry ​

Declaration ​

Contract members ​

MCPSchemaCacheOptions ​

Declaration ​

Contract members ​

RedisLikeMCPStoreClient ​

Declaration ​

Contract members ​

MCPCapabilityDriftType ​

Declaration ​

MCPCapabilityKind ​

Declaration ​

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

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`InMemoryMCPCapabilityCatalogStore`

Declaration

Public members

`InMemoryToolContractSnapshotStore`

Declaration

Public members

`MCPCapabilityCatalog`

Declaration

Public members

`MCPSchemaCache`

Declaration

Public members

`RedisMCPCapabilityCatalogStore`

Declaration

Public members

`RedisToolContractSnapshotStore`

Declaration

Public members

`mcpCapabilityRecordDefinition`

Declaration

`mcpCapabilityRecordExample`

Declaration

`mcpCapabilityRecordJsonSchema`

Declaration

`mcpCapabilityRecordSchema`

Declaration

`normalizeMCPToolOutput`

Declaration

Call signature

Parameters

Returns

`MCPCapabilityApprovalRequest`

Declaration

Contract members

`MCPCapabilityCatalogOptions`

Declaration

Contract members

`MCPCapabilityCatalogStore`

Declaration

Contract members

`MCPCapabilityListRequest`

Declaration

Contract members

`MCPCapabilityQuarantineRequest`

Declaration

Contract members

`MCPCapabilityRecord`

Declaration

Contract members

`MCPCapabilityRef`

Declaration

Contract members

`MCPCatalogSnapshot`

Declaration

Contract members

`MCPSchemaCacheEntry`

Declaration

Contract members

`MCPSchemaCacheOptions`

Declaration

Contract members

`RedisLikeMCPStoreClient`

Declaration

Contract members

`MCPCapabilityDriftType`

Declaration

`MCPCapabilityKind`

Declaration