MCP Server and Tool Telemetry：从边界到验证行
在受控应用程序边界使用 MCP Server and Tool Telemetry，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
MCP 工具可靠性
- 2
定义合同
tool_call_id、run_id、server_name、tool_name、client_type、运输和释放
- 3
埋点边界
检测已注册的工具处理程序，以便每次尝试调用都会产生一个结果事件，包括返回的 MCP 错误。
- 4
核实证据
Exercise a known fixture, then inspect mcp_tool_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- @modelcontextprotocol/sdk、zod 和 telemetry-sh 在受信任的服务器进程中初始化
- 有界工具分类法和应用程序拥有的调用或运行标识符
- 针对工具输入、输出、批准、客户身份和副作用的授权和隐私策略
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
MCP Server and Tool Telemetry事件
server.registerTool(
"lookup-account",
{
title: "Look up account",
description: "Return an approved account summary",
inputSchema: { accountId: z.string() },
},
async ({ accountId }) => {
const startedAt = performance.now();
const toolCallId = crypto.randomUUID();
let status = "success";
let errorType;
try {
const summary = await lookupApprovedAccountSummary(accountId);
return {
content: [{ type: "text", text: summary }],
};
} catch (error) {
status = "failed";
errorType = classifyToolError(error);
return {
content: [{ type: "text", text: "Account lookup failed" }],
isError: true,
};
} finally {
await telemetry.log("mcp_tool_completed", {
tool_call_id: toolCallId,
server_name: "account-tools",
tool_name: "lookup-account",
status,
error_type: errorType,
duration_ms: Math.round(performance.now() - startedAt),
release: process.env.APP_RELEASE,
}).catch(reportTelemetryDeliveryFailure);
}
},
);活动合约
tool_call_id、run_id、server_name、tool_name、client_type、运输和释放
状态、duration_ms、retry_count、error_type、approval_required 和 approval_result
side_effect_category 和 output_category 仅在有界和批准时
实施检查点
检查站 1
检测已注册的工具处理程序，以便每次尝试调用都会产生一个结果事件，包括返回的 MCP 错误。
检查站 2
默认情况下，将工具输入、返回内容、嵌入资源、文件路径、凭据、令牌和不受限制的错误排除在 Telemetry 之外。
检查站 3
不要让Telemetry交付失败改变了成功的工具结果；使用短超时、本地错误报告和有界关闭行为。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
MCP Server and Tool Telemetry 验证查询
SELECT *
FROM mcp_tool_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 AI代理监控
通过可审查的 SQL 连接智能体运行、工具使用、模型成本、质量和产品结果。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成