OpenSearch MCP 服务器

一个模型上下文协议 (MCP) 服务器，提供通过服务器发送事件 (SSE) 与 OpenSearch 集群交互的工具。此服务器能够将 OpenSearch 操作无缝集成到 AI 工作流程中。

功能

• OpenSearch 集成: 安全连接和与 OpenSearch 集群的交互
• SSE 通信: 使用服务器发送事件的实时、事件驱动的通信
• 工具套件:
  • 列出集群中的索引
  • 更多工具即将推出...

前提条件

• Python 3.12 或更高版本
• OpenSearch 集群（本地或远程）
• uv 用于依赖管理（推荐）

安装

# 安装 uv (如果尚未安装)
pip install uv

# 克隆存储库
git clone https://github.com/your-org/opensearch-mcp-sse.git
cd opensearch-mcp-sse

# 创建并激活虚拟环境
uv venv .venv
source .venv/bin/activate

# 使用 lock 文件安装依赖项（推荐用于生产）
uv pip install -r uv.lock

# 或者以可编辑模式安装以进行开发
uv pip install -e .

依赖管理

该项目使用 uv 进行依赖管理，并使用 uv.lock 文件来确保可重现的构建。lock 文件包含所有依赖项及其子依赖项的精确版本。

• pyproject.toml: 定义项目元数据和直接依赖项
• uv.lock: 包含所有依赖项（包括传递依赖项）的精确版本

要更新依赖项：

# 更新依赖项并重新生成 lock 文件
uv pip compile pyproject.toml -o uv.lock

配置

OpenSearch 连接

使用环境变量配置 OpenSearch 连接：

# 必需
export OPENSEARCH_HOST=localhost      # OpenSearch 主机
export OPENSEARCH_PORT=9200          # OpenSearch 端口

# 可选 (带有默认值)
export OPENSEARCH_USERNAME=admin     # 用于身份验证的用户名
export OPENSEARCH_PASSWORD=admin     # 用于身份验证的密码
export OPENSEARCH_USE_SSL=false      # 启用/禁用 SSL
export OPENSEARCH_VERIFY_CERTS=false # 验证 SSL 证书
export OPENSEARCH_CA_CERTS=          # CA 证书的路径

服务器配置

可以通过命令行参数配置服务器：

要运行服务器，请转到 src 文件夹并运行：

python -m server --host 0.0.0.0 --port 9900

默认值：

• 主机: 0.0.0.0 (所有接口)
• 端口: 9900
• API 密钥: secret-token

用法

启动服务器

# 使用默认配置启动
python -m server

# 使用自定义主机和端口启动
python -m server --host 127.0.0.1 --port 8080

身份验证

所有请求都必须在 Authorization 标头中包含 API 密钥：

Authorization: Bearer secret-token

可用工具

1. 列出索引 (list_indices)
   • 列出 OpenSearch 集群中的所有索引
   • 返回: 索引名称列表
   • 示例响应: ["index1", "index2", ...]

更多工具即将推出

开发

项目结构

opensearch-mcp-sse/
├── src/
│   ├── mcp_server.py    # MCP 初始化
│   ├── server.py        # 带有 SSE 和身份验证的服务器实现
│   └── opensearch/      # OpenSearch 集成
│       ├── config.py    # 配置管理
│       ├── client.py    # 具有核心操作的 OpenSearch 客户端
│       └── tools/       # MCP 工具
│           ├── list_indices.py
│           └── __init__.py
└── scripts/            # 实用程序脚本

添加新工具

1. 在 src/opensearch_mcp_sse/opensearch/tools/ 中创建一个新的工具文件
2. 在 src/opensearch_mcp_sse/server.py 中导入并注册该工具

运行脚本

# 运行脚本
python scripts/test_connection.py