Opensearch MCP Server Zf2

🚀 OpenSearch MCP Server

An OpenSearch integrated MCP (Model Context Protocol) server developed in collaboration with elasticsearch-mcp-server.

🚀 Quick Start

This is an OpenSearch integrated MCP server. It provides a series of tools for managing OpenSearch clusters, indices, and documents.

✨ Features

• Index Management Tools:
  • List all indices in the OpenSearch cluster.
  • Get index mappings.
  • Get index settings.
• Cluster Management Tools:
  • Get the cluster health status.
  • Get cluster statistics.
• Document Tools:
  • Search documents.

📦 Installation

# Clone the repository
git clone https://github.com/your-username/opensearch-mcp-server.git
cd opensearch-mcp-server

# Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate  # Use .venv\Scripts\activate for Windows

# Install packages
pip install uv
uv pip install -e .

📚 Documentation

Configuration Guide

Create a file named .env in the project root directory and add the following variables:

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

Adjust these values according to your OpenSearch configuration.

Usage Instructions (Integration with Cursor)

Start the MCP Server

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

Configure Cursor Connection

Configure Cursor as follows:

{
  "mcpServers": {
    "opensearch": {
      "url": "http://<host>:<port>/sse"
    }
  }
}

Usage Instructions (Integration with Claude Desktop APP)

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

Development Guide

# Install dependencies
uv pip install -e .

# Run tests
uv run pytest -vv -s test_opensearch.py

📄 License

MIT