Elasticsearch MCP 服务器

English | 中文

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

该服务器使用模型上下文协议（Model Context Protocol）将智能体连接到您的 Elasticsearch 数据。它允许您通过自然语言对话与 Elasticsearch 索引进行交互。

演示

功能概述

可用工具

集群管理

• elasticsearch_health: 获取 Elasticsearch 集群健康状态，可选择包括索引级别的详细信息

索引操作

• list_indices: 列出可用的 Elasticsearch 索引，支持正则表达式
• create_index: 创建 Elasticsearch 索引，可选择设置和映射
• reindex: 将数据从源索引重新索引到目标索引，支持可选的查询和脚本

映射管理

• get_mappings: 获取特定 Elasticsearch 索引的字段映射
• create_mapping: 为 Elasticsearch 索引创建或更新映射结构

搜索与数据操作

• search: 使用提供的查询 DSL 执行 Elasticsearch 搜索
• bulk: 批量导入数据到 Elasticsearch 索引

模板管理

• 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": {
           "ES_HOST": "your-elasticsearch-host",
           "ES_API_KEY": "your-api-key"
         }
       }
     }
   }

2. 开始对话

   • 在 MCP 客户端中打开新对话。
   • MCP 服务器应自动连接。
   • 现在您可以询问关于 Elasticsearch 数据的问题。

配置选项

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

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

| 环境变量 | 描述 | 必需 | |---------------------|-------------|----------| | ES_HOST | 您的 Elasticsearch 实例 URL(s) - 支持单个 URL 或逗号分隔的多个 URL（兼容旧版 HOST） | 是 | | ES_API_KEY | 用于身份验证的 Elasticsearch API 密钥（兼容旧版 API_KEY） | 否 | | ES_USERNAME | 用于基本身份验证的 Elasticsearch 用户名（兼容旧版 USERNAME） | 否 | | ES_PASSWORD | 用于基本身份验证的 Elasticsearch 密码（兼容旧版 PASSWORD） | 否 | | ES_CA_CERT | Elasticsearch SSL/TLS 的自定义 CA 证书路径（兼容旧版 CA_CERT） | 否 |

多URL配置

您可以配置多个 Elasticsearch 节点以实现高可用性和负载均衡：

{
  "mcpServers": {
    "elasticsearch-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@awesome-ai/elasticsearch-mcp"
      ],
      "env": {
        "ES_HOST": "https://es-node1:9200,https://es-node2:9200,https://es-node3:9200",
        "ES_API_KEY": "your-api-key"
      }
    }
  }
}

客户端将自动处理配置节点之间的故障转移和负载均衡。

本地开发

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

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

   nvm use

2. 安装依赖

   npm install

3. 构建项目

   npm run build

4. 在 Claude Desktop 应用中本地运行

   • 打开 Claude Desktop 应用
   • 转到 Settings > Developer > MCP Servers
   • 点击 Edit Config 并添加一个新的 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"
         }
       }
     }
   }

5. 在 Cursor 编辑器中本地运行

   • 打开 Cursor 编辑器
   • 转到 Cursor Settings > MCP
   • 点击 Add new global MCP Server 并添加一个新的 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"
         }
       }
     }
   }

6. 使用 MCP Inspector 进行调试

   ES_HOST=your-elasticsearch-url ES_API_KEY=your-api-key npm run inspector

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

   Starting MCP inspector...
   ⚙️ Proxy server listening on port 6277
   🔍 MCP Inspector is up and running at http://127.0.0.1:6274 🚀

使用示例

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

集群管理

• "我的 Elasticsearch 集群的健康状态如何？"
• "集群中有多少个活跃节点？"

索引操作

• "我的 Elasticsearch 集群中有哪些索引？"
• "创建一个名为 'users' 的新索引，有 3 个分片和 1 个副本。"
• "将数据从 'old_index' 重新索引到 'new_index'。"

映射管理

• "显示 'products' 索引的字段映射。"
• "向 'products' 索引添加一个名为 'tags' 的关键字类型字段。"

搜索与数据操作

• "查找上个月超过 500 美元的所有订单。"
• "哪些产品收到了最多的五星评价？"
• "将这些客户记录批量导入到 'customers' 索引中。"

模板管理

• "为日志创建模式为 'logs-*' 的索引模板。"
• "显示我所有的索引模板。"
• "删除 'outdated_template' 索引模板。"

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