OpenSearch MCP Server
Featuredby
A Model Context Protocol server that lets AI assistants interact with OpenSearch clusters to perform searches, retrieve mappings, manage shards, and execute a wide range of cluster‑level operations via stdio or streaming transports.
OpenSearch MCP Server Overview
What is OpenSearch MCP Server?
OpenSearch MCP Server enables AI models and agents to communicate with an OpenSearch cluster using a standardized protocol. It exposes common OpenSearch operations as tools that can be called programmatically, supporting both command‑line (stdio) and streaming (SSE/HTTP) interfaces.
How to use OpenSearch MCP Server?
- Install the package from PyPI:
pip install opensearch-mcp-server-py - Run the server (e.g.,
python -m opensearch_mcp_server). - Connect an AI assistant (Claude Desktop, LangChain, etc.) to the server using the MCP endpoint.
- Call the enabled tools—such as
ListIndexTool,SearchIndexTool,ClusterHealthTool—by providing the required parameters (e.g.,opensearch_url,index,query). - Optional: disable or enable additional tool categories via environment variables (e.g.,
OPENSEARCH_DISABLED_CATEGORIES=core_tools).
Key Features
- MCP integration allowing seamless calls from LLMs.
- Dual transport: stdio for local scripts and streaming (SSE/Streamable HTTP) for networked clients.
- Core toolset out‑of‑the‑box: list indices, get mappings, search, shard info, cluster health, count, explain, multi‑search.
- Extended toolset (disabled by default) for deeper diagnostics: cluster state, segments, node metrics, allocation, long‑running tasks, etc.
- Authentication support via basic auth or IAM roles.
- Easy plug‑in with Claude Desktop and LangChain.
Use Cases
- AI‑driven search assistants that answer user queries by directly querying an OpenSearch index.
- Automated cluster monitoring where an LLM can request health, shard allocation, or long‑running tasks information.
- Self‑service data exploration for non‑technical users, powered by conversational agents.
- DevOps chatops that let engineers issue search or admin commands through chat interfaces.
FAQ
Q: Which transport should I use? A: Use stdio for local testing or scripting; choose SSE/Streamable HTTP for web‑based or remote clients.
Q: How can I enable the additional tools?
A: Set the OPENSEARCH_TOOL_FILTER environment variable or adjust the tool configuration in USER_GUIDE.md to include the desired categories.
Q: Do I need an AWS account? A: No, the server works with any OpenSearch cluster, but IAM authentication is available for AWS‑hosted deployments.
Q: How is security handled? A: Provide credentials via basic auth headers or configure IAM role‑based access; the server forwards these to the underlying OpenSearch endpoint.
Q: Can I customize the tool list?
A: Yes, tools are organized into categories; you can disable the whole core_tools category or create custom categories, respecting the naming rule that core_tools is reserved.
OpenSearch MCP Server's README
- OpenSearch MCP Server
- Installing opensearch-mcp-server-py
- Available tools
- User Guide
- Contributing
- Code of Conduct
- License
- Copyright
OpenSearch MCP Server
opensearch-mcp-server-py is a Model Context Protocol (MCP) server for OpenSearch that enables AI assistants to interact with OpenSearch clusters. It provides a standardized interface for AI models to perform operations like searching indices, retrieving mappings, and managing shards through both stdio and streaming (SSE/Streamable HTTP) protocols.
Key features:
- Seamless integration with AI assistants and LLMs through the MCP protocol
- Support for both stdio and streaming server transports (SSE and Streamable HTTP)
- Built-in tools for common OpenSearch operations
- Easy integration with Claude Desktop and LangChain
- Secure authentication using basic auth or IAM roles
Installing opensearch-mcp-server-py
Opensearch-mcp-server-py can be installed from PyPI via pip:
pip install opensearch-mcp-server-py
Available Tools
By default, only core tools are enabled to provide essential OpenSearch functionality:
Core Tools (Enabled by Default)
Core tools are grouped under the core_tools category and can be disabled at once using OPENSEARCH_DISABLED_CATEGORIES=core_tools. Avoid creating custom categories with this name as they will override the built-in category.
- ListIndexTool: Lists all indices in OpenSearch with full information including docs.count, docs.deleted, store.size, etc. If an index parameter is provided, returns detailed information about that specific index.
- 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.
- ClusterHealthTool: Returns basic information about the health of the cluster.
- CountTool: Returns number of documents matching a query.
- ExplainTool: Returns information about why a specific document matches (or doesn't match) a query.
- MsearchTool: Allows to execute several search operations in one request.
Additional Tools (Disabled by Default)
The following tools are available but disabled by default. To enable them, see the Tool Filter section in the User Guide.
- GetClusterStateTool: Gets the current state of the cluster including node information, index settings, and more.
- GetSegmentsTool: Gets information about Lucene segments in indices, including memory usage, document counts, and segment sizes.
- CatNodesTool: Gets information about nodes in the OpenSearch cluster, including system metrics like CPU usage, memory, disk space, and node roles.
- GetNodesTool: Gets detailed information about nodes in the OpenSearch cluster, including static information like host system details, JVM info, processor type, node settings, thread pools, installed plugins, and more.
- GetIndexInfoTool: Gets detailed information about an index including mappings, settings, and aliases. Supports wildcards in index names.
- GetIndexStatsTool: Gets statistics about an index including document count, store size, indexing and search performance metrics.
- GetQueryInsightsTool: Gets query insights from the /_insights/top_queries endpoint, showing information about query patterns and performance.
- GetNodesHotThreadsTool: Gets information about hot threads in the cluster nodes from the /_nodes/hot_threads endpoint.
- GetAllocationTool: Gets information about shard allocation across nodes in the cluster from the /_cat/allocation endpoint.
- GetLongRunningTasksTool: Gets information about long-running tasks in the cluster, sorted by running time in descending order.
Tool Parameters
-
ListIndexTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(optional): The name of the index to get detailed information for. If provided, returns detailed information about this specific index instead of listing all indices.
-
IndexMappingTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to retrieve mappings for
-
SearchIndexTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to search inquery(required): The search query in OpenSearch Query DSL format
-
GetShardsTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to get shard information for
-
ClusterHealthTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(optional): Limit health reporting to a specific index
-
CountTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(optional): The name of the index to count documents inbody(optional): Query in JSON format to filter documents
-
ExplainTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to retrieve the document fromid(required): The document ID to explainbody(required): Query in JSON format to explain against the document
-
MsearchTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(optional): Default index to search inbody(required): Multi-search request body in NDJSON format
-
GetClusterStateTool
opensearch_url(optional): The OpenSearch cluster URL to connect tometric(optional): Limit the information returned to the specified metrics. Options include: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, versionindex(optional): Limit the information returned to the specified indices
-
GetSegmentsTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(optional): Limit the information returned to the specified indices. If not provided, returns segments for all indices
-
CatNodesTool
opensearch_url(optional): The OpenSearch cluster URL to connect tometrics(optional): A comma-separated list of metrics to display. Available metrics include: id, name, ip, port, role, master, heap.percent, ram.percent, cpu, load_1m, load_5m, load_15m, disk.total, disk.used, disk.avail, disk.used_percent
-
GetNodesTool
opensearch_url(optional): The OpenSearch cluster URL to connect tonode_id(optional): A comma-separated list of node IDs or names to limit the returned information. Supports node filters like _local, _master, master:true, data:false, etc. Defaults to _all.metric(optional): A comma-separated list of metric groups to include in the response. Options include: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, aggregations, indices. Defaults to all metrics.
-
GetIndexInfoTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to get detailed information for. Wildcards are supported.
-
GetIndexStatsTool
opensearch_url(optional): The OpenSearch cluster URL to connect toindex(required): The name of the index to get statistics for. Wildcards are supported.metric(optional): Limit the information returned to the specified metrics. Options include: _all, completion, docs, fielddata, flush, get, indexing, merge, query_cache, refresh, request_cache, search, segments, store, warmer, bulk
-
GetQueryInsightsTool
opensearch_url(optional): The OpenSearch cluster URL to connect to
-
GetNodesHotThreadsTool
opensearch_url(optional): The OpenSearch cluster URL to connect to
-
GetAllocationTool
opensearch_url(optional): The OpenSearch cluster URL to connect to
-
GetLongRunningTasksTool
opensearch_url(optional): The OpenSearch cluster URL to connect tolimit(optional): The maximum number of tasks to return. Default is 10.
More tools coming soon. Click here
User Guide
For detailed usage instructions, configuration options, and examples, please see the User Guide.
Contributing
Interested in contributing? Check out our:
- Development Guide - Setup your development environment
- Contributing Guidelines - Learn how to contribute
Code of Conduct
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
License
This project is licensed under the Apache v2.0 License.
Copyright
Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
OpenSearch MCP Server Reviews
Login Required
Please log in to share your review and rating for this MCP.
Actions
OpenSearch MCP Server's Information
- Author
- opensearch-project
- Category
- Search
- Language
- Python
- License
- Apache License 2.0
- Stars
- 55
- Updated
- 1 month ago
Similar MCP Servers like OpenSearch MCP Server
Explore related MCPs that share similar capabilities and solve comparable challenges
Exa MCP Server
by exa-labs
Provides real-time web search capabilities to AI assistants via a Model Context Protocol server, enabling safe and controlled access to the Exa AI Search API.
Perplexity Ask
by perplexityai
Enables Claude and other MCP‑compatible applications to perform real‑time web searches through the Perplexity (Sonar) API without leaving the MCP ecosystem.
Microsoft Learn MCP Server
by MicrosoftDocs
Provides semantic search and fetch capabilities for Microsoft official documentation, returning content in markdown format via a lightweight streamable HTTP transport for AI agents and development tools.
Elasticsearch MCP Server
by elastic
Enables natural‑language interaction with Elasticsearch indices via the Model Context Protocol, exposing tools for listing indices, fetching mappings, performing searches, running ES|QL queries, and retrieving shard information.
Graphlit MCP Server
by graphlit
Enables integration between MCP clients and the Graphlit platform, providing ingestion, extraction, retrieval, and RAG capabilities across a wide range of data sources and connectors.
Everything Search
by mamertofabian
Fast cross‑platform file searching leveraging the Everything SDK on Windows, Spotlight on macOS, and locate/plocate on Linux.
Elasticsearch OpenSearch MCP Server
by cr7258
Provides Elasticsearch and OpenSearch interaction via Model Context Protocol, enabling document search, index management, cluster monitoring, and alias operations.
Kagi MCP Server
by kagisearch
Provides web search and video summarization capabilities through the Model Context Protocol, enabling AI assistants like Claude to perform queries and summarizations.
MCP Compass
by liuyoshio
Provides natural‑language search and recommendation for Model Context Protocol servers, delivering rich metadata and real‑time updates.