检查器指南

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

入门指南

安装和基本使用

Inspector 可以直接通过 npx 运行,无需安装:

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

检查来自 NPM 或 PyPi 的服务器

NPMPyPi 启动服务器包的常用方法。

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

检查本地开发的服务器

要检查本地开发或作为仓库下载的服务器,最常用的方法是:

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

请仔细阅读附带的 README 以获取最准确的使用说明。

功能概述

mcp-inspector

Inspector 提供了多个用于与 MCP 服务器交互的功能:

服务器连接面板

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

资源标签页

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

提示标签页

  • 显示可用的提示模板
  • 显示提示参数和描述
  • 支持使用自定义参数测试提示
  • 预览生成的消息

工具标签页

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

通知面板

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

最佳实践

开发工作流程

  1. 开始开发

    • 启动带有服务器的 Inspector
    • 验证基本连接
    • 检查功能协商
  2. 迭代测试

    • 进行服务器更改
    • 重新构建服务器
    • 重新连接 Inspector
    • 测试受影响的功能
    • 监控消息
  3. 测试边缘情况

    • 无效输入
    • 缺失提示参数
    • 并发操作
    • 验证错误处理和错误响应