article
README
🚀 MCP 哨兵服务器(Node.js)
这是一个基于 Node.js 和 TypeScript 实现的 Model Context Protocol (MCP) 哨兵服务器。它能与 Sentry 集成,通过 MCP 获取错误报告和堆栈跟踪,助力开发者高效处理错误。
🚀 快速开始
先决条件
- Node.js >= 20.0.0
- pnpm >= 10.5.2
安装与配置
- 克隆仓库并安装依赖
pnpm install - 配置 Sentry 认证令牌
在根目录创建一个
.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
这将启动一个 Express 服务器,带有 SSE 支持,默认端口为 3579。你可以通过以下地址访问 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"
}
}
}
}
✨ 主要特性
- 与 Sentry API 集成,支持错误跟踪和监控。
- 支持标准 MCP 协议(stdin/stdout)和 SSE(服务器发送事件)传输。
- 可配置的 SSE 服务器端口(默认:3579)。
📦 安装指南
克隆仓库并安装依赖:
pnpm install
💻 使用示例
基础用法
构建项目:
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
使用 .env.local 文件自定义环境变量。
MCP 配置使用本地构建:
{
"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"
}
}
}
}
微信扫一扫