MCP Server Elasticsearch

🚀 Elasticsearch MCP 服務器

Elasticsearch MCP 服務器可讓您通過 MCP 客戶端（如 Claude Desktop）直接連接到 Elasticsearch 數據。它藉助 Model Context Protocol (MCP) 代理連接到 Elasticsearch 數據，支持您通過自然語言對話與 Elasticsearch 索引進行交互。

🚀 快速開始

本服務器允許您藉助 MCP 客戶端，以自然語言對話的方式與 Elasticsearch 索引交互。您可以使用提供的工具列出索引、獲取映射、執行搜索等操作。

✨ 主要特性

• 自然語言交互：支持通過自然語言對話與 Elasticsearch 索引進行交互。
• 豐富工具集：提供 list_indices、get_mappings、搜索、get_shards 等實用工具。

📦 安裝指南

使用 Elasticsearch MCP 服務器連接

步驟 1：安裝 Elasticsearch

按照官方文檔安裝 Elasticsearch。

步驟 2：配置 Elasticsearch

編輯 elasticsearch.yml 文件，添加以下內容：

plugins.security.enabled: true
plugins.security.ssl.enabled: true

重啟 Elasticsearch 服務以應用更改。

連接 MCP 客戶端

使用 MCP 客戶端（如 Claude Desktop）連接到 Elasticsearch。

💻 使用示例

基礎用法

以下是使用各工具的示例：

• list_indices：列出所有可用的 Elasticsearch 索引。
• get_mappings：獲取特定 Elasticsearch 索引的字段映射。
• 搜索：使用提供的查詢 DSL 執行 Elasticsearch 搜索。
• get_shards：獲取所有或特定索引的分片信息。

📚 詳細文檔

可用工具

• list_indices：列出所有可用的 Elasticsearch 索引。
• get_mappings：獲取特定 Elasticsearch 索引的字段映射。
• 搜索：使用提供的查詢 DSL 執行 Elasticsearch 搜索。
• get_shards：獲取所有或特定索引的分片信息。

先決條件

• 一個 Elasticsearch 實例。
• Elasticsearch 認證憑據（API 密鑰或用戶名/密碼）。
• MCP 客戶端（例如 Claude Desktop）。

示例演示

您可以查看此示例演示：示例演示鏈接

安全最佳實踐

⚠️ 重要提示 避免使用集群管理員權限。創建具有最小權限的專用 API 密鑰，並在索引級別應用細粒度訪問控制以防止未經授權的數據訪問。

您可以創建一個具有有限權限的專用 Elasticsearch API 密鑰：

POST /_security/api_key
{
  "name": "es-mcp-server-access",
  "role_descriptors": {
    "mcp_server_role": {
      "cluster": [
        "monitor"
      ],
      "indices": [
        {
          "names": [
            "index-1",
            "index-2",
            "index-pattern-*"
          ],
          "privileges": [
            "read",
            "view_index_metadata"
          ]
        }
      ]
    }
  }
}

故障排除

• 確保您的 MCP 配置正確。
• 驗證您的 Elasticsearch URL 是否可以從您的機器訪問。
• 檢查您的認證憑據（API 密鑰或用戶名/密碼）是否具有必要的權限。
• 如果使用 SSL/TLS 和自定義 CA，請驗證證書路徑是否正確且文件可讀。
• 查看終端輸出中的錯誤信息。

如果遇到問題，請在 GitHub 倉庫中打開一個 issue。

📄 許可證

本項目 licensed under the Apache License 2.0.