返回 MCP 目录
public公开dns本地运行

sentry-mcp

Sentry-MCP是一个远程MCP服务器原型,作为Sentry API的上游中间件,支持远程和标准输入输出传输模式。

article

README

🚀 远程MCP服务器

这是一个远程MCP服务器的原型,它作为上游Sentry API提供商的中间件发挥作用。该项目基于Cloudflare在远程MCP方面的工作构建。

🚀 快速开始

你可以通过访问此链接查看入门指南。

✨ 主要特性

Stdio vs 远程

虽然此仓库主要用于远程MCP使用场景,但我们同样支持stdio传输。

⚠️ 重要提示

目前这是一个草稿,还未通过分发可用。你需要确保你的令牌具有必要的作用域,在撰写本文时为:

org:read project:read project:write team:read team:write event:read

你可以在源代码中找到所需作用域的规范参考。

要启动stdio传输,只需绑定SENTRY_AUTH_TOKEN并运行提供的脚本:

SENTRY_AUTH_TOKEN= npm run start:stdio

自托管Sentry

你可以通过覆盖SENTRY_URL环境变量来设置你自己的Sentry基础URL:

SENTRY_URL=https://sentry.mycompany.com

MCP Inspector

MCP包含一个Inspector,用于轻松测试服务:

pnpm inspector

输入https://[domain].workers.dev/sse(TODO)并点击连接。完成身份验证流程后,你会看到工具正常工作。

从Claude Desktop访问远程MCP服务器

打开Claude Desktop,转到设置,按⌘ + ,(逗号)-> 开发者 -> 编辑配置。这会打开控制Claude可以访问的MCP服务器的配置文件。

用以下配置替换内容。一旦重新启动Claude Desktop,浏览器窗口就会打开显示你的OAuth登录页面。完成身份验证流程以授予Claude对你MCP服务器的访问权限。授予权限后,工具将在界面中显示出来供你使用。

{
  "mcpServers": {
    "math": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://mcp-github-oauth.<your-subdomain>.workers.dev/sse"
      ]
    }
  }
}

一旦工具(在🔨下)显示在界面中,你可以让Claude使用它们。例如:“你能用数学工具将23和19相加吗?” Claude会调用工具并显示由MCP服务器生成的结果。

📦 安装指南

局部开发

如果你希望迭代和测试你的MCP服务器,可以在局部环境中进行。这需要你在Sentry中创建另一个OAuth应用(设置 => API => 应用程序):

  • 对于Homepage URL,请指定http://localhost:8788
  • 对于Authorized Redirect URIs,请指定http://localhost:8788/callback
  • 注意你的Client ID并生成一个Client secret。
  • 在项目根目录中创建一个.dev.vars文件,内容如下:
SENTRY_CLIENT_ID=your_development_sentry_client_id
SENTRY_CLIENT_SECRET=your_development_sentry_client_secret

验证

运行服务器本地以使其在http://localhost:8788可用:

pnpm dev

要测试局部服务器,请在Inspector中输入http://localhost:8788/sse并点击连接。完成提示后,你应该能够“列出工具”。

测试

包含两个测试套件:基本单元测试和一些评估。

单元测试可以使用以下命令运行:

pnpm test

评估需要一个.env文件,其中包含一些配置:

OAUTH_API_KEY=your_oauth_api_key

然后用以下命令运行评估:

pnpm lint

⚠️ 重要提示

评估脚本会检查代码质量和格式问题。

📚 详细文档

其他注意事项

  • 项目使用TypeScript编写,因此请确保安装了Node.js和npm。
  • 使用pnpm进行依赖管理。如果你不熟悉pnpm,请先阅读其文档。
  • 项目包含.gitignore文件,以排除不必要的文件和目录。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端