Sentry MCP Server 使用说明

项目简介

Sentry MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当 LLM 客户端与 Sentry 错误监控平台之间的桥梁。此服务器提供了一系列工具,使 LLM 能够以标准化的方式访问和操作 Sentry 的数据和功能,例如检索错误信息、管理 Sentry 项目、监控应用性能等。通过此 MCP 服务器,LLM 可以更智能地理解和处理软件开发过程中的错误和异常。

主要功能点

  • 项目管理: 支持列出用户可访问的 Sentry 项目,包括项目名称、ID、Slug、平台、团队和功能特性等详细信息,并支持创建新的 Sentry 项目。
  • 问题管理: 允许 LLM 检索 Sentry 问题的详细信息,包括问题标题、状态、等级、首次和最后一次发生时间、事件计数、用户计数、责任人等,并能列出与特定问题相关的事件。
  • 事件分析: 能够获取和分析 Sentry 事件的详细信息,包括事件标题、平台、创建和接收时间、标签、用户信息、请求信息、上下文信息等,帮助 LLM 深入了解错误事件的上下文。
  • Replay 会话: 支持列出 Sentry 组织的 Replay 会话,允许 LLM 监控用户会话、交互行为、错误发生情况等,辅助分析用户体验问题。
  • 错误搜索: 提供根据文件名或文件路径在 Sentry 项目中搜索错误的功能,帮助 LLM 快速定位特定代码文件相关的错误。
  • Sentry 项目设置: 支持为新项目配置 Sentry SDK,并返回 DSN(数据源名称)和安装指南,方便 LLM 引导用户快速集成 Sentry。

安装步骤

  1. 前提条件: 确保你的开发环境中已安装 Node.js (v14 或更高版本) 和 npm 或 yarn 包管理器。
  2. 克隆仓库: 使用 Git 将 'mcp-sentry-ts' 仓库克隆到本地:
    git clone https://github.com/codyde/mcp-sentry-ts.git
  3. 进入目录: 导航到克隆下来的仓库目录:
    cd mcp-sentry-ts
  4. 安装依赖: 使用 npm 或 yarn 安装项目依赖:
    npm install

服务器配置

要将此 MCP 服务器与 MCP 客户端(如 Claude)连接,需要在客户端配置中指定服务器的启动命令和参数。以下是一个 Claude 客户端的配置示例,你需要根据你的实际环境进行调整:

{
    "mcpServers": {
        "sentry": {
            "command": "npx",
            "args": ["ts-node", "/path/to/mcp-sentry-ts/index.ts"],
            // "args" 字段指定了服务器启动的参数,这里需要将 "/path/to/mcp-sentry-ts" 替换为你的本地仓库绝对路径。
            // 例如,如果你的仓库在 "/Users/your-user/Documents/mcp-sentry-ts",则应修改为:
            // "args": ["ts-node", "/Users/your-user/Documents/mcp-sentry-ts/index.ts"],
            "env": {
                "SENTRY_AUTH": "<YOUR_SENTRY_AUTH_TOKEN>"
                // "env" 字段设置环境变量,"SENTRY_AUTH" 用于配置 Sentry 认证 Token。
                // 你需要将 "<YOUR_SENTRY_AUTH_TOKEN>" 替换为你自己的 Sentry 认证 Token。
                // 可以在 Sentry 账户设置的 "API Keys" 中生成 Token,并确保该 Token 具有访问 Sentry API 的适当权限。
            }
        }
    }
}

注意:

  • 请务必将 '/path/to/mcp-sentry-ts/index.ts' 替换为 'index.ts' 文件在你本地文件系统中的绝对路径
  • 将 '<YOUR_SENTRY_AUTH_TOKEN>' 替换为你在 Sentry 平台生成的认证 Token

基本使用方法

配置完成后,MCP 客户端将能够识别名为 "sentry" 的 MCP 服务器。你可以通过客户端提供的界面或指令,调用此服务器提供的各种工具,例如:

  • 使用 'list_projects' 工具列出 Sentry 项目。
  • 使用 'resolve_short_id' 工具解析 Sentry 短 ID 并获取问题详情。
  • 使用 'get_sentry_event' 工具获取指定 Sentry 事件的详细信息。
  • 使用 'create_project' 工具在 Sentry 中创建新项目。
  • 使用 'list_organization_replays' 工具列出 Replay 会话等。

具体工具的使用方法和参数,请参考仓库 'README.md' 文件中 “Available Tools” 部分的详细说明。 在 LLM 交互中,你可以指示 LLM 使用这些工具来完成与 Sentry 相关的任务,例如查询错误、分析性能问题、创建监控项目等。

信息

分类

开发者工具