跳到主要内容
MCP 检查器是一个用于测试和调试 MCP 服务器的交互式开发者工具。虽然调试指南将检查器作为整体调试工具包的一部分进行了介绍,但本文档将深入探讨检查器的各项功能和能力。

入门指南

安装与基本用法

检查器可以通过 npx 直接运行,无需安装
npx @modelcontextprotocol/inspector <command>
npx @modelcontextprotocol/inspector <command> <arg1> <arg2>

检查来自 npm 或 PyPI 的服务器

这是启动来自 npmPyPI 的服务器包的常用方式。
npx -y @modelcontextprotocol/inspector npx <package-name> <args>
# For example
npx -y @modelcontextprotocol/inspector npx @modelcontextprotocol/server-filesystem /Users/username/Desktop

检查本地开发的服务器

要检查本地开发或作为代码仓库下载的服务器,最常用的方式是
npx @modelcontextprotocol/inspector node path/to/server/index.js args...
请仔细阅读随附的任何 README 文件以获取最准确的说明。

功能概览

检查器提供了多项功能来与您的 MCP 服务器交互

服务器连接面板

  • 允许选择连接服务器的传输方式 (transport)
  • 对于本地服务器,支持自定义命令行参数和环境

资源 (Resources) 选项卡

  • 列出所有可用资源
  • 显示资源元数据(MIME 类型、描述)
  • 允许检查资源内容
  • 支持订阅测试

提示词 (Prompts) 选项卡

  • 显示可用的提示词模板
  • 显示提示词参数和描述
  • 支持使用自定义参数进行提示词测试
  • 预览生成的详细信息

工具 (Tools) 选项卡

  • 列出所有可用工具
  • 显示工具架构 (schemas) 和描述
  • 支持使用自定义输入进行工具测试
  • 显示工具执行结果

通知面板

  • 展示从服务器记录的所有日志
  • 显示从服务器接收到的通知

最佳实践

开发工作流

  1. 开始开发
    • 使用您的服务器启动检查器
    • 验证基础连接性
    • 检查能力协商 (capability negotiation)
  2. 迭代测试
    • 对服务器进行更改
    • 重新构建服务器
    • 重新连接检查器
    • 测试受影响的功能
    • 监控消息
  3. 测试边缘情况
    • 无效输入
    • 缺失提示词参数
    • 并发操作
    • 验证错误处理和错误响应

后续步骤