Backlog MCP Server

基本能力

产品定位

Backlog MCP Server 是一个用于与 Backlog API 交互的模型上下文协议（MCP）服务器，旨在通过 AI 代理（如 Claude Desktop、Cline、Cursor 等）提供管理 Backlog 中的项目、问题、Wiki 页面等功能。

核心功能

• 项目管理（创建、读取、更新、删除）
• 问题跟踪（创建、更新、删除、列表）
• Wiki 页面管理
• Git 仓库管理
• 拉取请求管理（创建、更新、列表、评论）
• 通知管理
• 关注列表管理
• GraphQL 风格的字段选择以优化响应
• 大响应的令牌限制
• 增强的错误处理
• 更多 Backlog API 集成

适用场景

• 团队项目管理
• 问题跟踪与解决
• Wiki 文档协作
• Git 仓库与拉取请求管理
• 通知与关注列表管理

工具列表

Space Tools

• get_space: 返回 Backlog 空间的信息
• get_users: 返回 Backlog 空间中的用户列表
• get_myself: 返回认证用户的信息
• get_priorities: 返回优先级列表
• get_resolutions: 返回问题解决列表
• get_issue_types: 返回项目的议题类型列表

Project Tools

• get_project_list: 返回项目列表
• add_project: 创建新项目
• get_project: 返回特定项目的信息
• update_project: 更新现有项目
• delete_project: 删除项目

Issue Tools

• get_issue: 返回特定问题的信息
• get_issues: 返回问题列表
• count_issues: 返回问题计数
• add_issue: 在指定项目中创建新问题
• update_issue: 更新现有问题
• delete_issue: 删除问题

Comment Tools

• get_issue_comments: 返回问题的评论列表
• add_issue_comment: 向问题添加评论

Wiki Tools

• get_wiki_pages: 返回 Wiki 页面列表
• get_wikis_count: 返回项目中的 Wiki 页面计数
• get_wiki: 返回特定 Wiki 页面的信息
• add_wiki: 创建新 Wiki 页面

Category Tools

• get_categories: 返回项目的类别列表

Notification Tools

• get_notifications: 返回通知列表
• count_notifications: 返回通知计数
• reset_unread_notification_count: 重置未读通知计数
• mark_notification_as_read: 将通知标记为已读

Git Repository Tools

• get_git_repositories: 返回项目的 Git 仓库列表
• get_git_repository: 返回特定 Git 仓库的信息

Pull Request Tools

• get_pull_requests: 返回仓库的拉取请求列表
• get_pull_requests_count: 返回仓库的拉取请求计数
• get_pull_request: 返回特定拉取请求的信息
• add_pull_request: 创建新拉取请求
• update_pull_request: 更新现有拉取请求
• get_pull_request_comments: 返回拉取请求的评论列表
• add_pull_request_comment: 向拉取请求添加评论
• update_pull_request_comment: 更新拉取请求的评论

Watching Tools

• get_watching_list_items: 返回用户的关注项列表
• get_watching_list_count: 返回用户的关注项计数

常见问题解答

1. 如何确保使用最新的 Docker 镜像？

2. 使用 --pull always 标志或手动运行 docker pull ghcr.io/nulab/backlog-mcp-server:latest。

3. 如何优化响应大小？

4. 启用 OPTIMIZE_RESPONSE 并使用 GraphQL 风格的字段选择。

5. 如何覆盖工具描述？

6. 通过环境变量或创建 .backlog-mcp-serverrc.json 文件。

使用教程

使用依赖

• Docker
• 具有 API 访问权限的 Backlog 账户
• 从 Backlog 账户获取的 API 密钥

安装教程

选项 1：通过 Docker 安装

1. 打开 Claude Desktop 或 Cline 设置
2. 导航到 MCP 配置部分
3. 添加以下配置：

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "BACKLOG_DOMAIN",
        "-e", "BACKLOG_API_KEY",
        "ghcr.io/nulab/backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

高级配置选项

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "BACKLOG_DOMAIN",
        "-e", "BACKLOG_API_KEY",
        "-e", "MAX_TOKENS",
        "-e", "OPTIMIZE_RESPONSE",
        "ghcr.io/nulab/backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key",
        "MAX_TOKENS": "10000",
        "OPTIMIZE_RESPONSE": "true"
      }
    }
  }
}

选项 2：手动安装

1. 克隆仓库：

git clone https://github.com/nulab/backlog-mcp-server.git
cd backlog-mcp-server

1. 安装依赖：

npm install

1. 构建项目：

npm run build

1. 设置 JSON 以使用 MCP：

{
  "mcpServers": {
    "backlog": {
      "command": "node",
      "args": [
        "your-repository-location/build/index.js"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

调试方式

1. 运行测试：

npm test

1. 导出当前翻译：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server node build/index.js --export-translations

1. 使用命令行选项：

node build/index.js --optimize-response --max-tokens=100000

许可证

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