Backlog MCP Server

Backlog MCP Server

site icon
2025.05.08 0
TypeScript项目管理团队协作问题跟踪文档管理交流协作
Backlog MCP Server 是一个实现了 Backlog API 集成的 MCP 服务器。它提供了项目管理、问题跟踪和 Wiki 管理的功能,适用于团队协作和项目管理场景。
View on GitHub

Overview

基本能力

产品定位

Backlog MCP Server 是一个集成了 Backlog API 的 MCP 服务器,主要用于项目管理和团队协作。

核心功能

  1. 项目管理
  2. 获取项目列表(支持分页和过滤)
  3. 获取单个项目详情(通过项目 ID 或 key)

  4. 问题跟踪

  5. 获取问题列表(支持分页和过滤)
  6. 获取单个问题详情(通过问题 ID 或 key)
  7. 添加、更新和删除问题

  8. Wiki 管理

  9. 获取 Wiki 列表(支持关键词搜索)
  10. 获取单个 Wiki 详情(通过 Wiki ID 或 key)
  11. 添加、更新和删除 Wiki

适用场景

  • 团队项目管理
  • 问题跟踪和解决
  • 文档协作和知识管理

工具列表

  1. Project API
  2. backlog_get_projects:获取项目列表
  3. backlog_get_project:获取单个项目详情

  4. Issue API

  5. backlog_get_issues:获取问题列表
  6. backlog_get_issue:获取单个问题详情
  7. backlog_add_issue:添加问题
  8. backlog_update_issue:更新问题
  9. backlog_delete_issue:删除问题

  10. Wiki API

  11. backlog_get_wikis:获取 Wiki 列表
  12. backlog_get_wiki:获取单个 Wiki 详情
  13. backlog_add_wiki:添加 Wiki
  14. backlog_update_wiki:更新 Wiki
  15. backlog_delete_wiki:删除 Wiki

常见问题解答

  1. 如何获取 API Key
  2. 注册 Backlog 账号
  3. 选择计划(有免费计划可用)
  4. 从个人设置中生成 API Key

  5. 环境变量配置

  6. 必须配置 BACKLOG_API_KEYBACKLOG_SPACE_ID
  7. 可选配置 BACKLOG_BASE_URL(默认为 https://{your-space-id}.backlog.com/api/v2

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 确保已安装 Docker(如果使用 Docker 方式运行)

安装教程

  1. 使用 npm 安装bash npm install

  2. 使用 Docker 构建bash docker build -t mcp/backlog -f Dockerfile .

  3. 配置 Claude Desktop

  4. 将以下配置添加到 claude_desktop_config.json 中:
    • NPX 方式json { "mcpServers": { "backlog": { "command": "npx", "args": [ "-y", "backlog-mcp-server" ], "env": { "BACKLOG_API_KEY": "YOUR_API_KEY_HERE", "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE" } } } }
    • Docker 方式json { "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "BACKLOG_API_KEY=YOUR_API_KEY_HERE", "-e", "BACKLOG_SPACE_ID=YOUR_SPACE_ID_HERE", "mcp/backlog" ], "env": { "BACKLOG_API_KEY": "YOUR_API_KEY_HERE", "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE" } } } }

调试方式

  1. 构建项目bash npm run build

  2. 调试运行bash npm run debug

  3. 运行测试: (待实现)

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。