tmhr1850_backlog-mcp-server

🚀 Backlog MCP 服务器

Backlog MCP 服务器可提供对 Backlog API 的访问，实现项目管理、任务跟踪、文件操作等功能，助力高效的项目协作与管理。

🚀 快速开始

要使用 Backlog MCP 服务器，需先获取 API 密钥并进行环境变量配置。具体步骤如下：

API 密钥获取步骤

1. 登录 Backlog 网站。
2. 进入个人设置 > API > 发布新的 API 密钥。
3. 复制生成的 API 密钥。

环境变量配置

在 .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

✨ 主要特性

• 项目管理：可获取项目列表、查看项目详细信息。
• 任务管理：支持创建新任务、更新现有任务、搜索任务、添加评论。
• 用户管理：能够获取用户信息。
• 文件操作：可管理附件文件。
• 评论功能：可在任务中添加评论。
• 搜索功能：支持搜索任务或项目。

📦 安装指南

环境变量配置

在 .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

本地运行

# 执行构建
npm run build

# 启动服务
npm start

📚 详细文档

工具

项目相关

getSpaces

• 功能：获取空间信息。
• 输入：无。
• 输出：空间信息。

getProjects

• 功能：获取项目列表。
• 输入：无。
• 输出：项目列表。

任务相关

创建新任务

• 输入：
  • title：任务标题（必需）。
  • content：任务内容（可选，默认为空）。
  • priority：优先级（可选，默认为“中”）。
  • assigneeId：负责人 ID（可选，若不指定则任务无人认领）。
• 输出：新任务的详细信息。

更新现有任务

• 输入：
  • taskId（必需）：要更新的任务 ID。
  • title：新标题（可选）。
  • content：新内容（可选）。
  • priority：新优先级（可选）。
• 输出：更新后任务的详细信息。

搜索任务

• 输入：
  • keyword（必需）：关键字，用于搜索任务标题或内容。
  • projectId（可选）：特定项目的 ID。
  • statusId（可选）：状态 ID（如“未完成”、“已完成”）。
  • assigneeId（可选）：负责人 ID。
• 输出：符合条件的任务列表。

添加评论

• 输入：
  • taskId（必需）：要添加评论的任务 ID。
  • content（必需）：评论内容。
• 输出：新评论的详细信息，包括生成的评论 ID 和时间戳。

🔧 技术细节

API 密钥获取步骤

1. 登录 Backlog 网站。
2. 进入个人设置 > API > 发布新的 API 密钥。
3. 复制生成的 API 密钥。

环境变量配置

在 .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

测试

# 运行所有测试
npm test

# 监视模式运行测试（自动检测代码变化）
npm run test:watch

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

📄 许可证

本 MCP 服务器遵循 MIT 许可证，详细信息请参考项目仓库中的 LICENSE 文件。