MCP Sentry 服务器 (Node.js)

这是一个使用 Node.js + TypeScript 实现的 Model Context Protocol (MCP) Sentry 服务器。它提供了与 Sentry 的集成，可以通过 MCP 检索错误报告和堆栈跟踪。

中文文档

功能特性

• 与 Sentry API 集成，用于错误跟踪和监控
• 支持通过 stdin/stdout 的标准 MCP 和 SSE (Server-Sent Events) 传输
• SSE 服务器的可配置端口（默认：3579）

前提条件

• Node.js >= 20.0.0
• pnpm >= 10.5.2

安装

克隆存储库并安装依赖项：

pnpm install

配置

在根目录中创建一个 .env 文件，其中包含您的 Sentry 身份验证令牌：

SENTRY_TOKEN=your_sentry_auth_token_here

您可以从您的 Sentry 帐户设置中获取您的 Sentry 身份验证令牌。

使用

构建项目

pnpm build

运行服务器

pnpm start

或者，您可以将 Sentry 身份验证令牌和 API 基础作为命令行参数指定：

pnpm start --auth-token your_sentry_auth_token_here --api-base your_sentry_api_base_here

运行 SSE 支持

pnpm start:sse

这将在端口 3579（默认）上启动一个带有 SSE 支持的 Express 服务器。您可以访问以下 SSE 端点：

http://localhost:3579/sse

您还可以使用 .env.local 文件自定义环境变量。

开发模式

pnpm dev

MCP 配置

{
  "mcpServers": {
    "sentry-server": {
      "command": "npx",
      "args": ["-y","@weekit/mcp-sentry@1.0.9"],
      "env": {
        "SENTRY_TOKEN": "your_sentry_auth_token_here",
        "SENTRY_API_BASE": "https://your_sentry_api_base_here"
      }
    }
  }
}

使用本地构建：

{
  "mcpServers": {
    "my-sentry": {
      "command": "node",
      "args": ["path/to/dist/index.js"],
      "env": {
        "SENTRY_TOKEN": "your_sentry_auth_token_here",
        "SENTRY_API_BASE": "https://your_sentry_api_base_here"
      }
    }
  }
}

通信协议

MCP Sentry 服务器支持两种通信协议：

1. 标准 MCP 协议: 通过标准输入/输出流进行通信
2. SSE 传输: 用于通过 HTTP 进行基于 Web 的通信的服务器发送事件 (端口 3579)

MCP 功能

MCP Sentry 服务器通过 MCP 协议提供以下功能：

提示词 (Prompts)

• sentry-issue: 通过 ID 或 URL 检索 Sentry 问题
• most-triggered-issue: 从 Sentry 问题列表 URL 中查找影响最多用户的问题

工具 (Tools)

• get_sentry_issue: 通过 ID 或 URL 检索和分析 Sentry 问题
• get_sentry_issues_list: 从 URL 检索和分析 Sentry 问题列表

API

服务器使用 Model Context Protocol 通过标准输入/输出流进行通信，并提供以下功能：

1. 列出可用的提示词和工具
2. 检索 Sentry 问题信息，包括：
   • 问题标题和 ID
   • 状态和严重程度
   • 首次和最后一次看到的时间戳
   • 事件计数
   • 详细的堆栈跟踪

MCP 工作流程

以下是 MCP Sentry 服务器的工作流程图：

flowchart TD
    A[Client/LLM] -->|1. 发送 MCP 请求| B[MCP Sentry 服务器]
    B -->|2. 解析请求类型| C{确定请求类型}

    C -->|提示词请求| D[处理提示词\nsentry-issue]
    C -->|工具请求| E[处理工具\nget_sentry_issue]

    D -->|3. 提取问题 ID| F[调用 Sentry API]
    E -->|3. 提取问题 ID| F

    F -->|4. 获取问题数据| G[Sentry API]
    G -->|5. 返回问题数据| F
    F -->|6. 获取事件数据| G
    G -->|7. 返回事件数据| F

    F -->|8. 解析数据| H[创建 SentryIssueData 对象]
    H -->|9. 格式化数据| I{响应类型}

    I -->|提示词响应| J[转换为 PromptResult 格式]
    I -->|工具响应| K[转换为 ToolResult 格式]

    J -->|10. 返回响应| B
    K -->|10. 返回响应| B

    B -->|11. 发送 MCP 响应| A

测试

运行所有测试：

pnpm test

运行单元测试：

pnpm test test/unit.test.ts

运行集成测试：

pnpm test test/integration.test.ts

查看测试覆盖率：

pnpm test -- --coverage