使用说明

项目简介

Sentry MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 Sentry 的错误监控和项目管理功能集成到支持 MCP 协议的 LLM 应用中。它允许 LLM 客户端通过标准化的方式访问 Sentry 的数据和功能,例如检索项目列表、问题详情、错误事件和 Replays 等,从而增强 LLM 在软件开发和运维领域的应用能力。

主要功能点

  • 项目管理: 支持列出 Sentry 组织下的所有项目,方便 LLM 了解可访问的项目概况。
  • 问题追踪: 允许 LLM 通过问题短ID或问题ID检索 Sentry 中的错误和异常问题详情,辅助问题诊断。
  • 事件分析: 能够获取 Sentry issue 下的特定事件或事件列表,帮助 LLM 深入分析错误事件的上下文信息。
  • Replay 分析: 支持检索和分析 Sentry Replays,用于监控用户会话,识别用户体验问题。
  • 项目创建: 允许 LLM 在 Sentry 中创建新项目,并获取项目 DSN,方便快速集成 Sentry SDK。
  • 错误搜索: 支持根据文件名或文件路径搜索 Sentry 中发生的错误,快速定位代码问题。

安装步骤

  1. 环境准备: 确保您的机器上已安装 Node.js (v14 或更高版本) 和 npm 或 yarn 包管理器。
  2. 下载代码: 从 GitHub 仓库 https://github.com/getsentry/sentry-mcp-stdio 克隆或下载源代码。
  3. 安装依赖: 打开终端,进入代码仓库根目录 'sentry-mcp-stdio',运行命令 'npm install' 或 'yarn install' 安装项目依赖。
  4. 配置 Sentry 认证: 您需要在 Sentry 中创建一个具有 API 访问权限的认证令牌。在 Sentry 用户设置的 Auth Tokens 页面创建令牌后,将其设置为环境变量 'SENTRY_AUTH'。

服务器配置

要将 Sentry MCP 服务器配置到 MCP 客户端,您需要提供服务器的启动命令及其参数。以下是一个示例 JSON 配置,用于配置到支持 MCP 协议的 LLM 客户端(如 Claude):

{
    "mcpServers": {
        "sentry": {
            "command": "npx",
            "args": ["ts-node", "/path/to/sentry-mcp-stdio/index.ts"],
            "env": {
                "SENTRY_AUTH": "<您的 Sentry 认证令牌>"
            }
        }
    }
}
  • 'server name': 'sentry' (服务器名称,可以自定义)
  • 'command': 'npx' (Node.js 包执行器,确保 npm 已正确安装)
  • 'args': '["ts-node", "/path/to/sentry-mcp-stdio/index.ts"]' (启动服务器的命令和参数,'/path/to/sentry-mcp-stdio' 需要替换为您 'sentry-mcp-stdio' 仓库在您本地文件系统中的绝对路径)
  • 'env': '{"SENTRY_AUTH": "<您的 Sentry 认证令牌>"}' (环境变量配置,'SENTRY_AUTH' 用于传递 Sentry 认证令牌,'<您的 Sentry 认证令牌>' 需要替换为您在 Sentry 中生成的认证令牌)

请注意,'/path/to/sentry-mcp-stdio/index.ts' 必须替换为 'index.ts' 文件的实际绝对路径。

基本使用方法

配置完成后,您的 MCP 客户端将能够识别并连接到 Sentry MCP 服务器。您可以通过客户端提供的界面或指令,使用以下工具与 Sentry 进行交互:

  • 'list_projects': 获取 Sentry 项目列表。
  • 'resolve_short_id': 通过问题短ID获取问题详情。
  • 'get_sentry_event': 获取 Sentry 事件详情。
  • 'list_error_events_in_project': 列出项目中的错误事件。
  • 'create_project': 在 Sentry 中创建新项目。
  • 'list_project_issues': 列出项目中的 issues。
  • 'list_issue_events': 列出 issue 下的 events。
  • 'get_sentry_issue': 获取 Sentry issue 详情。
  • 'list_organization_replays': 列出组织下的 Replays。
  • 'setup_sentry': 设置 Sentry 项目并获取 DSN。
  • 'search_errors_in_file': 在指定文件中搜索错误。

使用这些工具时,您需要根据工具的参数描述,提供必要的组织 slug、项目 slug、问题 ID 等信息。具体工具的参数和使用方式请参考仓库 README.md 文件中 “Available Tools” 章节的详细描述。

信息

分类

开发者工具