Imlewc Elasticsearch7 MCP Server

🚀 Elasticsearch 7.x MCP 服務器

本服務器專為 Elasticsearch 7.x 提供 MCP 協議接口，完美支持與 Elasticsearch 7.x 版本兼容，讓你輕鬆訪問 Elasticsearch 的各項功能。

🚀 快速開始

本服務器為 Elasticsearch 7.x 提供 MCP 協議接口，支持與該版本兼容。你可以通過 Smithery 自動安裝或手動安裝，配置好環境變量後，就能使用 MCP 客戶端連接服務器進行操作。

✨ 主要特性

• 提供 Elasticsearch 7.x 的 MCP 協議訪問接口，方便快捷。
• 支持基礎 Elasticsearch 操作，如心跳檢測、信息查詢等，保障系統穩定運行。
• 完全支持搜索功能，涵蓋聚合查詢、高亮顯示、排序以及其他高級特性，滿足多樣化的搜索需求。
• 可通過任何 MCP 客戶端輕鬆訪問 Elasticsearch 功能，使用靈活。

📦 安裝指南

使用 Smithery 自動安裝

通過 Smithery 自動安裝 Elasticsearch 7.x MCP Server for Claude Desktop：

npx -y @smithery/cli install @imlewc/elasticsearch7-mcp-server --client claude

手動安裝

pip install -e .

🔧 環境變量

服務器需要以下環境變量：

• ELASTIC_HOST：Elasticsearch 主機地址（例如 http://localhost:9200）
• ELASTIC_USERNAME：Elasticsearch 用戶名
• ELASTIC_PASSWORD：Elasticsearch 密碼
• MCP_PORT：（可選）MCP 服務器監聽端口，默認為 9999

💻 使用示例

使用 Docker Compose

1. 創建一個 .env 文件並設置 ELASTIC_PASSWORD：

ELASTIC_PASSWORD=your_secure_password

2. 啟動服務：

docker-compose up -d

這將啟動一個三節點的 Elasticsearch 7.17.10 集群、Kibana 和 MCP 服務器。

使用 MCP 客戶端

你可以使用任何 MCP 客戶端連接到 MCP 服務器：

from mcp import MCPClient

client = MCPClient("localhost:9999")
response = client.call("es-ping")
print(response)  # {"success": true}

搜索 API 示例

基本搜索

# 基本搜索
search_response = client.call("es-search", {
    "index": "my_index",
    "query": {
        "match": {
            "title": "搜索關鍵詞"
        }
    },
    "size": 10,
    "from": 0
})

聚合查詢

# 聚合查詢
agg_response = client.call("es-search", {
    "index": "my_index",
    "size": 0,  # 只需聚合結果，不需要文檔內容
    "aggs": {
        "categories": {
            "terms": {
                "field": "category.keyword",
                "size": 10
            }
        },
        "avg_price": {
            "avg": {
                "field": "price"
            }
        }
    }
})

高級搜索

# 帶有高亮和排序的高級搜索
search_response = client.call("es-search", {
    "index": "my_index",
    "query": {
        "multi_match": {
            "query": "搜索關鍵詞",
            "fields": ["title", "content"]
        }
    },
    "highlight": {
        "pre_tag": "<em>",
        "post_tag": "</em>",
        "fields": {
            "title": {},
            "content": {}
        }
    },
    "sort": [
        {"price": { "order": "asc" }}
    ]
})

📚 詳細文檔

開發

在項目根目錄下運行以下命令啟動服務器：

python -m elasticsearch_mcp_server

默認情況下，服務器將在 http://localhost:9999 啟動。

API 文檔

當前支持的 MCP 方法：

• es-ping：檢查 Elasticsearch 連接狀態
• es-info：獲取 Elasticsearch 集群信息
• es-search：在 Elasticsearch 索引中搜索文檔

📄 許可證

本項目的授權遵循 MIT License。

依賴項