@codesoul-co/hypha-mcp / governance

• 包索引: @codesoul-co/hypha-mcp
• 源码: packages/mcp/src/governance.ts
• 导出数: 11

模块用法

用于实施 Policy 与治理检查。Governance 模块公开 1 类、5 函数、3 接口、2 类型。

从包入口导入

import {
  InMemoryMCPCapabilityBaselineStore,
  attestCapability,
  capabilityHash,
  capabilityKey,
  evaluateCapabilityDrift,
  governedSideEffectLevel,
} from '@codesoul-co/hypha-mcp';

import type {
  MCPCapabilityBaselineStore,
  MCPDriftEvaluation,
  MCPDriftRecord,
  MCPDriftPolicy,
  MCPDriftStatus,
} from '@codesoul-co/hypha-mcp';

使用要点

• 5 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
• 5 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
InMemoryMCPCapabilityBaselineStore	类	new InMemoryMCPCapabilityBaselineStore(): InMemoryMCPCapabilityBaselineStore	In Memory MCP Capability Baseline Store 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
attestCapability	函数	attestCapability(capability: MCPCapabilityDescriptor): MCPCapabilityDescriptor	Attest Capability 函数，提供 1 个公开调用签名；参数与返回类型见下表。
capabilityHash	函数	capabilityHash(capability: MCPCapabilityDescriptor): string	Capability Hash 函数，提供 1 个公开调用签名；参数与返回类型见下表。
capabilityKey	函数	capabilityKey(capability: Pick<MCPCapabilityDescriptor, "serverId" | "capabilityId">): string	Capability Key 函数，提供 1 个公开调用签名；参数与返回类型见下表。
evaluateCapabilityDrift	函数	evaluateCapabilityDrift(discovered: MCPCapabilityDescriptor[], baseline: MCPCapabilityDescriptor[], policy?: MCPDriftPolicy): MCPDriftEvaluation	Evaluate Capability Drift 函数，提供 1 个公开调用签名；参数与返回类型见下表。
governedSideEffectLevel	函数	governedSideEffectLevel(capability: MCPCapabilityDescriptor): SideEffectLevel	Governed Side Effect Level 函数，提供 1 个公开调用签名；参数与返回类型见下表。
MCPCapabilityBaselineStore	接口	interface MCPCapabilityBaselineStore	MCP Capability Baseline Store 接口，共包含 2 个公开字段或方法。
MCPDriftEvaluation	接口	interface MCPDriftEvaluation	MCP Drift Evaluation 接口，共包含 4 个公开字段或方法。
MCPDriftRecord	接口	interface MCPDriftRecord	MCP Drift Record 接口，共包含 6 个公开字段或方法。
MCPDriftPolicy	类型	type MCPDriftPolicy = 'quarantine' | 'accept'	MCP Drift Policy 公共类型别名；完整类型表达式见声明。
MCPDriftStatus	类型	type MCPDriftStatus = 'added' | 'unchanged' | 'changed' | 'removed'	MCP Drift Status 公共类型别名；完整类型表达式见声明。

InMemoryMCPCapabilityBaselineStore

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

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

声明

export declare class InMemoryMCPCapabilityBaselineStore implements MCPCapabilityBaselineStore {
    load(integrationId: string): Promise<MCPCapabilityDescriptor[]>;
    save(integrationId: string, capabilities: MCPCapabilityDescriptor[]): Promise<void>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(): InMemoryMCPCapabilityBaselineStore	创建该类的实例。
load	方法	load(integrationId: string): Promise<MCPCapabilityDescriptor[]>	公开方法；参数与返回类型以签名列为准。
save	方法	save(integrationId: string, capabilities: MCPCapabilityDescriptor[]): Promise<void>	公开方法；参数与返回类型以签名列为准。

attestCapability

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

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

声明

export declare function attestCapability(capability: MCPCapabilityDescriptor): MCPCapabilityDescriptor;

调用签名

attestCapability(capability: MCPCapabilityDescriptor): MCPCapabilityDescriptor

参数

参数	类型	必需	说明
capability	MCPCapabilityDescriptor	是	必需参数；接受的值由类型列定义。

返回值

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

capabilityHash

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

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

声明

export declare function capabilityHash(capability: MCPCapabilityDescriptor): string;

调用签名

capabilityHash(capability: MCPCapabilityDescriptor): string

参数

参数	类型	必需	说明
capability	MCPCapabilityDescriptor	是	必需参数；接受的值由类型列定义。

返回值

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

capabilityKey

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

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

声明

export declare function capabilityKey(capability: Pick<MCPCapabilityDescriptor, 'serverId' | 'capabilityId'>): string;

调用签名

capabilityKey(capability: Pick<MCPCapabilityDescriptor, "serverId" | "capabilityId">): string

参数

参数	类型	必需	说明
capability	Pick<MCPCapabilityDescriptor, "serverId" | "capabilityId">	是	必需参数；接受的值由类型列定义。

返回值

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

evaluateCapabilityDrift

Evaluate Capability Drift 函数，提供 1 个公开调用签名；参数与返回类型见下表。

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

声明

export declare function evaluateCapabilityDrift(discovered: MCPCapabilityDescriptor[], baseline: MCPCapabilityDescriptor[], policy?: MCPDriftPolicy): MCPDriftEvaluation;

调用签名

evaluateCapabilityDrift(discovered: MCPCapabilityDescriptor[], baseline: MCPCapabilityDescriptor[], policy?: MCPDriftPolicy): MCPDriftEvaluation

参数

参数	类型	必需	说明
discovered	MCPCapabilityDescriptor[]	是	必需参数；接受的值由类型列定义。
baseline	MCPCapabilityDescriptor[]	是	必需参数；接受的值由类型列定义。
policy	MCPDriftPolicy	否	可选参数；接受的值由类型列定义。

返回值

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

governedSideEffectLevel

Governed Side Effect Level 函数，提供 1 个公开调用签名；参数与返回类型见下表。

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

声明

export declare function governedSideEffectLevel(capability: MCPCapabilityDescriptor): SideEffectLevel;

调用签名

governedSideEffectLevel(capability: MCPCapabilityDescriptor): SideEffectLevel

参数

参数	类型	必需	说明
capability	MCPCapabilityDescriptor	是	必需参数；接受的值由类型列定义。

返回值

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

MCPCapabilityBaselineStore

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

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

声明

export interface MCPCapabilityBaselineStore {
    load(integrationId: string): Promise<MCPCapabilityDescriptor[]>;
    save(integrationId: string, capabilities: MCPCapabilityDescriptor[]): Promise<void>;
}

契约成员

成员	种类	签名	说明
load	方法	load(integrationId: string): Promise<MCPCapabilityDescriptor[]>	公开方法；参数与返回类型以签名列为准。
save	方法	save(integrationId: string, capabilities: MCPCapabilityDescriptor[]): Promise<void>	公开方法；参数与返回类型以签名列为准。

MCPDriftEvaluation

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

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

声明

export interface MCPDriftEvaluation {
    current: MCPCapabilityDescriptor[];
    acceptedBaseline: MCPCapabilityDescriptor[];
    records: MCPDriftRecord[];
    quarantinedKeys: Set<string>;
}

契约成员

成员	种类	签名	说明
acceptedBaseline	属性	acceptedBaseline: MCPCapabilityDescriptor[]	公开属性；类型、只读和可选状态以签名列为准。
current	属性	current: MCPCapabilityDescriptor[]	公开属性；类型、只读和可选状态以签名列为准。
quarantinedKeys	属性	quarantinedKeys: Set<string>	公开属性；类型、只读和可选状态以签名列为准。
records	属性	records: MCPDriftRecord[]	公开属性；类型、只读和可选状态以签名列为准。

MCPDriftRecord

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

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

声明

export interface MCPDriftRecord {
    capabilityKey: string;
    serverId: string;
    capabilityId: string;
    status: MCPDriftStatus;
    previousHash?: string;
    currentHash?: string;
}

契约成员

成员	种类	签名	说明
capabilityId	属性	capabilityId: string	公开属性；类型、只读和可选状态以签名列为准。
capabilityKey	属性	capabilityKey: string	公开属性；类型、只读和可选状态以签名列为准。
currentHash	属性	currentHash?: string	公开属性；类型、只读和可选状态以签名列为准。
previousHash	属性	previousHash?: string	公开属性；类型、只读和可选状态以签名列为准。
serverId	属性	serverId: string	公开属性；类型、只读和可选状态以签名列为准。
status	属性	status: MCPDriftStatus	公开属性；类型、只读和可选状态以签名列为准。

MCPDriftPolicy

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

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

声明

export type MCPDriftPolicy = 'quarantine' | 'accept';

MCPDriftStatus

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

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

声明

export type MCPDriftStatus = 'added' | 'unchanged' | 'changed' | 'removed';