Backlog

🚀 Backlog MCP 服務器

Backlog MCP 服務器是一個集成了 Backlog API 的 MCP 服務器實現，能幫助用戶方便地與 Backlog 平臺進行交互，實現項目、問題、維基等信息的管理。

🚀 快速開始

若要使用 Backlog MCP 服務器，需先獲取 API 密鑰並配置環境變量，然後根據需求將配置添加到 claude_desktop_config.json 中，最後進行安裝、構建等操作。

✨ 主要特性

• 提供項目、問題、維基等多種 API 接口，方便對 Backlog 平臺的數據進行操作。
• 支持通過環境變量進行配置，便於在不同環境中使用。
• 可與 Claude Desktop 集成使用。
• 易於擴展，可根據需求添加更多功能。

📦 安裝指南

安裝依賴

npm install

構建項目

npm run build

Docker 構建

docker build -t mcp/backlog .

💻 使用示例

與 Claude Desktop 使用

NPX

將以下內容添加到您的 claude_desktop_config.json 中：

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": [
        "-y",
        "backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
        "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
      }
    }
  }
}

Docker

將以下內容添加到您的 claude_desktop_config.json 中：

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "BACKLOG_API_KEY=YOUR_API_KEY_HERE",
        "-e",
        "BACKLOG_SPACE_ID=YOUR_SPACE_ID_HERE",
        "mcp/backlog"
      ],
      "env": {
        "BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
        "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
      }
    }
  }
}

📚 詳細文檔

工具

項目 API

• backlog_get_projects：帶分頁和過濾器執行項目獲取操作。
• backlog_get_project：使用項目 ID 或鍵執行項目獲取操作。

問題 API

• backlog_get_issues：帶分頁和過濾器執行問題獲取操作。
• backlog_get_issue：使用問題 ID 或鍵執行問題獲取操作。
• backlog_add_issue：使用問題數據執行問題添加操作。
• backlog_update_issue：使用問題數據執行問題更新操作。
• backlog_delete_issue：使用問題 ID 或鍵執行問題刪除操作。

Wiki API

• backlog_get_wikis：帶關鍵詞執行維基獲取操作。
• backlog_get_wiki：使用維基 ID 或鍵執行維基獲取操作。
• backlog_add_wiki：使用維基數據執行維基添加操作。
• backlog_update_wiki：使用維基數據執行維基更新操作。
• backlog_delete_wiki：使用維基 ID 或鍵執行維基刪除操作。

配置

獲取 API 密鑰

1. 在 Backlog 註冊一個賬戶。
2. 選擇一個計劃（免費計劃在此提供 此處）。
3. 從個人設置中生成您的 API 密鑰 幫助。

環境變量

此服務器需要以下環境變量：

• 必填：
  • BACKLOG_API_KEY：您的 Backlog API 密鑰。
  • BACKLOG_SPACE_ID：您的 Backlog 空間 ID。
• 可選：
  • BACKLOG_BASE_URL：您的 Backlog 基礎 URL（默認：https://{your-space-id}.backlog.com/api/v2）。

擴展服務器

要擴展服務器，請按照以下步驟操作：

1. 定義 Zod 模式：在 schema.ts 文件中為每個工具定義相應的 Zod 模式。
2. 實現工具邏輯：在 commands 文件夾中創建對應命令的處理函數，例如 get_projects.command.ts 或 add_issue.command.ts。
3. 註冊工具：在 index.ts 文件中註冊您的工具，確保它們可供使用。

通過這些步驟，您可以輕鬆擴展服務器以支持更多功能。

調試

npm run debug

運行測試

待定