OpenSearch MCP Server
by showjason
The OpenSearch MCP Server provides Model Context Protocol integration for OpenSearch, inspired by elasticsearch-mcp-server. It offers tools for managing indices, clusters, and documents within an OpenSearch cluster.
Last updated: N/A
What is OpenSearch MCP Server?
The OpenSearch MCP Server is a tool that allows you to manage and interact with your OpenSearch cluster using the Model Context Protocol. It provides functionalities to list indices, get mappings and settings, retrieve cluster health and statistics, and search documents.
How to use OpenSearch MCP Server?
First, clone the repository and create a virtual environment. Install the required dependencies using uv pip install -e .
. Configure the server by creating a .env
file with your OpenSearch credentials. Finally, run the server using uv run opensearch-mcp-server --port=<port>
. Integrate with Cursor or Claude Desktop APP by following the instructions provided in the README.
Key features of OpenSearch MCP Server
List all indices in OpenSearch cluster
Get index mapping
Get index settings
Get cluster health status
Get cluster statistics
Search documents
Use cases of OpenSearch MCP Server
Monitoring OpenSearch cluster health
Managing indices and their configurations
Searching for specific documents within indices
Integrating OpenSearch with Cursor IDE
Integrating OpenSearch with Claude Desktop APP
FAQ from OpenSearch MCP Server
What is MCP?
What is MCP?
MCP stands for Model Context Protocol, a protocol used for communication between applications.
How do I configure the server?
How do I configure the server?
Create a .env
file in the root directory with your OpenSearch host, username, and password.
What is the default port?
What is the default port?
The port is specified when running the server using the --port
argument.
How do I run tests?
How do I run tests?
Run the tests using the command uv run pytest -vv -s test_opensearch.py
.
Where can I find the license?
Where can I find the license?
The license is available in the LICENSE
file.