Elasticsearch MCP

🚀 Elasticsearch MCP サーバー

Elasticsearch MCP サーバーは、Elasticsearch クラスターの管理を支援するツールです。クラスターのヘルスチェック、インデックス管理、マッピング設定、データのインポートとエクスポート、テンプレート管理など、様々な操作をサポートしています。MCP クライアントと統合することで、ユーザーは自然言語で簡単にインタラクションできます。

🚀 クイックスタート

前提条件

• Elasticsearch クラスターが正常に稼働し、アクセス可能であること。
• Node.js 環境が適切に設定されていること。
• npm がインストールされ、使用可能であること。

インストールと設定

1. npm パッケージを使用する：

npm install elastic-mcp-server

2. MCP クライアントを設定する：

• エディタを開き、MCP 設定画面に移動します。
• 新しいグローバル MCP サーバーを追加し、以下の設定を指定します。

{
  "mcpServers": {
    "elasticsearch-mcp": {
      "command": "node",
      "args": [
        "/path/to/your/project/dist/index.js"
      ],
      "env": {
        "ES_HOST": "your-elasticsearch-host",
        "ES_API_KEY": "your-api-key"
      }
    }
  }
}

✨ 主な機能

利用可能な機能

• クラスター管理：Elasticsearch クラスターの全体的な状態を表示および監視します。
• インデックス操作：インデックスの作成、削除、および情報の照会を行います。
• マッピング設定：インデックスフィールドのタイプを定義および変更します。
• データ操作：複雑なクエリ、集計分析、およびデータの一括インポートを実行します。
• テンプレート管理：インデックステンプレートを管理および保守します。

動作原理

MCP クライアントは、MCP サーバーにリクエストを送信し、サーバーはそれを解析して対応する Elasticsearch 操作を実行します。ユーザーは自然言語またはコマンドラインを使用して MCP クライアントと対話し、Elasticsearch クラスターの管理タスクを完了することができます。

📦 インストール

前提条件

• Elasticsearch クラスターが正常に稼働し、アクセス可能であること。
• Node.js 環境が適切に設定されていること。
• npm がインストールされ、使用可能であること。

インストールと設定

1. npm パッケージを使用する：

npm install elastic-mcp-server

2. MCP クライアントを設定する：

• エディタを開き、MCP 設定画面に移動します。
• 新しいグローバル MCP サーバーを追加し、以下の設定を指定します。

{
  "mcpServers": {
    "elasticsearch-mcp": {
      "command": "node",
      "args": [
        "/path/to/your/project/dist/index.js"
      ],
      "env": {
        "ES_HOST": "your-elasticsearch-host",
        "ES_API_KEY": "your-api-key"
      }
    }
  }
}

💻 使用例

基本的な使用法

# ローカル開発用のコマンド
# 正しい Node.js バージョンを使用する
nvm use
# 依存関係をインストールする
npm install
# MCP サーバーを起動する
node index.js

📚 ドキュメント

設定オプション

以下の環境変数を使用して、MCP サーバーの動作を設定できます。

サンプルクエリ

クラスター管理

• “Elasticsearch クラスターのヘルス状態はどうですか？”
• “クラスター内のアクティブなノードはいくつありますか？”

インデックス操作

• “Elasticsearch のインデックスはどれがありますか？”
• “'users' という名前の新しいインデックスを作成し、3 つのシャードと 1 つのレプリカを設定します。”
• “'old_index' から 'new_index' にデータを再インデックスします。”

マッピング設定

• “'users' インデックスのマッピング情報を表示します。”
• “'age' フィールドに整数型の制約を追加します。”

データ操作

• “年齢が 30 歳を超えるすべてのユーザーを検索します。”
• “過去 1 週間のユーザーのログイン回数を集計します。”
• “新しいユーザーデータのバッチをインポートします。”

テンプレート管理

• “現在のすべてのインデックステンプレートをリストします。”
• “指定されたテンプレートを新しいインデックスに適用します。”

これらの機能により、Elasticsearch MCP サーバーは、Elasticsearch クラスターの管理と操作を効率的かつ便利に行う方法をユーザーに提供します。開発者や運用エンジニアは、作業効率を向上させることができます。