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 文件。