- OpenSearch MCP Server
- Installing opensearch-mcp-server-py
- Available tools
- User Guide
- Contributing
- Code of Conduct
- License
- Copyright
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 Server-Sent Events (SSE) protocols.
Key features:
- Seamless integration with AI assistants and LLMs through the MCP protocol
- Support for both stdio and SSE server transports
- Built-in tools for common OpenSearch operations
- Easy integration with Claude Desktop and LangChain
- Secure authentication using basic auth or IAM roles
Opensearch-mcp-server-py can be installed from PyPI via pip:
pip install opensearch-mcp-server-py
- 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
For detailed usage instructions, configuration options, and examples, please see the User Guide.
Interested in contributing? Check out our:
- Development Guide - Setup your development environment
- Contributing Guidelines - Learn how to contribute
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.
This project is licensed under the Apache v2.0 License.
Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.