@github/mcp-注册
脚本 SDK 类型 MCP 书记官处 ——包括注册API客户端,生成类型,以及用于企业许可名单执行的决定性指纹计算.
安装
npm install @github/mcp-registry
注册客户端
import { RegistryClient } from '@github/mcp-registry';
const client = new RegistryClient();
// Search for servers
const servers = await client.searchServers({ query: 'github', limit: 5 });
for (const s of servers) {
console.log(`${s.server.name}@${s.server.version}`);
}
// Get a specific server
const server = await client.getServer({ name: 'io.github.user/repo' });
// Get a specific version
const pinned = await client.getServer({
name: 'io.github.user/repo',
version: '1.2.0',
});
// Parse "name@version" format
const entry = await client.getDsl('io.github.user/[email protected]');
配置
const client = new RegistryClient({
baseUrl: 'https://api.mcp.github.com/v0.1', // default
cacheTtlMs: 5 * 60 * 1000, // 5 minutes (default)
timeoutMs: 30_000, // 30 seconds (default)
fetch: customFetch, // optional custom fetch
});
处理错误
客户端返回 null 404和掷出 RegistryError 用于其他 HTTP 错误 :
import { RegistryClient, RegistryError } from '@github/mcp-registry';
const server = await client.getServer({ name: 'example/server' });
if (!server) {
console.log('Not found');
}
指纹计算
用于企业许可列表执行的定型SHA-256指纹——计算出与注册后端相同的指纹.
import { computeFingerprint, verifyFingerprint, commandToRegistryType } from '@github/mcp-registry';
// Remote server
const fp = computeFingerprint({
remotes: [{ url: 'https://mcp.example.com/sse' }],
});
// Local package
const registryType = commandToRegistryType('npx'); // → "npm"
const fp2 = computeFingerprint({
packages: [{ registryType: registryType!, identifier: '@playwright/mcp' }],
});
// Verify against the enterprise allowlist
const matches = verifyFingerprint(
{ packages: [{ registryType: 'npm', identifier: '@playwright/mcp' }] },
allowlistEntry.server.fingerprints ?? {},
);
命令绘图
| 命令 | 登记类型 |
|---|---|
npx, (中文(简体) ), npm | npm |
uvx, (中文(简体) ), pip | pypi |
dotnet | nuget |
docker | docker |
brew | homebrew |
DSL 引擎
DSL引擎从服务器定义中提取可配置字段,验证用户提供的配置,并计算出发射计划(启动服务器所需的命令+env+头).
快速启动——注册客户端+DSL引擎
import { RegistryClient, DslEngine } from '@github/mcp-registry';
// 1. Fetch a server definition from the registry
const client = new RegistryClient();
const response = await client.getServer({ name: 'io.github.user/repo' });
if (!response) throw new Error('Server not found');
// 2. Create a DSL engine from the response
const engine = DslEngine.fromServerResponse(response);
// 3. Discover what configuration the server needs
const requiredFields = engine.getRequiredFields();
for (const field of requiredFields) {
console.log(`${field.key} (${field.type})${field.isSecret ? ' [secret]' : ''}`);
}
// 4. Validate user-provided configuration
const validation = engine.validate({
environmentVariables: { API_KEY: 'sk-...' },
});
if (!validation.valid) {
console.log('Missing:', validation.missingFields.map(f => f.key));
}
// 5. Resolve a launch plan
const result = engine.resolve({
environmentVariables: { API_KEY: 'sk-...' },
});
if (result.complete && result.plan) {
if (result.plan.type === 'package') {
// Start a local process
console.log('Command:', result.plan.command.join(' '));
console.log('Env:', result.plan.env);
} else {
// Connect to a remote server
console.log('Endpoint:', result.plan.endpoint);
console.log('Headers:', result.plan.headers);
}
}
提取字段
使用 extractConfigurableFields 当您不需要全引擎时:
import { extractConfigurableFields } from '@github/mcp-registry';
import type { ServerDetail } from '@github/mcp-registry';
const fields = extractConfigurableFields(server);
// fields: FieldSpec[] — key, type, required, isSecret, enumValues, etc.
// Extract fields for a specific remote instead of the default package
const remoteFields = extractConfigurableFields(server, { remoteIndex: 0 });
解决发射计划
import { resolveLaunchPlan } from '@github/mcp-registry';
// Package-based (local process)
const plan = resolveLaunchPlan({
spec: server,
config: { environmentVariables: { API_KEY: 'sk-...' } },
});
// plan.type === 'package'
// plan.command → ['npx', '-y', '@scope/[email protected]']
// plan.env → { API_KEY: 'sk-...' }
// Remote-based (HTTP connection)
const remotePlan = resolveLaunchPlan({
spec: server,
config: { headers: { Authorization: 'Bearer token' } },
remoteIndex: 0,
});
// remotePlan.type === 'remote'
// remotePlan.endpoint → 'https://api.example.com/mcp'
// remotePlan.headers → { Authorization: 'Bearer token' }
假设安装选择
用一个引擎呼叫来检查每个广告包和遥控器 为每个阵列索引构建一个引擎 :
const result = engine.enumerateInstallChoices(
{ headers: { Authorization: 'Bearer ...' } },
{
policy: choice => choice.transport === 'sse'
? { decision: 'denied', code: 'sse-disabled', reason: 'SSE is disabled by policy' }
: { decision: 'allowed' },
},
);
// Packages first, then remotes, preserving each source array's order.
for (const choice of result.advertisedChoices) {
console.log(choice.choiceId, choice.transport, choice.validation, choice.policy);
if (choice.eligible) {
console.log(choice.configurableFields, choice.launchPlan);
} else {
console.log(choice.ineligibility);
}
}
console.log(result.eligibleChoices);
准确的方法签名是:
enumerateInstallChoices(
config?: ConfigValues,
options?: EnumerateInstallChoicesOptions,
): InstallChoicesResult
选择ID对描述者具有决定性意义: package:<index> 财务报告和审定财务报表
remote:<index>通过提供远程 URL 模板值
ConfigValues.urlVariables。配置错误不会在结构上隐藏
因此,呼叫者可以在保留
惰性发射计划. 无效、不支持和拒绝政策的广告
保留在 advertisedChoices 有打字解释.
许可证
麻省理工学院