跳到主要内容

调试

在开发MCP服务器或将其与应用程序集成时，有效的调试至关重要。本指南涵盖了MCP生态系统中可用的调试工具和方法。

信息

本指南适用于macOS。其他平台的指南即将推出。

调试工具概述

MCP提供了多个不同级别的调试工具：

  1. MCP检查器

  2. Claude Desktop开发者工具

    • 集成测试
    • 日志收集
    • Chrome DevTools集成

  3. 服务器日志记录

    • 自定义日志实现
    • 错误跟踪
    • 性能监控

在Claude Desktop中调试

检查服务器状态

Claude.app界面提供基本的服务器状态信息：

  1. 点击 图标查看：

    • 已连接的服务器
    • 可用的提示和资源

  2. 点击 图标查看：

    • 提供给模型的工具

查看日志

从Claude Desktop查看详细的MCP日志：

# 实时跟踪日志
tail -n 20 -F ~/Library/Logs/Claude/mcp*.log

日志捕获：

  • 服务器连接事件
  • 配置问题
  • 运行时错误
  • 消息交换

使用Chrome DevTools

在Claude Desktop中访问Chrome的开发者工具以调查客户端错误：

  1. 创建developer_settings.json文件，将allowDevTools设置为true：
echo '{"allowDevTools": true}' > ~/Library/Application\ Support/Claude/developer_settings.json
  1. 打开DevTools：Command-Option-Shift-i

注意：您将看到两个DevTools窗口：

  • 主内容窗口
  • 应用标题栏窗口

使用Console面板检查客户端错误。

使用Network面板检查：

  • 消息负载
  • 连接时间

常见问题

工作目录

当使用Claude Desktop的MCP服务器时：

  • 通过claude_desktop_config.json启动的服务器的工作目录可能是未定义的（如macOS上的/），因为Claude Desktop可以从任何位置启动
  • 始终在配置和.env文件中使用绝对路径以确保可靠运行
  • 对于通过命令行直接测试服务器，工作目录将是您运行命令的位置

例如在claude_desktop_config.json中，使用：

{
  "command": "npx",
  "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/username/data"]
}

而不是相对路径如./data

环境变量

MCP服务器仅自动继承部分环境变量，如USER、HOME和PATH。

要覆盖默认变量或提供您自己的变量，可以在claude_desktop_config.json中指定env键：

{
  "myserver": {
    "command": "mcp-server-myapp",
    "env": {
      "MYAPP_API_KEY": "some_key",
    }
  }
}

服务器初始化

常见初始化问题：

  1. 路径问题

    • 服务器可执行文件路径不正确
    • 缺少必需文件
    • 权限问题
    • 尝试为command使用绝对路径

  2. 配置错误

    • JSON语法无效
    • 缺少必需字段
    • 类型不匹配

  3. 环境问题

    • 缺少环境变量
    • 变量值不正确
    • 权限限制

连接问题

当服务器连接失败时：

  1. 检查Claude Desktop日志
  2. 验证服务器进程是否运行
  3. 使用检查器独立测试
  4. 验证协议兼容性

实现日志记录

服务器端日志记录

当构建使用本地stdio传输的服务器时，所有记录到stderr（标准错误）的消息都将被主机应用程序（如Claude Desktop）自动捕获。

注意

本地MCP服务器不应将消息记录到stdout（标准输出），因为这会干扰协议操作。

对于所有传输，您还可以通过发送日志消息通知向客户端提供日志：

server.request_context.session.send_log_message(
  level="info",
  data="Server started successfully",
)

需要记录的重要事件：

  • 初始化步骤
  • 资源访问
  • 工具执行
  • 错误条件
  • 性能指标

客户端日志记录

在客户端应用程序中：

  1. 启用调试日志记录
  2. 监控网络流量
  3. 跟踪消息交换
  4. 记录错误状态

调试工作流程

开发周期

  1. 初始开发

    • 使用检查器进行基本测试
    • 实现核心功能
    • 添加日志点

  2. 集成测试

    • 在Claude Desktop中测试
    • 监控日志
    • 检查错误处理

测试更改

要高效测试更改：

  • 配置更改：重启Claude Desktop
  • 服务器代码更改：使用Command-R重新加载
  • 快速迭代：在开发过程中使用检查器

最佳实践

日志记录策略

  1. 结构化日志记录

    • 使用一致的格式
    • 包含上下文
    • 添加时间戳
    • 跟踪请求ID

  2. 错误处理

    • 记录堆栈跟踪
    • 包含错误上下文
    • 跟踪错误模式
    • 监控恢复

  3. 性能跟踪

    • 记录操作时间
    • 监控资源使用
    • 跟踪消息大小
    • 测量延迟

安全考虑

在调试时：

  1. 敏感数据

    • 清理日志
    • 保护凭据
    • 屏蔽个人信息

  2. 访问控制

    • 验证权限
    • 检查认证
    • 监控访问模式