Backlog MCP 服务器

这是一个提供 Backlog API 访问的 MCP 服务器。您可以使用它来进行项目管理、问题跟踪、文件操作等功能。

功能

• 项目管理: 获取项目列表、查看详细信息
• 问题管理: 创建、更新、搜索问题，添加评论
• 用户管理: 获取用户信息
• 文件操作: 管理附件
• 评论功能: 向问题添加评论
• 搜索功能: 搜索问题和项目

工具

项目相关

getSpaces

• 获取空间信息
• 输入: 无
• 返回值: 空间信息

getProjects

• 获取项目列表
• 输入: 无
• 返回值: 项目列表

课题相关

getIssues

• 获取问题列表
• 输入:
  • projectIdOrKey (string): 项目 ID 或键
  • offset (number, 可选): 获取起始位置
  • count (number, 可选): 获取数量（最大 100）
  • sort (string, 可选): 排序方式 ('created' 或 'updated')
  • order (string, 可选): 排序方向 ('asc' 或 'desc')
• 返回值: 问题列表

getIssue

• 获取问题的详细信息
• 输入:
  • issueIdOrKey (string): 问题 ID 或键
• 返回值: 问题的详细信息

createIssue

• 创建新问题
• 输入:
  • projectId (string/number): 项目 ID
  • summary (string): 问题标题
  • issueTypeId (string/number): 问题类型 ID
  • priorityId (string/number, 可选): 优先级 ID
  • description (string, 可选): 问题描述
  • startDate (string, 可选): 开始日期 (YYYY-MM-DD 格式)
  • dueDate (string, 可选): 截止日期 (YYYY-MM-DD 格式)
  • assigneeId (string/number, 可选): 负责人 ID
• 返回值: 创建的问题信息

updateIssue

• 更新现有问题
• 输入:
  • issueIdOrKey (string): 问题 ID 或键
  • summary (string, 可选): 问题标题
  • description (string, 可选): 问题描述
  • statusId (string/number, 可选): 状态 ID
  • priorityId (string/number, 可选): 优先级 ID
  • assigneeId (string/number, 可选): 负责人 ID
  • startDate (string, 可选): 开始日期 (YYYY-MM-DD 格式)
  • dueDate (string, 可选): 截止日期 (YYYY-MM-DD 格式)
• 返回值: 更新的问题信息

addComment

• 向问题添加评论
• 输入:
  • issueIdOrKey (string): 问题 ID 或键
  • content (string): 评论内容
• 返回值: 添加的评论信息

搜索相关

searchIssues

• 搜索问题
• 输入:
  • keyword (string): 搜索关键词
  • projectIdOrKey (string, 可选): 项目 ID 或键
  • offset (number, 可选): 获取起始位置
  • count (number, 可选): 获取数量（最大 100）
• 返回值: 搜索结果的问题列表

搜索语法

问题搜索

• keyword: 自由文本搜索
• projectId: 按特定项目筛选
• statusId: 按状态筛选
• assigneeId: 按负责人筛选

例: keyword=bug statusId=1 assigneeId=12345

设置

获取 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 中使用，请将以下内容添加到 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 文件。