@ girthits/ mcp (英语)
为 GitHits 重用 MCP 服务器 API和工具注册.
此软件包会曝光服务器的中性运输辅助器, 这些辅助器想要 GitHits MCP 工具表面, 而不需要本地 githits CLI 启动, 认证存储, 或指挥官接线 .
生产服务器 https://mcp.githits.com 分别生活
remote-mcp 存储并消耗此软件包的已发布版本
工具注册、描述符、, quick_start和工具逻辑。 那个主机拥有
HTTP运输、请求范围服务构成、认证/会议处理、,
部署, 和可观察性; 依赖后软件包行为到达它
更新和部署,而不是通过平行执行.
浏览器边界 : 仅选择
@githits/mcp/tools解析运行时间 图为浏览器安全。 安装@githits/mcp仍然安装它的 MCP SDK 以及面向节点的其他依赖; 软件包根和@githits/mcp/client保留节点条目。 这个/tools未提供条目 文件系统访问、认证执行或存储、配置 发现 或任何其他主机行为.
稳定研究
公共清单包括: research 默认。 它回答了一个问题
关于公共软件包或存储器,有经核实的、来源引用的答案,可以
识别问题中的目标,然后继续线程 thread_id。 。 。 .
答复需要几分钟; AgenticAskServiceImpl 应用 210 秒
截止日期(AGENTIC_ASK_REQUEST_TIMEOUT_MS)并尊重 MCP 请求的中止
信号 主机应该保留其请求和MCP客户端超时
期限,或通过更低的 timeoutMs。 。 。 .
供应商现在必须提供 agenticAskService: AgenticAskService导入
AgenticAskServiceImpl 请求/答复/运行时间合同
@githits/mcp/client; 以 GitHits REST API 基础( 相同的) 构造它
apiUrl 用于 GitHitsServiceImpl),请求的代号提供者,以及
请求的客户端头和用户代理。 浏览器调用厂
createResearchTool 财务报告和审定财务报表 ResearchMcpArgs 从
@githits/mcp/tools。利率限制映射到 RATE_LIMITED: 短期限制
可在 retryAfterSeconds,而每日限制设定
details.rateLimitScope: "daily" ,在 UTC 00:00 之前不可重试。 托管
MCP必须在客户收到该软件之前采用和部署该软件包
工具.
稳定目标分辨率
公共清单包括: resolve_target 默认。 它把模糊的公众排序
使用现有后端的软件包、仓库和文件站名
解决者。 目标直接转到下一个工具;信心、模糊
和恶意内容状态 继续。 这并不确定
无脆弱性或升级安全.
供应商现在必须提供 resolveTargetService: ResolveTargetService导入
ResolveTargetServiceImpl 服务/要求/结果合同
@githits/mcp/client; 以现有的开放源码软件终点和
请求的符号提供者、信头和可选诊断。 可调用浏览器
工厂和 ResolveTargetMcpArgs 从 @githits/mcp/tools。 。 。 .
不需要私人核心或工作空间内部进口。 托管的MCP必须采用
并在客户端收到工具之前部署已发布的软件包.
稳定源代码
公共工具清单包括: code_diff 默认。 比较原始
精确软件包版本的存储树或公共存储站参考;
软件包地址不过滤到软件包子目录。 默认为
有限名称-状态清单和文本,可提供范围统计/标签.
截断和内容安全限制仍然是证据限制;diff不是
建立升级兼容性.
自定义服务提供者必须提供 codeNavigationService 执行两项
CodeNavigationService 财务报告和审定财务报表 CodeDiffService进口这些合同
@githits/mcp/client; 内置 CodeNavigationServiceImpl 已经
执行两者。 仅执行导航的供应商必须添加 codeDiff
在通过此软件包版本之前。 独立 CodeNavigationService
接口保持不变。 单独的主机服务器必须采用和部署
在主机客户端收到工具之前发布的软件包.
API 密码
createMcpServer(options)创建已注册的 GitHits 工具的 MCP 服务器 .registerMcpTools(server, options)在现有的 MCP 服务器上注册 GitHits 工具.getMcpToolDescriptors()返回静态工具元数据而不需要具体服务.buildMcpQuickStart(options?)构建仅读返回的向导quick_start工具.buildMcpInstructions(options?)是一个已贬值的相容性别名,用于buildMcpQuickStart()。 。 。 .@githits/mcp/clientgitHits 服务类型和执行,包括ReadService财务报告和审定财务报表ReadServiceImpl,静态令牌提供者, URL/配置帮助者, 请求首页帮助者ServiceDiagnostics类型,以及远程 MCP 服务器的注册帮助。 服务客户端默认是默默的;需要操作跨度或调试事件的主机注入ServiceDiagnostics通过运行时间选项执行。 主办方必须明确选择进入敏感的诊断领域,并拥有由此产生的隐私和保留政策.- 前模块 -- -- 全球遥测生命周期辅助工具
startTelemetrySpan, (中文(简体) ),endTelemetrySpan, (中文(简体) ),flushTelemetry,以及withTelemetrySpan不从@githits/mcp/client通过注射,远程主机拥有诊断生命周期和目的地. @githits/mcp/smoke-test出口可重复使用的烟雾断言和runMcpSmoke()用于远程 MCP 服务器验证.@githits/mcp/tools导出可调用浏览器get_example工厂和 其结构服务合同,加toCallableTool()和马厩 可调用结果/ schema 类型。 还输出中立人AuthenticationError, (中文(简体) ),ApiRateLimitError, (中文(简体) ),FetchTimeoutError,以及TermsAcceptanceRequiredError可调用错误所用的构造器 边界.
可浏览器调用 @githits/mcp/tools
这个 /tools 条目是一个小的前端表面。 输入服务
仅限 search(params, options?) 方法,创建现有的 get_example
定义,并将其适应一个简单的可调用对象:
import {
createGetExampleTool,
toCallableTool,
type GetExampleRequestOptions,
type GetExampleSearchParams,
type GetExampleService,
} from "@githits/mcp/tools";
// Supplied by the application; it owns transport, authentication, and CORS.
declare function searchExamples(
params: GetExampleSearchParams,
options?: GetExampleRequestOptions,
): Promise<string>;
const service: GetExampleService = {
search: (params, options) => searchExamples(params, options),
};
const tool = toCallableTool(createGetExampleTool(service));
toCallableTool() 包装工具的 Zod 对象计划, 释放输入- 模式 JSON
Schema,并在调用服务前验证/默认输入 。 省略内容
format 字段在设置和默认值中仍然是可选的 "text"。唯一的格式值是: "text" 财务报告和审定财务报表 "json"。 。 。 .
未知对象属性遵循了正常的Zod对象行为. 成功
和结构错误结果作为可序列返回 ToolResult
形状。 如果打电话者提供 AbortSignal中,改为
(b) 取消服务
错误结果 .
被注入的浏览器服务应该抛出导出的一个中性错误
需要时建构器 get_example 返回结构化
AUTH_REQUIRED, (中文(简体) ), REAUTH_REQUIRED, (中文(简体) ), RATE_LIMITED, (中文(简体) ), TIMEOUT,或 TERMS_ACCEPTANCE_REQUIRED
ToolResult。这是一个明确的抛出错误合同,而不是自动HTTP
反应分类。 可调用认证补救是主机中性 :
Authenticate with GitHits, then retry. 术语错误使用词条
acceptanceUrl 行动。 其他错误依然存在 UNKNOWN。 。 。 .
ProviderReauthenticationRequiredError 从 /tools 财务报告和审定财务报表 /client。 。 。 .
示例搜索和研究映射到 REAUTH_REQUIRED 与 retryable: false。 。 。 .
details.action 提供登录指导; details.reauthUrl 包含已验证的
可用的登录链接。 在重试请求前完成签名 .
前端可以为其WebMCP主机API添加一个小型注册适配器. 这个 适配器拥有特定主机的注册呼叫并传递信号; 3; 可调用表面不是一个通用协议转换层:
document.modelContext.registerTool({
name: tool.name,
description: tool.description,
inputSchema: tool.inputSchema,
annotations: tool.annotations,
execute: (input, options) =>
tool.execute(input, { signal: options?.signal }),
});
前端拥有 document.modelContext,认证和登录
反应到异常转换、请求运输、CORS政策和任何
用户化恢复。 注入服务决定应用程序的后端
边界得到认证和达到.
该软件包期望呼叫者通过 McpToolServices 或请求范围 McpToolServicesProvider。 。 。 . McpToolServices.readService 广告契约需要 read 工具; 远程主机应当构建 ReadServiceImpl 每个请求的端点、符号、信笺、取取功能和诊断。 GitHits 不流行 MCP 初始化指令, 因为主机不连贯地曝光它们 ; quick_start 相反,它拥有共同的指导。 打电话的人还可能自己通过 instructions 当然 使用 quickStartOptions 以配置向导。 服务器可以通过 traceTool 改为 createMcpServer() 或者说 registerMcpTools() 在不接收参数或认证数据的情况下,将公用工具执行包成仪器.
服务器可以通过可选 progress 钩入 createMcpServer() 或者说 registerMcpTools() 提供实时服务 research 财务报告和审定财务报表 get_example。它仅在客户端发送进度符(包括 0; 更新为 notifications/progress 在工具返回前停止. RelayReceiver 是捆绑的钩子:它通过一个共享的 WebSocket 接收 GitHits 操作进度,由呼叫者自己的 GitHits 令牌授权({ kind: "caller", getToken })或由运行时提供的服务证明({ kind: "service", serviceId, key }) (中文(简体) ). 包裹船没有证书。 呼叫从不等待进度连接: 接收者选择本地的中继ID, 并在背景中连接, 因此在它准备好之前发布的更新会被跳过 。 进步是最佳努力:如果无法使用或被拒绝,该工具运行不变,一旦没有进展就重新发送被否决的请求,最终结果总是具有权威性. 打电话 close() 关闭。 与一个 progress 钩子,信件也以 GitHits 收缩标记为本地动画(narrowingFrame 编号 : narrowingText页:1 progressAnimation: false 来禁用它或 { intervalMs } 以改变帧率。 框架由MCP服务器生成,只发送给该呼叫的客户端.
网络支持工具将 MCP 请求的中止信号转发到他们的服务呼叫中, 作为可选跟踪 ServiceRequestOptions 参数( e){ signal }),所以一个已取消的呼叫或关闭的连接会中止后端请求. 这些工具背后的捆绑式服务实施将受到尊重;定制服务实施应推进 options?.signal 他们自己的要求。 没有信号的电话保持单声道形状.
只从 @githits/mcp, (中文(简体) ), @githits/mcp/client, (中文(简体) ), @githits/mcp/smoke-test, (中文(简体) ), @githits/mcp/tools,以及 @githits/mcp/package.json 是公开的。 工作空间别名 @githits/mcp/internal 不导出,不支持外部消费者,并且不得被远程MCP服务器执行所使用.
远程MCP服务器应通过请求范围提供服务 createMcpServer() 并保持运输、授权/会话处理、部署配置和本包外的可观察性.