JinDaGe - bugherd-mcp MCP Details

article

README

🚀 BugHerd MCP 服务器

这是一个 MCP（模型上下文协议）服务器，它将 BugHerd 缺陷跟踪系统与人工智能助手集成在一起，为用户提供更高效的缺陷管理体验。

🚀 快速开始

BugHerd MCP 服务器集成了 BugHerd 缺陷跟踪系统和 AI 助手。要使用该服务器，你需要完成安装和配置步骤，以下是详细说明。

✨ 主要特性

全面覆盖 BugHerd API v2，提供涵盖所有资源类型的 38 种工具：

组织管理：获取账户详细信息
用户管理：列出成员、访客、用户任务和项目
项目管理：支持项目的增删改查操作，管理成员和访客
任务管理：提供完整的任务管理功能，包括反馈、存档和任务板视图
列管理：自定义看板管理
评论管理：读取和创建评论
附件管理：管理文件附件
Webhook 配置：配置事件通知

📦 安装指南

前提条件

Node.js 18 及以上版本或 Bun
拥有具备 API 访问权限的 BugHerd 账户
BugHerd API 密钥（可从“设置”>“常规设置”中获取）

安装步骤

克隆仓库：

git clone https://github.com/berckan/bugherd-mcp.git
cd bugherd-mcp

安装依赖：

bun install
# 或者
npm install

构建服务器：

bun run build
# 或者
npm run build

设置 API 密钥：

export BUGHERD_API_KEY=your-api-key-here

📚 详细文档

配置说明

CLI 配置

将以下内容添加到你的 MCP 客户端配置中：

{
  "mcpServers": {
    "bugherd": {
      "type": "stdio",
      "command": "node",
      "args": ["/path/to/bugherd-mcp/dist/index.js"],
      "env": {
        "BUGHERD_API_KEY": "your-api-key-here"
      }
    }
  }
}

桌面应用配置

将以下内容添加到你的 MCP 桌面应用配置中：

{
  "mcpServers": {
    "bugherd": {
      "command": "node",
      "args": ["/path/to/bugherd-mcp/dist/index.js"],
      "env": {
        "BUGHERD_API_KEY": "your-api-key-here"
      }
    }
  }
}

可用工具（37 种）

组织管理

| 工具 | 描述 | | ---- | ---- | | bugherd_get_organization | 获取组织/账户详细信息 |

用户管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_users | 列出所有用户（成员 + 访客） | | bugherd_list_members | 仅列出团队成员 | | bugherd_list_guests | 仅列出访客/客户 | | bugherd_get_user_tasks | 获取分配给用户的任务 | | bugherd_get_user_projects | 获取用户的项目 |

项目管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_projects | 列出所有项目 | | bugherd_list_active_projects | 仅列出活跃项目 | | bugherd_get_project | 获取项目详细信息 | | bugherd_create_project | 创建新项目 | | bugherd_update_project | 更新项目设置 | | bugherd_delete_project | ⚠️ 永久删除项目 | | bugherd_add_member | 向项目中添加成员 | | bugherd_add_guest | 向项目中添加访客 |

任务管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_tasks | 根据过滤器（状态、优先级、标签）列出任务 | | bugherd_list_feedback_tasks | 列出未处理的反馈任务 | | bugherd_list_archived_tasks | 列出存档任务 | | bugherd_list_taskboard_tasks | 列出任务板任务 | | bugherd_get_task | 获取带有元数据的任务详细信息 | | bugherd_get_task_global | 通过全局 ID 获取任务 | | bugherd_get_task_by_local_id | 通过本地 ID（#123）获取任务 | | bugherd_create_task | 创建新任务 | | bugherd_move_tasks | 在项目之间移动任务 | | bugherd_update_task | 更新任务状态/优先级/描述/负责人 |

列管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_columns | 列出项目列（看板状态） | | bugherd_get_column | 获取列详细信息 | | bugherd_create_column | 创建新列 | | bugherd_update_column | 更新列名称/位置 |

评论管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_comments | 列出任务上的评论 | | bugherd_create_comment | 向任务添加评论 |

附件管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_attachments | 列出任务附件 | | bugherd_get_attachment | 获取附件详细信息 | | bugherd_create_attachment | 从 URL 创建附件 | | bugherd_delete_attachment | ⚠️ 删除附件 |

Webhook 管理

| 工具 | 描述 | | ---- | ---- | | bugherd_list_webhooks | 列出已配置的 Webhook | | bugherd_create_webhook | 创建 Webhook | | bugherd_delete_webhook | ⚠️ 删除 Webhook |

💻 使用示例

列出项目和任务

列出我的 BugHerd 项目
显示项目 12345 中的所有关键缺陷

创建和管理任务

在项目 12345 中创建任务：“修复登录按钮对齐问题”
将任务 678 从项目 12345 移动到项目 67890
将任务 678 的状态更新为“已完成”

处理评论

显示项目 12345 中任务 678 的评论
向任务 678 添加评论：“在最新部署中已修复”

管理 Webhook

列出所有 Webhook
为 task_create 事件创建一个指向 https://example.com/webhook 的 Webhook

🔧 技术细节

开发模式运行

bun run dev

使用 MCP 检查器进行测试

BUGHERD_API_KEY=xxx bun run inspector

生产环境构建

bun run build

API 速率限制

BugHerd 允许平均每分钟 60 个请求，短时间内最多可连续发送 10 个请求。服务器能够优雅地处理速率限制错误。

📄 许可证

本项目采用 MIT 许可证。

👨‍💻 作者

Berckan Guerrero (hi@berck.io)

🤝 贡献

欢迎贡献代码！请提交问题或拉取请求。

bugherd-mcp