opensearch-mcp-server
Allows LangChain agents to use OpenSearch MCP tools via SSE transport.
Provides tools to list indices, retrieve index mappings, search using DSL, and get shard information.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@opensearch-mcp-server list all indices"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
NOTICE: This project has been graduated and moved to the opensearch-mcp-server-py repository. See you there! This repository is now archived.
OpenSearch MCP Server
A minimal Model Context Protocol (MCP) server for OpenSearch exposing 4 tools over stdio and sse server.
Available tools
ListIndexTool: Lists all indices in OpenSearch.
IndexMappingTool: Retrieves index mapping and setting information for an index in OpenSearch.
SearchIndexTool: Searches an index using a query written in query domain-specific language (DSL) in OpenSearch.
GetShardsTool: Gets information about shards in OpenSearch.
More tools coming soon. Click here
Related MCP server: Elastic MCP Server
User Guide
Installation
Install from PyPI:
pip install test-opensearch-mcpConfiguration
Authentication Methods:
Basic Authentication
export OPENSEARCH_URL="<your_opensearch_domain_url>"
export OPENSEARCH_USERNAME="<your_opensearch_domain_username>"
export OPENSEARCH_PASSWORD="<your_opensearch_domain_password>"IAM Role Authentication
export OPENSEARCH_URL="<your_opensearch_domain_url>"
export AWS_REGION="<your_aws_region>"
export AWS_ACCESS_KEY="<your_aws_access_key>"
export AWS_SECRET_ACCESS_KEY="<your_aws_secret_access_key>"
export AWS_SESSION_TOKEN="<your_aws_session_token>"Running the Server
# Stdio Server
python -m mcp_server_opensearch
# SSE Server
python -m mcp_server_opensearch --transport sseClaude Desktop Integration
Using the Published PyPI Package (Recommended)
{
"mcpServers": {
"opensearch-mcp-server": {
"command": "uvx",
"args": [
"test-opensearch-mcp"
],
"env": {
// Required
"OPENSEARCH_URL": "<your_opensearch_domain_url>",
// For Basic Authentication
"OPENSEARCH_USERNAME": "<your_opensearch_domain_username>",
"OPENSEARCH_PASSWORD": "<your_opensearch_domain_password>",
// For IAM Role Authentication
"AWS_REGION": "<your_aws_region>",
"AWS_ACCESS_KEY": "<your_aws_access_key>",
"AWS_SECRET_ACCESS_KEY": "<your_aws_secret_access_key>",
"AWS_SESSION_TOKEN": "<your_aws_session_token>"
}
}
}
}Using the Installed Package (via pip):
{
"mcpServers": {
"opensearch-mcp-server": {
"command": "python", // Or full path to python with PyPI package installed
"args": [
"-m",
"mcp_server_opensearch"
],
"env": {
// Required
"OPENSEARCH_URL": "<your_opensearch_domain_url>",
// For Basic Authentication
"OPENSEARCH_USERNAME": "<your_opensearch_domain_username>",
"OPENSEARCH_PASSWORD": "<your_opensearch_domain_password>",
// For IAM Role Authentication
"AWS_REGION": "<your_aws_region>",
"AWS_ACCESS_KEY": "<your_aws_access_key>",
"AWS_SECRET_ACCESS_KEY": "<your_aws_secret_access_key>",
"AWS_SESSION_TOKEN": "<your_aws_session_token>"
}
}
}
}LangChain Integration
The OpenSearch MCP server can be easily integrated with LangChain using the SSE server transport
Prerequisites
Install required packages
pip install langchain langchain-mcp-adapters langchain-openaiSet up OpenAI API key
export OPENAI_API_KEY="<your-openai-key>"Ensure OpenSearch MCP server is running in SSE mode
python -m mcp_server_opensearch --transport sseExample Integration Script
import asyncio
from langchain_mcp_adapters.client import MultiServerMCPClient
from langchain_openai import ChatOpenAI
from langchain.agents import AgentType, initialize_agent
# Initialize LLM (can use any LangChain-compatible LLM)
model = ChatOpenAI(model="gpt-4o")
async def main():
# Connect to MCP server and create agent
async with MultiServerMCPClient({
"opensearch-mcp-server": {
"transport": "sse",
"url": "http://localhost:9900/sse", # SSE server endpoint
"headers": {
"Authorization": "Bearer secret-token",
}
}
}) as client:
tools = client.get_tools()
agent = initialize_agent(
tools=tools,
llm=model,
agent=AgentType.OPENAI_FUNCTIONS,
verbose=True, # Enables detailed output of the agent's thought process
)
# Example query
await agent.ainvoke({"input": "List all indices"})
if __name__ == "__main__":
asyncio.run(main())Notes:
The script is compatible with any LLM that integrates with LangChain and supports tool calling
Make sure the OpenSearch MCP server is running before executing the script
Configure authentication and environment variables as needed
Development
Interested in contributing? Check out our:
Development Guide - Setup your development environment
Contributing Guidelines - Learn how to contribute
Available Tools
4 toolsGetShardsToolC
Gets information about shards in OpenSearch
Inputs: index (required).
IndexMappingToolB
Retrieves index mapping and setting information for an index in OpenSearch
Inputs: index (required).
ListIndexToolA
Lists all indices in OpenSearch
Inputs: no named parameters.
SearchIndexToolB
Searches an index using a query written in query domain-specific language (DSL) in OpenSearch
Inputs: index (required), query (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 4 tools
Each tool targets a distinct OpenSearch resource: indices, index mappings, search results, and shard info. There is no overlap, and the descriptions clearly delineate their purposes.
Most tool names follow a verb-noun pattern (ListIndex, SearchIndex, GetShards), but IndexMappingTool deviates by leading with a noun. The consistent 'Tool' suffix helps, but the mixed pattern is a minor inconsistency.
The 4 tools are well-scoped for an OpenSearch read-only server focusing on index and shard inspection. Each tool has a clear purpose, and the count fits within the ideal 3-15 range.
The tool surface lacks fundamental OpenSearch operations such as creating or deleting indices, indexing, or retrieving documents. This makes the server suitable only for inspection tasks, leaving significant gaps for common workflows.
Maintenance
Related MCP Connectors
Manage Bonsai Elasticsearch and OpenSearch clusters, and search their data.
Build and manage Elasticsearch REST APIs: models, endpoints, API keys and deploys.
Search multiple indices, index data, and get personalized recommendations
Provides capabilities that let LLM agents perform a range of infrastructure management tasks.
Related MCP Servers
- AlicenseNot gradedqualityFmaintenance* Index Management Tools: * List all indices in OpenSearch cluster * Get index mapping * Get index settings * Cluster Management Tools: * Get cluster health status * Get cluster statistics * Document Tools: * Search documents2MIT
- FlicenseBqualityNot gradedmaintenanceProvides comprehensive tools for managing Elasticsearch clusters, including security management, search operations, and index administration. It enables users to monitor cluster health, handle InfoSec tasks, and execute complex queries using Elasticsearch Query DSL and ES|QL.37-
- FlicenseNot gradedqualityDmaintenanceEnables LLMs to interact with OpenSearch clusters to monitor cluster health, manage indices, and perform data searches. It provides a standardized interface for real-time OpenSearch operations within MCP-compatible environments like Open WebUI.-
- AlicenseNot gradedqualityDmaintenanceProvides tools to query Elasticsearch indices, retrieve mappings, execute searches, and get cluster health stats.4MIT