Es MCP Server

🚀 Elasticsearch MCP 服務器

本項目實現了一個用於 Elasticsearch 的 MCP（模型上下文協議）服務器，提供了一系列工具和資源，方便與 Elasticsearch 集群進行交互，助力用戶高效管理和操作 Elasticsearch 數據。

🚀 快速開始

先決條件

• Python 3.7+
• Elasticsearch Python 客戶端
• MCP SDK
• Elasticsearch 集群憑證（Cloud ID 和 API Key）

設置步驟

1. 克隆倉庫：

   git clone https://github.com/yourusername/elasticsearch-mcp-server.git
   cd elasticsearch-mcp-server
   

2. 安裝所需的依賴項：

   pip install -r requirements.txt
   

3. 配置環境變量：
   • 複製示例環境文件：

     cp .env.example .env
     

   • 編輯 .env 文件並添加您的 Elasticsearch 憑證。 或直接在 shell 中設置：

   export ES_CLOUD_ID=your_elasticsearch_cloud_id
   export ES_API_KEY=your_elasticsearch_api_key
   

配置 MCP 服務器以供 Claude 使用

configure_mcp_server.py 腳本可幫助您在 Claude 的 MCP 配置文件中設置 Elasticsearch MCP 服務器，使 Claude 能夠通過 MCP 服務器連接到您的 Elasticsearch 集群。

python configure_mcp_server.py your_cloud_id your_api_key

此腳本的執行步驟如下：

1. 使用命令行參數獲取您的 Elasticsearch Cloud ID 和 API Key。
2. 查找或創建 Claude 的 MCP 設置文件。
3. 添加或更新 Elasticsearch MCP 服務器配置。
4. 設置服務器連接到您的 Elasticsearch 集群所需的環境變量。

運行此腳本後，重啟 VS Code 以應用更改，Claude 即可通過 MCP 服務器與您的 Elasticsearch 集群進行交互。

✨ 主要特性

工具

• list_indices：可列出 Elasticsearch 集群中的所有索引。
• get_mappings：用於獲取特定索引的映射信息。
• search：能使用提供的查詢 DSL 執行 Elasticsearch 搜索。
• search_with_query_string：支持使用簡單的查詢字符串執行搜索。
• get_index_stats：可獲取特定索引的統計信息。

資源

• elasticsearch://indices：可列出所有 Elasticsearch 索引。
• elasticsearch://index/{index_name}：能獲取特定索引的詳細信息。
• elasticsearch://mapping/{index_name}：可獲取特定索引的映射信息。

📦 安裝指南

克隆倉庫

git clone https://github.com/yourusername/elasticsearch-mcp-server.git
cd elasticsearch-mcp-server

安裝依賴

pip install -r requirements.txt

配置環境變量

可通過複製示例環境文件並編輯，或者直接在 shell 中設置的方式來配置環境變量。

🔧 技術細節

所有資源都包含適當的錯誤處理和驗證機制：

• 若索引不存在，資源將返回適當的錯誤消息。
• 若連接到 Elasticsearch 時出現問題，資源將返回錯誤消息。
• 所有異常都會被捕獲並作為可讀的錯誤消息返回。

🤝 貢獻

歡迎大家為項目貢獻力量，貢獻方式如下：

1. 叉克隆倉庫。
2. 創建功能分支：

   git checkout -b feature/your-feature-name
   

3. 提交更改：

   git commit -am 'Add some feature'
   

4. 推送到分支：

   git push origin feature/your-feature-name
   

5. 提交拉取請求。

📂 GitHub 倉庫

此項目已準備好上傳到 GitHub，倉庫包含以下文件：

• .gitignore 文件：用於排除敏感信息和日誌。
• .env.example 文件：指導用戶設置環境變量。
• requirements.txt 文件：列出項目依賴項。
• LICENSE 文件：包含 MIT 許可。
• 文檔完整的 README.md。

📄 許可證

此項目在 MIT 許可證下發布，更多詳細信息請參閱 LICENSE 文件。