Opensearch MCP Server Zf2

🚀 OpenSearch MCP 服務器

OpenSearch MCP 服務器是基於 elasticsearch-mcp-server 攜手打造的，它集成了 MCP（模型上下文協議），為用戶提供便捷的 OpenSearch 操作體驗。

🚀 快速開始

安裝

# 克隆倉庫
git clone https://github.com/your-username/opensearch-mcp-server.git
cd opensearch-mcp-server

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # Windows 系統請使用：.venv\Scripts\activate

# 安裝包
pip install uv
uv pip install -e .

配置

在項目根目錄下創建一個名為 .env 的文件，並添加以下變量：

OPENSEARCH_HOST=https://localhost:9200
OPENSEARCH_USERNAME=xxxx
OPENSEARCH_PASSWORD=xxxx

請根據你的 OpenSearch 配置調整這些值。

啟動 MCP 服務器

uv run opensearch-mcp-server --port=<端口>

與 Cursor 集成

在 Cursor 中配置如下：

{
  "mcpServers": {
    "opensearch": {
      "url": "http://<主機>:<端口>/sse"
    }
  }
}

與 Claude Desktop APP 集成

{
  "mcpServers": {
    "opensearch": {
      "command": "uv",
      "args": [
          "--directory",
          "/absolute/path/to/opensearch-mcp-server",
          "run",
          "opensearch-mcp-server"
      ]
    }
  }
}

✨ 主要特性

• 索引管理工具：
  • 可列出 OpenSearch 集群中的所有索引。
  • 能夠獲取索引映射。
  • 可以獲取索引設置。
• 集群管理工具：
  • 能獲取集群健康狀態。
  • 可獲取集群統計信息。
• 文檔工具：支持搜索文檔。

📦 安裝指南

# 克隆倉庫
git clone https://github.com/your-username/opensearch-mcp-server.git
cd opensearch-mcp-server

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # Windows 系統請使用：.venv\Scripts\activate

# 安裝包
pip install uv
uv pip install -e .

💻 使用示例

基礎用法

啟動 MCP 服務器

uv run opensearch-mcp-server --port=<端口>

與 Cursor 集成配置

{
  "mcpServers": {
    "opensearch": {
      "url": "http://<主機>:<端口>/sse"
    }
  }
}

與 Claude Desktop APP 集成配置

{
  "mcpServers": {
    "opensearch": {
      "command": "uv",
      "args": [
          "--directory",
          "/absolute/path/to/opensearch-mcp-server",
          "run",
          "opensearch-mcp-server"
      ]
    }
  }
}

📚 詳細文檔

配置指南

在項目根目錄下創建一個名為 .env 的文件，並添加以下變量：

OPENSEARCH_HOST=https://localhost:9200
OPENSEARCH_USERNAME=xxxx
OPENSEARCH_PASSWORD=xxxx

請根據你的 OpenSearch 配置調整這些值。

開發指南

# 安裝依賴
uv pip install -e .

# 運行測試
uv run pytest -vv -s test_opensearch.py

📄 許可證

MIT