OpenSearch MCP服务器

OpenSearch MCP服务器允许用户通过自然语言与OpenSearch集群交互,提供集群健康状态分析、文档批量操作、索引管理及搜索功能。

  • by loupipalien
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 loupipalien/opensearch-mcp-server

使用说明

OpenSearch MCP服务器

使用模型上下文协议(MCP)直接从任何MCP客户端(如Cursor、Cline)通过自然语言与您的OpenSearch集群进行交互。
该服务器通过一组工具提供分析集群健康状态、将文档扩展到索引、获取索引映射、搜索文档等功能。

工具

簇

  • opensearch_cluster_health:获取群集运行状况
  • opensearch_cluster_stats:获取集群统计信息

文件

  • opensearch_bulk:批量编写多个文档操作
  • opensearch_get_document:从索引中获取文档

索引

  • opensearch_list_indices:列出集群中的索引
  • opensearch_create_index:使用指定的配置创建索引
  • opensearch_delete_index:按索引名称删除索引
  • opensearch_get_index:获取有关索引的信息

搜索

  • opensearch_search:使用提供的查询dsl查询索引

先决条件

在使用此mcp服务器之前,您需要安装以下组件:

  • python 3.10+或更高版本
  • 紫外线 安装

用法

选择以下任何配置以添加到您的mcp设置文件中。然后将您的opensearch集群主机(当有多个主机时用逗号分隔)、用户名和密码设置为mcp-server配置。

使用远程仓库运行

{
  "mcpServers": {
    "opensearch-mcp-server": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/loupipalien/opensearch-mcp-server",
        "opensearch-mcp-server"
      ],
      "env": {
        "OPENSEARCH_HOSTS": "your_opensearch_cluster_hosts",
        "OPENSEARCH_USERNAME": "your_opensearch_cluster_username",
        "OPENSEARCH_PASSWORD": "your_opensearch_cluster_password"
      }
    }
  }
}

使用本地仓库运行

{
  "mcpServers": {
    "opensearch-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/repo/src/opensearch_mcp_server",
        "run",
        "server.py"
      ],
      "env": {
        "OPENSEARCH_HOSTS": "your_opensearch_cluster_hosts",
        "OPENSEARCH_USERNAME": "your_opensearch_cluster_username",
        "OPENSEARCH_PASSWORD": "your_opensearch_cluster_password"
      }
    }
  }
}

启动OpenSearch集群

如果您没有OpenSearch集群,可以在本地存储库根目录中运行以下命令来启动一个集群。更多详细信息可以在 这里.
它将创建一个2节点集群和一个仪表板。默认用户名为 admin 密码为 your_opensearch_cluster_password。您可以从访问群集 https://localhost:9200 并从以下位置访问仪表板 http://localhost:5601

export OPENSEARCH_INITIAL_ADMIN_PASSWORD=your_opensearch_cluster_password

docker-compose up -d

停止集群和仪表板

docker-compose down -v

许可证

该项目根据 Apache v2.0许可证.