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

快速上手

安装和基本用法

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

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

检查来自 NPM 或 PyPi 的服务器

一种常见的启动服务器包的方式是使用 NPMPyPi

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 服务器交互的功能:

Server 连接面板

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

Resources 标签页

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

Prompts 标签页

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

Tools 标签页

  • 列出可用的 tools
  • 显示 tool 模式和描述
  • 启用使用自定义输入的 tool 测试
  • 显示 tool 执行结果

Notifications 面板

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

最佳实践

开发工作流程

  1. 开始开发

    • 使用你的服务器启动 Inspector
    • 验证基本连接
    • 检查能力协商
  2. 迭代测试

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

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

下一步