JinDaGe - backlog-mcp-qsd MCP Details

article

README

🚀 Backlog MCP 服务器

Backlog MCP 服务器是为 Backlog 接口提供支持的消息通信代理（MCP，Message Communication Proxy）服务器，它能助力用户高效管理项目、任务等，提升工作效率。

✨ 主要特性

支持功能

项目管理：可轻松获取项目相关信息。
任务管理：能对任务进行创建、更新、删除等操作。
搜索功能：可依据条件筛选任务。
状态管理：能处理项目状态相关操作。
用户信息：可获取用户资料。

支持的 Backlog 版本

Standard Plan
Professional Plan

📚 详细文档

工具说明

项目相关工具

getSpaces

功能：取得可用的空间（项目）列表。
输入：无。
输出：返回包含空间信息的数据结构。

getProjects

功能：获取特定空间内的所有项目。
输入：指定空间 ID 或名称。
输出：返回对应空间下的项目列表。

任务相关工具

createIssue

功能：创建新任务。
输入：任务标题、内容、优先级等参数。
输出：返回新建任务的详细信息。

updateIssue

功能：更新现有任务的信息。
输入：任务 ID 与需要修改的字段。
输出：返回更新后的任务详情。

deleteIssue

功能：删除指定任务。
输入：任务 ID。
输出：确认删除成功状态。

搜索相关工具

searchIssues

功能：根据条件搜索任务。
输入：关键词、项目 ID、状态 ID、指派者 ID 等筛选条件。
输出：返回符合筛选条件的任务列表。

📦 安装指南

环境变量配置

在 .env 文件中添加以下内容：

BACKLOG_DOMAIN=your-domain.backlog.com
BACKLOG_API_KEY=your-api-key

# 测试环境配置（可选）
TEST_PROJECT_ID=your-test-project-id
TEST_PROJECT_KEY=your-test-project-key

在 Claude Desktop 中使用

将以下配置添加到 claude_desktop_config.json 文件：

使用 NPX 的情况

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": ["-y", "@tmhr1850/backlog-mcp-server"],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

💻 使用示例

本地运行指令

# 执行构建
npm run build

# 启动服务
npm start

测试指令

# 运行所有测试
npm test

# 启动监视模式进行测试
npm run test:watch

# 带覆盖率报告的测试运行
npm run test:coverage

📄 许可证

此 MCP 服务器基于 MIT 许可证发布。详细许可信息请参阅项目仓库中的 LICENSE 文件。

backlog-mcp-qsd