article
README
🚀 Bugsnag MCP 服务器
Bugsnag MCP 服务器可对应用程序中的错误进行监控与分析,能获取详细的错误信息和上下文,还能跟踪错误的发生频率和趋势,且支持快速设置。
🚀 快速开始
对于大多数用户,推荐使用 npx 运行:
npx bugsnag-mcp-server --key your-bugsnag-api-key
⚠️ 重要提示
请将
your-bugsnag-api-key替换为你的实际 API 密钥。
若需要全局使用,可以执行:
npm install -g bugsnag-mcp-server
✨ 主要特性
- 错误监控与分析
- 监控和分析应用程序中的错误
- 获取详细的错误信息和上下文
- 跟踪错误的发生频率和趋势
- 快速设置
📦 安装指南
获取 Bugsnag API Key
- 访问 Bugsnag 控制台
- 点击右上角的用户头像,选择 "Projects"
- 选择你的项目,进入设置页面
- 在 "Project settings" 中找到 "API keys"
- 创建一个新的 API Key 并保存
安装命令
使用 npx 快速开始
npx bugsnag-mcp-server --key your-bugsnag-api-key
全球安装(可选)
npm install -g bugsnag-mcp-server
💻 使用示例
基础用法
# 列出所有项目
npx bugsnag-mcp-server list-projects --key your-api-key
# 获取指定项目的详细信息
npx bugsnag-mcp-server get-project --project-id project_id --key your-api-key
# 获取错误列表
npx bugsnag-mcp-server list-errors --project-id project_id --key your-api-key
# 查看事件详情
npx bugsnag-mcp-server view-event --event-id event_id --project-id project_id --key your-api-key
高级用法
测试 API 密钥
验证 API 密钥是否有效:
npx bugsnag-mcp-server test-api-key your-bugsnag-api-key
如果密钥有效,将显示你的项目列表。
安装选项
除了 npx,你还可以选择全局安装:
npm install -g bugsnag-mcp-server
开发人员指南
-
克隆仓库:
git clone https://github.com/yourusername/bugsnag-mcp.git cd bugsnag-mcp -
安装依赖:
npm install -
构建项目:
npm run build -
运行测试:
npm test -
生成覆盖率报告:
npm run test:coverage -
格式化代码:
npm run format -
检查格式是否符合要求:
npm run format:check
持续集成
项目使用 GitHub Actions 进行持续集成,配置文件如下:
.github/workflows/test.yml:执行测试.github/workflows/prettier.yml:检查代码格式
📚 详细文档
可用工具
项目管理
list-projects:列出所有项目get-project:获取指定项目的详细信息
错误处理
list-errors:获取指定项目中的错误列表view-error:查看特定错误的详细信息list-error-events:获取某个错误的所有事件view-latest-event:查看最新事件search-errors:根据条件搜索错误
事件查看
view-event:显示具体事件的信息view-stacktrace:提供事件的堆栈跟踪信息view-exception-chain:展示完整的异常链
📄 许可证
本项目采用 MIT 许可证。
扫码联系在线客服