OpenSearch MCP Server

OpenSearch MCP Server

site icon
2025.04.03 1
PythonOpenSearch 集成数据库管理数据库
OpenSearch MCP Server 是一个用于 OpenSearch 集成的 MCP(Model Context Protocol)服务器,灵感来源于 elasticsearch-mcp-server。它提供了索引管理、集群管理和文档工具等功能,适用于需要与 OpenSearch 集群进行交互的场景。
View on GitHub

Overview

基本能力

产品定位

OpenSearch MCP Server 是一个用于 OpenSearch 集成的 MCP 服务器,提供了一系列工具来管理和查询 OpenSearch 集群。

核心功能

  • 索引管理工具
  • 列出 OpenSearch 集群中的所有索引
  • 获取索引映射
  • 获取索引设置
  • 集群管理工具
  • 获取集群健康状态
  • 获取集群统计信息
  • 文档工具
  • 搜索文档

适用场景

  • 需要管理和监控 OpenSearch 集群的场景
  • 需要查询和操作 OpenSearch 中的文档的场景
  • 需要与 OpenSearch 集群进行集成的开发场景

工具列表

  • 索引管理工具:用于管理和查询 OpenSearch 中的索引。
  • 集群管理工具:用于监控和管理 OpenSearch 集群的状态和统计信息。
  • 文档工具:用于搜索和操作 OpenSearch 中的文档。

常见问题解答

使用教程

使用依赖

  1. 确保已安装 Python 和 git。
  2. 创建一个虚拟环境并激活它。
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

安装教程

  1. 克隆仓库并进入项目目录。
git clone https://github.com/your-username/opensearch-mcp-server.git
cd opensearch-mcp-server
  1. 安装依赖。
pip install uv
uv pip install -e .
  1. 创建 .env 文件并配置 OpenSearch 连接信息。
OPENSEARCH_HOST=https://localhost:9200
OPENSEARCH_USERNAME=xxxx
OPENSEARCH_PASSWORD=xxxx

调试方式

  1. 运行 MCP 服务器。
uv run opensearch-mcp-server --port=<port>
  1. 测试与 Cursor 或 Claude Desktop APP 的集成。
{
  "mcpServers": {
    "opensearch": {
      "url": "http://<host>:<port>>/sse"
    }
  }
}

{
  "mcpServers": {
    "opensearch": {
      "command": "uv",
      "args": [
          "--directory",
          "/absolute/path/to/opensearch-mcp-server",
          "run",
          "opensearch-mcp-server"
      ]
    }
  }
}
  1. 运行测试。
uv run pytest -vv -s test_opensearch.py

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。