使用说明

项目简介

'mcp-sentry' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 AI 助手提供访问和分析 Sentry 错误跟踪平台数据的能力。通过此服务器,AI 助手可以检索 Sentry 中记录的错误报告、堆栈跟踪和其他调试信息,帮助开发人员更有效地理解和解决应用程序中的问题。

主要功能点

  • 检索 Sentry Issue 信息: 通过 issue ID 或 URL 从 Sentry 获取详细的错误报告信息,包括标题、状态、级别、首次/最后出现时间、事件计数和完整的堆栈跟踪。
  • 提供结构化上下文: 将 Sentry issue 信息格式化为易于 AI 助手理解和利用的文本内容,作为对话上下文的一部分。
  • 工具 (Tools):
    • 'get_sentry_issue': 允许 AI 助手通过 issue ID 或 URL 检索并分析 Sentry issue。
  • Prompt 模板 (Prompts):
    • 'sentry-issue': 用于从 Sentry 检索 issue 详细信息,并将其格式化为对话上下文。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js 14 或更高版本。
  2. 安装 mcp-sentry: 使用 npm 全局安装 'mcp-sentry' 包:
    npm install -g mcp-sentry

服务器配置

为了让 MCP 客户端(例如 Claude Desktop, Zed)连接到 'mcp-sentry' 服务器,你需要配置客户端的 MCP 服务器设置。以下是针对不同客户端的配置示例:

Claude Desktop 配置:

在 Claude Desktop 的配置文件中,添加以下 JSON 配置到 '"mcpServers"' 字段:

"mcpServers": {
  "sentry": {  // server name,可以自定义,例如 "sentry"
    "command": "mcp-sentry", // MCP 服务器的启动命令
    "args": ["--auth-token", "YOUR_SENTRY_TOKEN"] // 启动命令的参数,--auth-token 用于指定 Sentry 认证 Token,请替换为你的 Sentry Token
  }
}

Zed 配置:

在 Zed 的 'settings.json' 文件中,添加以下 JSON 配置到 '"context_servers"' 字段:

"context_servers": [
  "mcp-server-sentry": {  // server name,可以自定义,例如 "mcp-server-sentry"
    "command": {
      "path": "mcp-sentry", // MCP 服务器的启动命令路径
      "args": ["--auth-token", "YOUR_SENTRY_TOKEN"] // 启动命令的参数,--auth-token 用于指定 Sentry 认证 Token,请替换为你的 Sentry Token
    }
  }
],

注意:

  • 'YOUR_SENTRY_TOKEN' 需要替换为你自己的 Sentry 认证 Token。你可以在 Sentry 后台的 "组织设置 -> API 密钥" 中创建或找到你的 Token。
  • 你可以选择通过环境变量 'SENTRY_TOKEN' 或命令行参数 '--auth-token' 提供 Sentry 认证 Token。

基本使用方法

  1. 启动 MCP 服务器: 根据上述配置,MCP 客户端会在需要时自动启动 'mcp-sentry' 服务器。你也可以手动在终端运行以下命令启动服务器:

    mcp-sentry --auth-token YOUR_SENTRY_TOKEN
  2. 在 MCP 客户端中使用: 在支持 MCP 的 AI 客户端中(如 Claude Desktop, Zed),你可以指示 AI 助手使用 'get_sentry_issue' 工具或 'sentry-issue' prompt 来查询 Sentry 中的错误信息。例如,你可以向 AI 助手提问:

    • "请使用 'get_sentry_issue' 工具分析这个 Sentry issue: '<Sentry Issue URL 或 Issue ID>'"
    • "你能帮我查看一下 Sentry 中 ID 为 '<Issue ID>' 的错误报告吗?"
    • "使用 'sentry-issue' prompt 获取 '<Sentry Issue URL>' 的详细信息"

    AI 助手会调用 'mcp-sentry' 服务器提供的工具或 prompt,并将返回的 Sentry issue 信息作为上下文用于后续的对话和分析。

信息

分类

开发者工具