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 检查器界面

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

服务器连接窗格

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

资源选项卡

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

提示词选项卡

  • 显示可用的提示词模板
  • 显示提示词参数和描述
  • 允许使用自定义参数进行提示词测试
  • 预览生成的消息

工具选项卡

  • 列出可用的工具
  • 显示工具的模式和描述
  • 允许使用自定义输入进行工具测试
  • 显示工具执行结果

通知窗格

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

最佳实践

开发工作流程

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

后续步骤