OpenSearch MCP Server

OpenSearch MCP 服务

概述

这是从 elastic-mcp-server 分叉并转换为 opensearch-mcp-server 的 MCP 服务。这是一个模型上下文协议（MCP）服务实现，可与 opensearch 交互。该服务通过一组工具支持搜索文档、分析索引和管理集群。

这是一个模型上下文协议（MCP）服务实现，可与 opensearch 交互。该服务通过一组工具支持搜索文档、分析索引和管理集群。

功能

索引操作

• list_indices：列出 Opensearch 集群中的所有索引。
• get_mapping：获取指定索引的映射配置。
• get_settings：获取指定索引的设置配置。

文档操作

• search_documents：使用 Opensearch Query DSL 搜索索引中的文档。

集群操作

• get_cluster_health：获取集群的健康状态。
• get_cluster_stats：获取集群的统计信息。

启动 Opensearch 集群

使用 Docker Compose 启动 Opensearch 集群：

docker-compose up -d

这将启动一个包含 3 个节点的 Opensearch 集群和 Kibana。默认的 Opensearch 用户名为 opensearch，密码为 test123。

你可以通过 http://localhost:5601 访问 Kibana。

与 Claude Desktop 搭配使用

在本地开发中使用 uv

使用 uv 需要在本地克隆代码仓库，并指定源代码的路径。将以下配置添加到 Claude Desktop 的配置文件 claude_desktop_config.json 中。

你需要将 path/to/src/opensearch_mcp_server 改为你克隆代码仓库的路径。

{
  "mcpServers": {
    "opensearch": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/src/opensearch_mcp_server",
        "run",
        "opensearch-mcp-server"
      ],
      "env": {
        "OPENSEARCH_HOST": "https://localhost:9200",
        "OPENSEARCH_USERNAME": "opensearch",
        "OPENSEARCH_PASSWORD": "test123",
        "DASHBOARDS_HOST": "https://localhost:5601"
      }
    }
  }
}

• 在 macOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

重启 Claude Desktop 以加载新的 MCP 服务。

现在，你可以通过自然语言命令与 Claude 交互并使用 Opensearch 集群，例如：

• “列出集群中的所有索引”
• “学生 Bob 多大了？”
• “显示集群的健康状态”

许可证

本项目采用 Apache License Version 2.0 许可，详情请参阅 LICENSE 文件。