Elasticsearch MCP 服务器

此项目实现了一个用于Elasticsearch的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}：获取特定索引的映射信息

先决条件

• 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 集群交互。

测试资源

所有资源都包含适当的错误处理和验证：

• 如果索引不存在，资源将返回适当的错误消息
• 如果连接到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文件。