Backlog MCP Server

🚀 Backlog MCP 服務器

Backlog MCP 服務器是一款用於特定業務場景的服務器工具，可通過 Docker 或常規方式安裝，支持靈活配置和多語言設置，方便開發者進行開發和測試。

🚀 快速開始

你可以按照以下步驟快速搭建並使用 Backlog MCP 服務器：

1. 安裝服務器。
2. 進行相關配置。
3. 啟動服務器開始使用。

📦 安裝指南

使用 Docker 安裝

運行以下命令使用 Docker 安裝：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

或者直接運行鏡像：

npx github:nulab/backlog-mcp-server

⚙️ 配置說明

默認配置文件

默認配置文件為 ~/.backlog-mcp-serverrc.json。

定製配置文件

在你的工作目錄中創建或修改 mcp-config.json 文件，內容如下：

{
  "mcpServers": {
    "backlog": {
      "command": "node",
      "args": [
        "build/index.js"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

使用 Docker 安裝的配置

在 Docker 運行時，可以通過以下方式掛載配置文件：

docker run -i --rm \
  -v /yourcurrentdir/mcp-config.json:/root/.backlog-mcp-serverrc.json:ro \
  ghcr.io/nulab/backlog-mcp-server

💻 使用示例

啟動服務器

運行以下命令啟動服務器：

node build/index.js

或者使用 Docker：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

📚 詳細文檔

配置文件結構

配置文件包含以下結構：

• mcpServers：定義 MCP 服務器。
  • backlog：包含以下屬性：
    • command：執行命令（如：node、docker）。
    • args：命令參數數組。
    • env：環境變量，包含必填項：
      • BACKLOG_DOMAIN：Backlog 域名。
      • BACKLOG_API_KEY：Backlog API 密鑰。

配置示例

以下是一個完整的配置示例：

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "BACKLOG_DOMAIN",
        "-e", "BACKLOG_API_KEY",
        "ghcr.io/nulab/backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

環境變量

環境變量優先級高於配置文件，可以通過以下方式設置：

docker run -i --rm \
  -e BACKLOG_DOMAIN=your-domain.backlog.com \
  -e BACKLOG_API_KEY=your-api-key \
  ghcr.io/nulab/backlog-mcp-server

描述覆蓋

通過創建 .backlog-mcp-serverrc.json 文件可以覆蓋工具描述：

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "評論工具的中文描述",
  "TOOL_CREATE_PROJECT_DESCRIPTION": "項目創建工具的中文描述"
}

導出當前翻譯

運行以下命令導出當前翻譯：

node build/index.js --exportTranslations

國際化設置

支持 .json、.yaml 和 .yml 格式的國際化文件。

示例 YAML 文件

translation:
  key1: "value1"
  key2: "value2"

🔧 技術細節

開發和測試

添加新工具

在 commands 目錄下創建新命令文件，例如：

const Command = require('@backlog/mcp-server').Command;

class MyCommand extends Command {
  // 定義你的命令邏輯
}

module.exports = MyCommand;

測試

使用 Mocha 進行測試，安裝依賴後運行：

npm test

幫助信息

運行以下命令獲取幫助信息：

node build/index.js --help

以上是 Backlog MCP Server 的完整中文文檔。