使用说明

项目简介

本项目 'Opensearch MCP Server' 是一个基于 Model Context Protocol (MCP) 实现的服务器，旨在为大型语言模型 (LLM) 应用提供与 Opensearch 搜索引擎交互的能力。通过 MCP 协议，LLM 客户端可以调用服务器提供的工具，实现对 Opensearch 数据的访问和管理，从而扩展 LLM 应用的功能边界。

主要功能点

索引管理:
- 列出 Opensearch 集群中的所有索引。
- 获取指定索引的 Mapping 信息。
- 获取指定索引的 Settings 信息。
文档操作:
- 在指定的 Opensearch 索引中执行自定义查询，检索文档。
集群监控:
- 获取 Opensearch 集群的健康状态，了解集群运行状况。
- 获取集群的统计信息，包括节点、索引、存储等详细数据。

安装步骤

克隆仓库

git clone https://github.com/Jimmy974/opensearch-mcp-server.git
cd opensearch-mcp-server

创建并激活虚拟环境 (推荐)

python3 -m venv venv
source venv/bin/activate  # 或根据你的系统使用 venv\Scripts\activate

安装依赖 虽然仓库中没有 'requirements.txt' 文件，但根据代码分析，你需要安装以下 Python 包。你可以手动创建 'requirements.txt' 文件，并添加以下内容：

fastmcp
opensearch-py
python-dotenv

然后使用 pip 安装依赖：

pip install -r requirements.txt

或者直接使用 pip 命令安装：

pip install fastmcp opensearch-py python-dotenv

配置 Opensearch 连接信息 在项目根目录下创建 '.env' 文件，并配置 Opensearch 连接信息，例如：

OPENSEARCH_HOST=https://your_opensearch_host:9200  # 替换为你的 Opensearch 地址
OPENSEARCH_USERNAME=your_opensearch_username      # 替换为你的 Opensearch 用户名
OPENSEARCH_PASSWORD=your_opensearch_password      # 替换为你的 Opensearch 密码

请确保 Opensearch 服务可访问，并提供正确的用户名和密码。

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 'Opensearch MCP Server'。

{
  "server_name": "opensearch_mcp_server",
  "command": "python3",
  "args": ["-m", "opensearch_mcp_server.server"]
}

'server_name': 服务器名称，客户端用以识别，可以自定义设置。
'command': 启动服务器的命令，这里使用 'python3' 解释器。
'args': 传递给 'python3' 命令的参数，'["-m", "opensearch_mcp_server.server"]' 表示以模块方式运行 'opensearch_mcp_server.server'，即执行服务器主程序。

基本使用方法

启动服务器 在项目根目录下，运行以下命令启动 'Opensearch MCP Server'：
```
python3 -m opensearch_mcp_server.server
```
服务器成功启动后，将监听 MCP 客户端的请求。
客户端调用工具 配置 MCP 客户端连接到 'Opensearch MCP Server'，客户端可以调用服务器提供的工具来操作 Opensearch。例如，客户端可以调用 'list_indices' 工具列出索引，或调用 'search_documents' 工具执行文档搜索。具体的工具调用方法和参数，请参考 MCP 客户端的文档和 'Opensearch MCP Server' 提供的工具描述 (description)。

例如，使用 MCP 客户端调用 'search_documents' 工具时，需要提供 'index' (索引名称) 和 'body' (Opensearch 查询 DSL) 作为参数。服务器会将查询结果封装成 MCP 响应返回给客户端。

请参考 MCP 客户端的详细使用说明，以了解如何连接和调用 MCP 服务器提供的工具。

关键词