Backlog

🚀 Backlog MCP サーバー

Backlog API を統合した MCP サーバーの実装です。このサーバーを使用することで、Backlog の各種機能を効率的に利用できます。

🚀 クイックスタート

この Backlog MCP サーバーを使用するには、まず API キーの取得と環境変数の設定が必要です。その後、開発や運用に必要な操作を行うことができます。

✨ 主な機能

プロジェクト 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）

Claude Desktop との連携

claude_desktop_config.json に以下の内容を追加します：

NPX

{
  "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

{
  "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"
      }
    }
  }
}

開発環境のセットアップ

インストール

npm install

ビルド

npm run build

デバッグ

npm run debug

Docker ビルド

docker build -t mcp/backlog .

🔧 サーバーの拡張

サーバーを拡張するには、以下の手順に従います：

1. Zod スキーマの定義：schema.ts ファイルで各ツールに対応する Zod スキーマを定義します。
2. ツールロジックの実装：commands フォルダに対応するコマンドの処理関数を作成します。例えば、get_projects.command.ts や add_issue.command.ts などです。
3. ツールの登録：index.ts ファイルでツールを登録し、使用可能にします。

これらの手順により、サーバーを簡単に拡張して、より多くの機能をサポートすることができます。