MCP Inspector是一款用于测试和调试MCP服务器的交互式开发者工具。虽然调试指南将检查器作为整体调试工具套件的一部分进行介绍,但本文档详细探讨了检查器的功能特性。

入门指南

安装与基础使用

The Inspector 直接通过 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. Iterative testing
    • 进行服务器更改
    • 重建服务器
    • 重新连接检查器
    • 测试受影响的功能
    • 监控消息
  3. 测试边界案例
    • 无效输入
    • 缺少提示参数
    • 并发操作
    • 验证错误处理和错误响应

后续步骤