Backlog MCP Server

🚀 Backlog MCP サーバ

Backlog MCP サーバは、特定の機能を提供するサーバで、Docker やローカル環境でのインストールや設定が可能です。

🚀 クイックスタート

このセクションでは、Backlog MCP サーバのインストール、設定、使用方法について説明します。

📦 インストール

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