MCP Backlog Server

🚀 mcp-backlog-server

このプロジェクトは、BacklogとModel Context Protocol (MCP)を組み合わせたTypeScriptベースのサーバーです。MCPの主要な概念を実装しており、Backlogプロジェクトを表すリソース、Backlog APIとのやり取りを行うツール、データの要約や分析のためのプロンプト生成機能を備えています。

🚀 クイックスタート

このサーバーを使用するには、まず必要な依存関係をインストールし、サーバーをビルドする必要があります。以下の手順に従ってください。

依存関係のインストール

npm install

サーバーのビルド

npm run build

監視モードでの開発

npm run watch

✨ 主な機能

リソース管理

• backlog://project/[id] URIを通じてBacklogプロジェクトにアクセスできます。
• 各プロジェクトリソースには、プロジェクトのメタデータと詳細情報が含まれています。
• 構造化データへのアクセスを提供し、JSON形式の出力をサポートします。
• プロジェクト内のイシュー（Issue）とWikiページへのアクセスをサポートします。

ツールセット

• get_backlog_user: 現在のBacklogユーザー情報を取得します。
• get_backlog_space: Backlogスペース情報を取得します。
• list_recent_projects: 最近アクセスしたBacklogプロジェクトをリストし、指定した数量と並べ替え順序をサポートします。
• get_project_issues: プロジェクトのイシューリストを取得し、状態、担当者、ページングによるフィルタリングをサポートします。
• get_issue_detail: 特定のイシューの詳細情報を取得します。
• get_issue_comments: イシューのコメント内容を取得します。
• add_issue_comment: イシューに新しいコメントを追加します。
• get_issue_comment_count: イシューの総コメント数を取得します。
• get_issue_comment: 指定したコメントの詳細情報を取得します。
• get_wiki_page_list: Wikiページのリストを取得し、プロジェクトまたはキーワードによるフィルタリングをサポートします。
• get_wiki_page: 特定のWikiページの内容詳細を取得します。
• update_wiki_page: 既存のWikiページの内容を更新します。

プロンプト機能

• summarize_projects: 最近アクセスしたプロジェクトの要約情報を生成します。
• analyze_backlog_usage: ユーザー、スペース、プロジェクトのデータに基づいて使用パターンを分析します。
• summarize_wiki_pages: 指定したプロジェクトのWikiページの概要情報を生成します。

📦 インストール

システム要件

• APIアクセス権限を持つBacklogアカウントが必要です。
• 環境変数:
  • BACKLOG_API_KEY: Backlog APIキー
  • BACKLOG_SPACE_URL: BacklogスペースURL（例: https://your-space.backlog.com）

デプロイ設定

Claude Desktopで使用する場合は、サーバー設定を追加する必要があります。具体的なパスは以下の通りです。

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

設定例は以下の通りです。

{
  "mcpServers": {
    "mcp-backlog-server": {
      "command": "/path/to/mcp-backlog-server/build/index.js",
      "env": {
        "BACKLOG_API_KEY": "your_api_key_here",
        "BACKLOG_SPACE_URL": "https://your-space.backlog.com"
      }
    }
  }
}

🔧 技術詳細

このプロジェクトの構造は、以下の主要なファイルで構成されています。

• index.ts: サーバーの初期化と設定を担当するエントリーファイルです。
• backlog-client.ts: Backlog APIとの通信ロジックを処理します。
• 各ハンドラーファイル（tool-handlers.ts, prompt-handlers.ts, types.tsなど）: それぞれツールのやり取り、プロンプトの生成、型定義を処理します。
• config.ts: 環境変数から設定情報を読み取ります。

この設計により、このサーバーはBacklogの機能を効果的に統合し、MCPプロトコルを通じて外部システムとのやり取りを実現します。