Consul MCP Server

Consul MCP サーバー

HashiCorp Consul のサービスディスカバリーとサービスメッシュを操作するための Model Control Protocol（MCP）サーバーです。この実装は Anthropic の MCP 仕様に準拠しており、Claude が自然言語でやり取りしながら、マイクロサービスアーキテクチャを分析し、図を作成し、問題を特定して、推奨事項を提示できるようにします。

Model Control Protocol とは？

Model Control Protocol（MCP） は、Claude などの AI モデルが外部のツールや API とやり取りできるようにするため、Anthropic が開発した仕様です。この実装により、AI エージェントを Consul インフラストラクチャに接続し、自然言語を使ってサービスを管理、分析できます。

機能

• Consul に登録されているサービスの一覧表示と分析
• ヘルスチェックの失敗の特定と診断
• サービスメッシュのアーキテクチャ図の生成
• サービスの接続問題の検出と推奨事項の提示
• サービスの負荷分散とリソース使用状況に関する AI の分析情報の取得

要件

• Node.js 18+
• npm または yarn
• 稼働中の Consul インスタンス（ローカルまたはリモート）
• Claude との連携機能を備えた Claude Desktop または Cursor IDE

インストール

# Clone the repository
git clone https://github.com/3loka/consul-mcp-server.git
cd consul-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

設定

ルートディレクトリに .env ファイルを作成し、次の変数を設定します。

CONSUL_HTTP_ADDR=http://localhost:8500
CONSUL_HTTP_TOKEN=your-consul-token
PORT=3000
USE_HTTP=true

• CONSUL_HTTP_ADDR：Consul サーバーのアドレス
• CONSUL_HTTP_TOKEN：Consul サーバーの ACL トークン
• PORT：HTTP サーバーのポート
• USE_HTTP：HTTP モードにするには「true」に設定します。stdio モードの場合は省略します

インストール

Cursor へのインストール

Cursor にこの MCP サーバーをインストールして使用するには、次の手順に従います。

1. Cursor で Settings（⌘+,）を開き、「MCP」タブに移動します。

2. 「+ Add new MCP server」をクリックします。

3. 次の内容を入力します。

   • 名前：consul-assistant
   • タイプ：command
   • コマンド：npx -y consul-mcp-server

4. 「Add」をクリックし、サーバーまでスクロールして「Disabled」をクリックし、サーバーを有効にします。

5. 必要に応じて Cursor を再起動し、MCP サーバーが正しく読み込まれたことを確認します。

Claude Desktop へのインストール

Claude Desktop にこの MCP サーバーをインストールして使用するには、次の手順に従います。

1. Claude Desktop で Settings（⌘+,）を開き、「Developer」タブに移動します。

2. ウィンドウの下部にある「Edit Config」をクリックします。

3. ファイル（~/Library/Application Support/Claude/claude_desktop_config.json）を編集して次のコードを追加し、ファイルを保存します。

{
  "mcpServers": {
    "consul-assistant": {
      "command": "npx",
      "args": ["-y", "consul-mcp-server"]
    }
  }
}

サーバーがローカルホストでない場合、または ACL が有効になっている場合は、代わりに以下の設定を使用します。

{
    "mcpServers": {
      "consul-assistant": {
        "command": "npx",
        "args": ["-y", "consul-mcp-server"],
        "env": {
          "CONSUL_HTTP_ADDR": "http://<host/ip>:8500",
          "CONSUL_HTTP_TOKEN": "<ACL Token>"
        }
      }
    }
  }

4. Claude Desktop を再起動し、MCP サーバーが正しく読み込まれたことを確認します。

プロンプトの例

接続したら、Claude に次のプロンプトを試してみてください。

• 「Consul に登録されているすべてのサービスを表示して」
• 「ヘルスチェックに失敗しているサービスはどれ？」
• 「サービスメッシュの接続図を作成して」
• 「接続の問題が発生しているサービスを分析して」
• 「マイクロサービスアーキテクチャ全体の健全性はどう？」
• 「接続のエラー率が高いサービスを表示して」

利用可能な MCP アクション

このサーバーは、次の MCP アクションを実装しています。

アクション	説明
consul/get_services	Consul にあるすべてのサービスの一覧を取得します
consul/get_health_checks	ヘルスチェックを取得します。失敗したチェックによる絞り込みもできます
consul/get_service_connections	サービスの接続とそのステータスを取得します
consul/create_service_diagram	サービスの関係を示す Mermaid 図を作成します
consul/analyze_service	特定のサービスを分析して問題を特定します
consul/get_service_metrics	特定のサービスの詳細なメトリクスを取得します

デモ環境の実行

テスト目的で、Consul に複数のマイクロサービスを登録したローカルのデモ環境をセットアップできます。

# Run the setup script (requires Docker and Docker Compose)
chmod +x ./demo/setup-demo.sh
./demo/setup-demo.sh

これにより、次のものが起動します。

• Consul サーバー
• 複数のデモ用マイクロサービス
• Consul へのサービス登録
• サービスメッシュ接続とヘルスチェックのセットアップ

デモの手順

1. デモ環境を起動します。

   ./scripts/setup-demo.sh
   

2. MCP サーバーを起動します。

   npm start
   

3. Claude Desktop または Cursor を MCP サーバーに接続します。

4. 次のデモシナリオを試します。

   a. サービスの概要を取得します。

   Show me all the services registered in my Consul instance.
   

   b. 失敗しているヘルスチェックを確認します。

   Are any services experiencing health issues? What might be causing them?
   

   c. サービスメッシュの図を作成します。

   Create a diagram showing the connections between my services.
   

   d. 接続の問題を分析します。

   Which services are having trouble connecting to each other?
   

   e. 推奨事項を取得します。

   Based on my service mesh setup, what improvements would you recommend?
   

開発

プロジェクト構成

• src/index.ts：メインエントリーポイント
• src/resources/：Consul API との連携コード
• src/tools/：図の生成などのヘルパー機能
• src/server/：MCP サーバーのコンポーネント
• src/mcp/：MCP アクションの定義とハンドラー
• src/prompts/：AI とのやり取りに使用するテンプレートの管理
• src/tests/：テストスイート

テストの実行

npm test

ビルド

npm run build

貢献

貢献を歓迎します。お気軽にプルリクエストを送信してください。

ライセンス

MIT