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 回答下一個問題
針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合