OpenSearch MCP <> LLM Integration Guide

OpenSearch MCP <> 大模型集成指南

本指南将逐步说明如何使用 MCP 服务，将 Amazon Q 和 Anthropic Claude 桌面应用与 OpenSearch 集成，以便通过自然语言进行交互。

Anthropic Claude

Amazon Q

前置条件

• 已安装 Docker 和 Docker Compose
• 已安装 Python 3.x
• 已安装 pipx（pip install pipx）
• Amazon Q CLI
• Anthropic Claude Desktop

1. 设置本地 OpenSearch 实例

1. 为项目创建一个新目录：

   mkdir opensearch-mcp && cd opensearch-mcp
   

2. 创建包含以下内容的 docker-compose.yml 文件：

   version: '3'
   services:
     opensearch:
       image: opensearchproject/opensearch:latest
       environment:
         - discovery.type=single-node
         - bootstrap.memory_lock=true
         - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
         - "OPENSEARCH_INITIAL_ADMIN_PASSWORD=myStrongPassword123!"
         - "plugins.security.ssl.http.enabled=true"
         - "plugins.security.ssl.transport.enabled=true"
         - "plugins.security.ssl.http.pemcert_filepath=certs/node.pem"
         - "plugins.security.ssl.http.pemkey_filepath=certs/node-key.pem"
         - "plugins.security.ssl.http.pemtrustedcas_filepath=certs/root-ca.pem"
         - "plugins.security.ssl.transport.pemcert_filepath=certs/node.pem"
         - "plugins.security.ssl.transport.pemkey_filepath=certs/node-key.pem"
         - "plugins.security.ssl.transport.pemtrustedcas_filepath=certs/root-ca.pem"
       ulimits:
         memlock:
           soft: -1
           hard: -1
         nofile:
           soft: 65536
           hard: 65536
       volumes:
         - opensearch-data:/usr/share/opensearch/data
         - ./certs:/usr/share/opensearch/config/certs
       ports:
         - 9200:9200
         - 9600:9600
       networks:
         - opensearch-net
   
     opensearch-dashboards:
       image: opensearchproject/opensearch-dashboards:latest
       environment:
         - 'OPENSEARCH_HOSTS=["https://opensearch:9200"]'
         - "OPENSEARCH_SSL_VERIFICATIONMODE=none"
         - "OPENSEARCH_SECURITY_ADMIN_PASSWORD=myStrongPassword123!"
         - "SERVER_SSL_ENABLED=true"
         - "SERVER_SSL_CERTIFICATE=/usr/share/opensearch-dashboards/config/certs/node.pem"
         - "SERVER_SSL_KEY=/usr/share/opensearch-dashboards/config/certs/node-key.pem"
       ports:
         - 5601:5601
       volumes:
         - ./certs:/usr/share/opensearch-dashboards/config/certs
       depends_on:
         - opensearch
       networks:
         - opensearch-net
   
   volumes:
     opensearch-data:
   
   networks:
     opensearch-net:
   

3. 启动容器：

   docker compose up -d
   

2. 安装 OpenSearch MCP 服务

1. 使用 pipx 安装 OpenSearch MCP 服务：

   pipx install opensearch-mcp-server
   

3. 使用 MCP 服务配置大模型

1. Amazon Q：在 Amazon Q 配置目录（~/.aws/amazonq/mcp.json）中创建 mcp.json 文件

2. Anthropic Claude：在 Claude Desktop 配置目录（~/Library/Application Support/Claude/claude_desktop_config.json）中创建 claude_desktop_config.json 文件

   {
     "mcpServers": {
       "opensearch-mcp-server": {
         "command": "/Users/YOUR_USERNAME/.local/bin/opensearch-mcp-server",
         "args": [],
         "env": {
           "OPENSEARCH_URL": "https://localhost:9200",
           "OPENSEARCH_SSL_VERIFY": "none",
           "OPENSEARCH_USERNAME": "admin",
           "OPENSEARCH_PASSWORD": "myStrongPassword123!"
         }
       }
     }
   }
   

   将 YOUR_USERNAME 替换为你的系统用户名，或指定安装 opensearch-mcp-server 的位置。

4. 验证设置

1. 检查 OpenSearch 是否正在运行：

   curl -XGET -u admin:myStrongPassword123! https://localhost:9200
   

2. 验证 OpenSearch Dashboards：

   • 在浏览器中打开 https://localhost:5601

3. 检查索引：

   curl -XGET -u admin:myStrongPassword123! https://localhost:9200/_cat/indices
   

5. 使用自然语言与 OpenSearch 交互

以下是一些可以在大模型中尝试的示例命令：

1. 创建索引：

   Create a new index called "books" with title and author fields
   

2. 添加文档：

   Add a document to the books index with title "The Great Gatsby" and author "F. Scott Fitzgerald"
   

3. 搜索文档：

   Search for books by F. Scott Fitzgerald
   

4. 获取索引信息：

   Show me the mapping of the books index
   

故障排除

1. 如果 MCP 服务无法初始化：

   • 检查 OpenSearch 是否正在运行（docker ps）
   • 验证 mcp_config.json 中的凭据
   • 检查 OpenSearch 日志（docker compose logs opensearch）

2. 如果工具不可用：

   • 重启大模型
   • 检查 MCP 服务日志
   • 验证 mcp_config.json 语法

可用的 MCP 工具

OpenSearch MCP 服务提供多个用于与 OpenSearch 交互的工具：

• list_indices：列出所有索引。
• get_index：返回一个或多个索引的信息（映射、设置、别名）。参数：index：索引名称
• create_index：创建新索引。参数：index：索引名称 body：可选的索引配置，包括映射和设置
• delete_index：删除索引。参数：index：索引名称
• search_documents：搜索文档。参数：index：索引名称 body：搜索查询
• index_document：在索引中创建或更新文档。参数：index：索引名称 document：文档数据 id：可选的文档 ID
• get_document：根据 ID 获取文档。参数：index：索引名称 id：文档 ID
• delete_document：根据 ID 删除文档。参数：index：索引名称 id：文档 ID
• delete_by_query：删除符合所提供查询条件的文档。参数：index：索引名称 body：用于匹配待删除文档的查询
• get_cluster_health：返回集群运行状况的基本信息。
• get_cluster_stats：返回集群统计信息的高级概览。
• list_aliases：列出所有别名。
• get_alias：获取特定索引的别名信息。参数：index：索引名称
• put_alias：为特定索引创建或更新别名。参数：index：索引名称 name：别名名称 body：别名配置
• delete_alias：删除特定索引的别名。参数：index：索引名称 name：别名名称
• general_api_request：执行通用 HTTP API 请求。对于没有专用工具的任何 Elasticsearch/OpenSearch API，请使用此工具。参数：method：HTTP 方法（GET、POST、PUT、DELETE 等） path：API 端点路径 params：查询参数 body：请求正文

安全说明

1. 在生产环境中始终使用强密码
2. 在生产环境中启用 SSL
3. 定期轮换凭证

其他资源

• OpenSearch 文档
• Amazon Q 文档
• MCP 协议文档