Instabug MCP Server

Instabug MCP服务器

一个模型上下文协议（MCP）服务器，为人工智能助手提供强大的工具，与Instabug的错误报告、崩溃分析和用户反馈系统进行交互。

特性

此MCP服务器提供以下功能：

🐛 缺陷管理

• get_bugs -通过按状态、优先级或标签进行筛选来检索错误
• get_bug_details -获取有关特定错误的详细信息
• update_bug_status -更改错误状态并添加注释
• create_bug_report -创建带有任务的新错误报告

💥 崩溃分析

• get_crashes -使用筛选选项检索崩溃报告
• get_crash_details -获取详细的碰撞信息和堆栈跟踪

📝 用户反馈

• get_user_反馈 -访问用户评级和反馈意见

📊 分析

• get_app_分析 -检索应用程序使用统计数据和性能指标

先决条件

• Node.js 18或更高版本
• API访问帐户不稳定
• 不稳定仪表板中的API令牌

安装

1. 克隆此存储库：

git clone 
cd instabug-mcp-server

1. 安装依赖项：

npm install

1. 设置环境变量：

cp .env.example .env

1. 编辑 .env 使用您的Instabug凭据文件：

INSTABUG_API_TOKEN=your_instabug_api_token_here
INSTABUG_APP_TOKEN=your_instabug_app_token_here
LOG_LEVEL=info

获取您的不稳定API令牌

1. 登录您的 Instabug仪表板
2. 引导到 设置 > API
3. 生成或复制您的 API代币
4. 复制您的 应用令牌 从应用程序设置

用法

构建服务器

npm run build

运行服务器

npm start

发展模式

npm run dev

监视模式（自动重建）

npm run watch

MCP客户端配置

要将此服务器与Claude Desktop或其他MCP客户端一起使用，请将以下内容添加到您的客户端配置中：

适用于克劳德桌面

添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "instabug": {
      "command": "node",
      "args": ["/path/to/instabug-mcp-server/build/index.js"]
    }
  }
}

用于开发（使用npm脚本）

{
  "mcpServers": {
    "instabug": {
      "command": "npm",
      "args": ["run", "dev"],
      "cwd": "/path/to/instabug-mcp-server"
    }
  }
}

可用工具

缺陷管理

get_bugs

使用可选过滤从Instabug中检索错误。

参数：

• limit （number，可选）：要检索的错误数（默认值：20，最大值：100）
• status （字符串，可选）：按状态筛选（打开、已解决、已关闭、in_progress）
• priority （字符串，可选）：按优先级筛选（低、中、高、严重）
• tag （字符串，可选）：按标记名称筛选

get_bug_details

获取有关特定错误的详细信息。

参数：

• bug_id （string，必填）：要检索的bug的ID

update_bug_status

更新bug的状态。

参数：

• bug_id （string，必填）：要更新的bug的ID
• status （string，必填）：新状态（打开、已解决、已关闭、in_progress）
• comment （string，可选）：状态更改的可选注释

create_bug_report

在Instabug中创建新的bug报告。

参数：

• title （string，必填）：错误报告的标题
• description （string，必填）：错误的详细描述
• priority （字符串，可选）：优先级（低、中、高、严重）
• tags （数组，可选）：用于对bug进行分类的标签
• assignee_email （字符串，可选）：要分配的人的电子邮件

崩溃分析

get_crashes

使用可选筛选检索碰撞报告。

参数：

• limit （number，可选）：要检索的崩溃次数（默认值：20，最大值：100）
• app_version （字符串，可选）：按应用程序版本筛选
• os_version （字符串，可选）：按操作系统版本筛选
• device_model （字符串，可选）：按设备型号筛选

get_crash_details

获取有关特定碰撞的详细信息。

参数：

• crash_id （string，必填）：要检索的崩溃ID

用户反馈

get_user_反馈

检索用户反馈和评分。

参数：

• limit （数字，可选）：反馈项目数（默认值：20，最大值：100）
• rating （数字，可选）：按等级过滤（1-5）
• has_comment （布尔值，可选）：过滤带有评论的反馈

分析

get_app_分析

获取应用程序分析和使用统计数据。

参数：

• metric （string，必填）：度量类型（会话、崩溃、错误、用户反馈、性能）
• start_date （字符串，可选）：开始日期（YYYY-MM-DD）
• end_date （字符串，可选）：结束日期（YYYY-MM-DD）

查询示例

以下是一些可用于此MCP服务器的示例查询：

Bug管理示例

• “显示当前打开的所有关键错误”
• “获取错误ID 12345的详细信息”
• “将错误12345状态更新为已解决，并添加注释‘已在最新版本中修复’”
• “为高优先级的登录问题创建新的错误报告”

崩溃分析示例

• “显示iOS 15.0版本的最新崩溃”
• “获取碰撞ID 67890的碰撞详细信息”
• “显示iPhone 13型号的崩溃情况”

用户反馈示例

• “显示所有带评论的1星评级”
• “获取最近的用户反馈”

分析示例

• “显示过去30天的崩溃分析”
• “获取2024年1月1日至2024年01月31日的会话分析”

发展

项目结构

src/
├── index.ts          # Main server implementation
├── types/            # TypeScript type definitions
└── utils/            # Utility functions

.vscode/
├── mcp.json          # MCP server configuration for debugging
└── settings.json     # VS Code settings

build/                # Compiled JavaScript output

VS代码调试

此项目包括用于调试MCP服务器的VS代码配置：

1. 在VS Code中打开项目
2. 出现提示时安装推荐的扩展
3. 使用VS Code提供的MCP调试功能

添加新工具

要添加新工具，请执行以下操作：

1. 在中添加工具定义 ListToolsRequestSchema 处理器
2. 在中添加工具实现 CallToolRequestSchema 处理器
3. 在中创建相应的方法 InstabugMCPServer 类
4. 使用新的工具文档更新此README

故障排除

常见问题

1. 身份验证错误：验证您的API令牌是否正确并具有必要的权限
2. 网络超时：检查您的互联网连接和不稳定API状态
3. 速率限制：不稳定可能限制API请求的速率；服务器包括用于暂时故障的重试逻辑

调试日志记录

集 LOG_LEVEL=debug 在你的 .env 文件以获取更详细的日志记录。

测试服务器

您可以使用MCP检查器测试服务器：

npx @modelcontextprotocol/inspector npm run dev

API费率限制

请注意不稳定的API速率限制：

• 遵守Stabulug API文档中规定的速率限制
• 服务器对速率限制响应实施了适当的错误处理
• 考虑缓存频繁访问的数据的响应

安全考虑

• 保持API令牌的安全，并且永远不要将其提交给版本控制
• 对所有敏感配置使用环境变量
• 定期轮换您的API代币
• 监控API的使用情况以发现任何异常活动

贡献

1. 分叉存储库
2. 创建要素分支
3. 进行更改
4. 如果适用，添加测试
5. 提交拉取请求

许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

支持

关于以下问题：

• 此MCP服务器：在此存储库中打开一个问题
• API不稳定：联系方式 Instabug支持
• MCP协议：参观 模型上下文协议文档