Elasticsearch MCP 服务器

English | 中文

MCP 服务器用于直接从任何 MCP 客户端（如 Claude Desktop、Cursor）连接到您的 Elasticsearch 集群。

此服务器使用模型上下文协议将代理连接到您的 Elasticsearch 数据。它允许您通过自然语言对话与您的 Elasticsearch 索引进行交互。

演示

功能概述

可用功能

• list_indices: 列出可用的 Elasticsearch 索引，支持正则表达式
• get_mappings: 获取特定 Elasticsearch 索引的字段映射
• search: 使用提供的查询 DSL 执行 Elasticsearch 搜索
• elasticsearch_health: 获取 Elasticsearch 集群健康状态，可以选择包括索引级别的详细信息
• create_index: 创建 Elasticsearch 索引，可以选择设置和映射
• create_mapping: 为 Elasticsearch 索引创建或更新映射结构
• bulk: 将批量数据导入到 Elasticsearch 索引中
• reindex: 使用可选的查询和脚本将数据从源索引重新索引到目标索引
• create_index_template: 创建或更新索引模板
• get_index_template: 获取有关索引模板的信息
• delete_index_template: 删除索引模板

工作原理

1. MCP 客户端分析您的请求并确定需要哪些 Elasticsearch 操作
2. MCP 服务器执行这些操作（列出索引、获取映射、执行搜索）
3. MCP 客户端处理结果并以用户友好的格式呈现

快速入门

前提条件

• 一个 Elasticsearch 实例
• Elasticsearch 身份验证凭据（API 密钥或用户名/密码）
• MCP 客户端（例如 Claude Desktop、Cursor）

安装与设置

使用已发布的 NPM 包（即将推出）

[!TIP] 使用 Elasticsearch MCP 服务器的最简单方法是通过已发布的 npm 包。

1. 配置 MCP 客户端

   • 打开您的 MCP 客户端。 请参阅 MCP 客户端列表，这里我们配置的是 Claude Desktop。
   • 转到 Settings > Developer > MCP Servers
   • 单击 Edit Config 并添加一个新的 MCP 服务器，配置如下：

   {
     "mcpServers": {
       "elasticsearch-mcp": {
         "command": "npx",
         "args": [
           "-y",
           "@awesome-ai/elasticsearch-mcp"
         ],
         "env": {
           "HOST": "your-elasticsearch-host",
           "API_KEY": "your-api-key"
         }
       }
     }
   }
   

2. 开始对话

   • 在您的 MCP 客户端中打开一个新的对话
   • MCP 服务器应自动连接
   • 现在您可以提出有关您的 Elasticsearch 数据的问题

配置选项

Elasticsearch MCP 服务器支持配置选项以连接到您的 Elasticsearch：

[!NOTE] 您必须提供 API 密钥或用户名和密码才能进行身份验证。

环境变量	描述	必需
HOST	您的 Elasticsearch 实例 URL	是
API_KEY	用于身份验证的 Elasticsearch API 密钥	否
USERNAME	用于基本身份验证的 Elasticsearch 用户名	否
PASSWORD	用于基本身份验证的 Elasticsearch 密码	否
CA_CERT	Elasticsearch SSL/TLS 的自定义 CA 证书的路径	否

本地开发

[!NOTE] 如果您想修改或扩展 MCP 服务器，请按照以下本地开发步骤操作。

1. 使用正确的 Node.js 版本

   nvm use
   

2. 安装依赖项

   npm install
   

3. 构建项目

   npm run build
   

4. 在 Claude Desktop App 中本地运行（也支持 Cusor）

   • 打开 Claude Desktop App
   • 转到 Settings > Developer > MCP Servers
   • 单击 Edit Config 并添加一个新的 MCP 服务器，配置如下：

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

5. 使用 MCP Inspector 进行调试

   HOST=your-elasticsearch-url API_KEY=your-api-key npm run inspector
   

   这将启动 MCP Inspector，允许您调试和分析请求。 您应该看到：

   Starting MCP inspector...
   Proxy server listening on port 3000
   
   🔍 MCP Inspector is up and running at http://localhost:5173 🚀
   

示例查询

[!TIP] 以下是一些您可以使用 MCP 客户端尝试的自然语言查询。

• "我的 Elasticsearch 集群中有哪些索引？"
• "显示 'products' 索引的字段映射。"
• "查找上个月所有超过 500 美元的订单。"
• "哪些产品收到了最多的 5 星评价？"
• "我的 Elasticsearch 集群的健康状况如何？"
• "创建一个名为 'users' 的新索引，包含 3 个分片和 1 个副本。"
• "向 'products' 索引添加一个名为 'tags' 的 keyword 类型字段。"
• "将这些客户记录批量导入到 'customers' 索引中。"
• "将数据从 'old_index' 重新索引到 'new_index'。"
• "为模式为 'logs-*' 的日志创建索引模板。"
• "显示我的所有索引模板。"
• "删除 'outdated_template' 索引模板。"

如果您遇到问题，请随时在 GitHub 存储库上提出 issue。

灵感来源

• mcp-server-elasticsearch.