MCP 检查器 是一个用于测试和调试 MCP 服务器的交互式开发者工具。虽然调试指南 将检查器作为整体调试工具包的一部分进行了介绍,但本文档详细探讨了检查器的功能和能力。
开始使用
安装和基本用法
检查器可以直接通过 npx
运行,无需安装:
npx @modelcontextprotocol/inspector <command>
npx @modelcontextprotocol/inspector <command> <arg1> <arg2>
检查来自 NPM 或 PyPi 的服务器
从 NPM 或 PyPi 启动服务器包的常见方式。
npx -y @modelcontextprotocol/inspector npx <package-name> <args>
# 例如
npx -y @modelcontextprotocol/inspector npx server-postgres postgres://127.0.0.1/testdb
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 node path/to/server/index.js args...
npx @modelcontextprotocol/inspector \
uv \
--directory path/to/server \
run \
package-name \
args...
请仔细阅读附带的 README 以获取最准确的说明。
功能概述
检查器提供了多种功能,用于与您的 MCP 服务器进行交互:
服务器连接面板
- 允许选择用于连接服务器的传输
- 对于本地服务器,支持自定义命令行参数和环境
资源选项卡
- 列出所有可用资源
- 显示资源元数据(MIME 类型、描述)
- 允许检查资源内容
- 支持订阅测试
提示选项卡
- 显示可用的提示模板
- 显示提示参数和描述
- 支持使用自定义参数测试提示
- 预览生成的消息
工具选项卡
- 列出可用工具
- 显示工具模式和描述
- 支持使用自定义输入测试工具
- 显示工具执行结果
通知面板
- 显示从服务器记录的所有日志
- 显示从服务器接收的通知
最佳实践
开发工作流
-
开始开发
- 使用检查器启动您的服务器
- 验证基本连接性
- 检查能力协商
-
迭代测试
- 进行服务器更改
- 重新构建服务器
- 重新连接检查器
- 测试受影响的功能
- 监控消息
-
测试边缘情况
- 无效输入
- 缺少提示参数
- 并发操作
- 验证错误处理和错误响应
下一步