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"
      }
    }
  }
}

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

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

现在，您可以使用自然语言命令（例如：

• “列出集群中的所有索引”
• “学生 Bob 几岁了？”
• “显示集群健康状态”）通过 Claude 与您的 Opensearch 集群进行交互。

许可证

该项目已获得 Apache License Version 2.0 许可 - 有关详细信息，请参阅 LICENSE 文件。