檢查器

MCP 檢查器是一個用於測試和調試 MCP 服務器的交互式開發者工具。雖然調試指南將檢查器作為整體調試工具包的一部分進行介紹,但本文檔詳細探討了檢查器的特性和功能。

入門

安裝和基本使用

檢查器可以直接通過 npx 運行,無需安裝:

npx @modelcontextprotocol/inspector <command>
npx @modelcontextprotocol/inspector <command> <arg1> <arg2>

檢查來自 NPM 或 PyPi 的服務器

NPMPyPi 啟動服務器包的常用方法。

  npx -y @modelcontextprotocol/inspector npx <package-name> <args>
  # 例如
  npx -y @modelcontextprotocol/inspector npx server-postgres postgres://127.0.0.1/testdb
  npx @modelcontextprotocol/inspector uvx <package-name> <args>
  # 例如
  npx @modelcontextprotocol/inspector uvx mcp-server-git --repository ~/code/mcp/servers.git

檢查本地開發的服務器

要檢查本地開發或作為倉庫下載的服務器,最常用的方法是:

  npx @modelcontextprotocol/inspector node path/to/server/index.js args...
  npx @modelcontextprotocol/inspector \
    uv \
    --directory path/to/server \
    run \
    package-name \
    args...

請仔細閱讀附帶的 README 以獲取最準確的說明。

功能概述

MCP 檢查器界面

檢查器提供了幾個用於與 MCP 服務器交互的功能:

服務器連接面板

  • 允許選擇用於連接服務器的傳輸方式
  • 對於本地服務器,支持自定義命令行參數和環境

資源標籤頁

  • 列出所有可用資源
  • 顯示資源元數據(MIME 類型、描述)
  • 允許資源內容檢查
  • 支持訂閱測試

提示詞標籤頁

  • 顯示可用的提示詞模板
  • 顯示提示詞參數和描述
  • 支持使用自定義參數測試提示詞
  • 預覽生成的消息

工具標籤頁

  • 列出可用工具
  • 顯示工具模式和描述
  • 支持使用自定義輸入測試工具
  • 顯示工具執行結果

通知面板

  • 顯示從服務器記錄的所有日誌
  • 顯示從服務器接收的通知

最佳實踐

開發工作流

  1. 開始開發

    • 啟動檢查器和您的服務器
    • 驗證基本連接
    • 檢查功能協商
  2. 迭代測試

    • 修改服務器
    • 重新構建服務器
    • 重新連接檢查器
    • 測試受影響的功能
    • 監控消息
  3. 測試邊緣情況

    • 無效輸入
    • 缺少提示詞參數
    • 併發操作
    • 驗證錯誤處理和錯誤響應

下一步