Backlog MCP Server

Backlog MCP Server

site icon
2025.04.08 3
TypeScript项目管理问题跟踪Wiki管理交流协作
Backlog MCP Server 是一个实现了 Backlog API 集成的 MCP 服务器。它提供了对 Backlog 项目管理平台的核心功能访问,包括项目管理、问题(Issue)管理和 Wiki 管理。通过该服务器,用户可以方便地与 Backlog 平台进行交互,执行各种操作如获取项目信息、管理问题和维护 Wiki。
View on GitHub

Overview

基本能力

产品定位

Backlog MCP Server 是一个中间件服务,旨在简化与 Backlog 项目管理平台的集成和交互。

核心功能

  • 项目管理:获取项目列表和单个项目信息
  • 问题管理:获取、添加、更新和删除问题
  • Wiki 管理:获取、添加、更新和删除 Wiki 页面

适用场景

  • 需要与 Backlog 平台集成的自动化工作流
  • 开发基于 Backlog 的自定义项目管理工具
  • 构建与 Backlog 数据交互的聊天机器人或助手

工具列表

  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_KEY, BACKLOG_SPACE_ID
  7. 可选: BACKLOG_BASE_URL

使用教程

使用依赖

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

安装教程

  1. NPX 方式 bash npx -y backlog-mcp-server 需要在配置文件中设置环境变量

  2. Docker 方式 bash docker run -i --rm -e BACKLOG_API_KEY=YOUR_API_KEY_HERE -e BACKLOG_SPACE_ID=YOUR_SPACE_ID_HERE mcp/backlog

  3. 开发安装 bash npm install npm run build

调试方式

npm run debug

Docker 构建

docker build -t mcp/backlog -f Dockerfile .

许可证

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