MCP检查器教程：高效测试与调试MCP服务器工具

简介

MCP检查器是一个用于测试和调试MCP服务器的交互式开发工具。本文档深入探讨检查器的功能和能力。

入门指南

安装与基本用法

检查器无需安装，直接通过npx运行：

npx @modelcontextprotocol/inspector <command>

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

然后按照提示操作。

在本地模式下，检查器默认查找 <current-directory>/mcp-server.py。要指定其他目录或文件，请使用 --directory 和 --file 标志。

注意：需要Node.js 18或更高版本。

从NPM或PyPi检查服务器

这是从NPM或PyPi启动服务器包的常用方法。

NPM

npx -y @modelcontextprotocol/inspector npx <package-name> <args>
## 例如
npx -y @modelcontextprotocol/inspector npx server-postgres postgres://127.0.0.1/testdb

PIPY

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

检查器会自动识别并配置服务器。

检查本地开发的服务器

对于本地开发或作为仓库下载的服务器，常用的检查方法是：

TypeScript

npx @modelcontextprotocol/inspector node path/to/server/index.js args...

Python

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

克隆仓库并运行检查器：

git clone <repository-url>
cd <repository-directory>
npx @modelcontext/inspector

请仔细阅读附带的README文件，获取最准确的说明。

功能概览

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

服务器连接面板

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

资源标签页

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

提示标签页

• 显示可用提示模板。
• 显示提示参数和描述。
• 启用带有自定义参数的提示测试。
• 预览生成的消息。

工具标签页

• 列出可用工具。
• 显示工具模式和描述。
• 启用带有自定义输入的工具测试。
• 显示工具执行结果。

通知面板

• 显示服务器记录的所有日志。
• 显示来自服务器的通知。

最佳实践

开发流程

1. 启动开发
   • 启动检查器并连接到你的服务器。
   • 验证基本连接。
   • 检查功能协商。

1. 迭代测试
   • 修改服务器代码。
   • 重建服务器。
   • 重新连接检查器。
   • 测试受影响的功能。
   • 监控消息传递。

1. 测试边缘情况
   • 输入无效数据。
   • 缺少提示参数。
   • 并发操作。
   • 验证错误处理和错误响应。