Backlog MCP Server

Backlog MCP Server

site icon
2025.04.17 0
TypeScript项目管理问题跟踪协作平台交流协作
Backlog MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于与 Backlog API 进行交互。该服务通过 Claude 提供管理 Backlog 中的项目、问题、Wiki 页面等功能。
View on GitHub

Overview

基本能力

产品定位

Backlog MCP Server 是一个用于与 Backlog API 交互的中间件服务,旨在通过 Claude 提供对 Backlog 平台的项目管理、问题跟踪、Wiki 管理等功能的便捷访问。

核心功能

  • 项目管理(创建、读取、更新、删除)
  • 问题跟踪(创建、更新、删除、列表)
  • Wiki 页面管理
  • Git 仓库管理
  • 拉取请求管理(创建、更新、列表、评论)
  • 通知管理
  • 关注列表管理
  • 其他 Backlog API 集成

适用场景

  • 团队协作项目管理
  • 软件开发问题跟踪
  • 文档协作编辑
  • 代码审查管理
  • 项目通知订阅

工具列表

项目工具

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

问题工具

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

评论工具

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

Wiki 工具

  • get_wiki_pages: 返回 Wiki 页面列表
  • get_wikis_count: 返回项目中 Wiki 页面计数
  • get_wiki: 返回特定 Wiki 页面信息
  • get_categories: 返回项目类别列表

通知工具

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

Git 仓库工具

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

拉取请求工具

  • 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: 更新拉取请求的评论

关注工具

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

常见问题解答

无明确常见问题解答部分

使用教程

使用依赖

  • Node.js (v16 或更高版本)
  • 具有 API 访问权限的 Backlog 账户
  • 从 Backlog 账户获取的 API 密钥

安装教程

选项 1: 通过 npx 安装

  1. 打开 Claude 设置
  2. 导航到 MCP 配置部分
  3. 添加以下配置:
{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": [
        "-y",
        "github:trknhr/backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

选项 2: 手动安装

  1. 克隆仓库:
git clone https://github.com/trknhr/backlog-mcp-server.git
cd backlog-mcp-server
  1. 安装依赖:
npm install
  1. 构建项目:
npm run build
  1. 创建 .env 文件:
BACKLOG_DOMAIN=your-domain.backlog.com
BACKLOG_API_KEY=your-api-key
  1. 启动服务器:
npm start

调试方式

运行测试:

npm test

添加新工具: 1. 在 src/tools/ 中创建新文件 2. 创建对应的测试文件 3. 将新工具添加到 src/tools/tools.ts 4. 构建并测试更改

许可证

该项目遵循 MIT 开源许可条款。