Backlog MCP 服务器

Backlog API 访问提供的 MCP 服务器。可以利用项目管理、问题跟踪、文件操作等功能。

功能

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

工具

项目相关

getSpaces

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

getProjects

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

问题相关

getIssues

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

getIssue

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

createIssue

• 创建新的问题
• 输入:
  • projectId (字符串/数字): 项目ID
  • summary (字符串): 问题的主题
  • issueTypeId (字符串/数字): 问题类型ID
  • priorityId (字符串/数字, 可选): 优先级ID
  • description (字符串, 可选): 问题的详细描述
  • startDate (字符串, 可选): 开始日期 (YYYY-MM-DD 格式)
  • dueDate (字符串, 可选): 截止日期 (YYYY-MM-DD 格式)
  • assigneeId (字符串/数字, 可选): 分配给的人员ID
• 返回值: 创建的问题的信息

updateIssue

• 更新现有问题
• 输入:
  • issueIdOrKey (字符串): 问题ID或键
  • summary (字符串, 可选): 问题的主题
  • description (字符串, 可选): 问题的详细描述
  • statusId (字符串/数字, 可选): 状态ID
  • priorityId (字符串/数字, 可选): 优先级ID
  • assigneeId (字符串/数字, 可选): 分配给的人员ID
  • startDate (字符串, 可选): 开始日期 (YYYY-MM-DD 格式)
  • dueDate (字符串, 可选): 截止日期 (YYYY-MM-DD 格式)
• 返回值: 更新的问题的信息

addComment

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

搜索相关

searchIssues

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

搜索语法

问题搜索

• keyword: 自由文本搜索
• projectId: 筛选特定项目
• statusId: 筛选状态
• assigneeId: 筛选分配给的人员

示例: keyword=错误 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 文件。 </中文翻译>