Es MCP Server

🚀 Elasticsearch MCP Server

This project implements an MCP (Model Context Protocol) server for Elasticsearch, providing tools and resources to interact with Elasticsearch clusters.

🚀 Quick Start

The Elasticsearch MCP Server is a powerful tool that enables seamless interaction with Elasticsearch clusters. It provides a set of tools and resources to manage indices, mappings, and perform searches.

✨ Features

Tools

• list_indices: List all indices in the Elasticsearch cluster.
• get_mappings: Get the mapping information for a specific index.
• search: Perform an Elasticsearch search using the provided query DSL.
• search_with_query_string: Perform a search using a simple query string.
• get_index_stats: Get the statistical information for a specific index.

Resources

• elasticsearch://indices: List all Elasticsearch indices.
• elasticsearch://index/{index_name}: Get detailed information about a specific index.
• elasticsearch://mapping/{index_name}: Get the mapping information for a specific index.

📦 Installation

Prerequisites

• Python 3.7+
• Elasticsearch Python client
• MCP SDK
• Elasticsearch cluster credentials (Cloud ID and API Key)

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/elasticsearch-mcp-server.git
   cd elasticsearch-mcp-server
   

2. Install the required dependencies:

   pip install -r requirements.txt
   

3. Configure environment variables:

   • Copy the example environment file: cp .env.example .env
   • Edit the .env file and add your Elasticsearch credentials.

   Or set them directly in the shell:

   export ES_CLOUD_ID=your_elasticsearch_cloud_id
   export ES_API_KEY=your_elasticsearch_api_key
   

💻 Usage Examples

Configure the MCP Server for Claude

The configure_mcp_server.py script helps you set up the Elasticsearch MCP server in Claude's MCP configuration file. This allows Claude to connect to your Elasticsearch cluster through the MCP server.

python configure_mcp_server.py your_cloud_id your_api_key

This script:

1. Obtains your Elasticsearch Cloud ID and API Key using command-line arguments.
2. Finds or creates Claude's MCP settings file.
3. Adds or updates the Elasticsearch MCP server configuration.
4. Sets the environment variables required for the server to connect to your Elasticsearch cluster.

After running this script, restart VS Code to apply the changes. Claude will be able to interact with your Elasticsearch cluster through the MCP server.

📚 Documentation

Testing Resources

All resources include appropriate error handling and validation:

• If an index does not exist, the resource will return an appropriate error message.
• If there is a problem connecting to Elasticsearch, the resource will return an error message.
• All exceptions are caught and returned as readable error messages.

🤝 Contribution

Contributions are welcome! Here's how you can contribute:

1. Fork the repository.
2. Create a feature branch: git checkout -b feature/your-feature-name.
3. Commit your changes: git commit -am 'Add some feature'.
4. Push to the branch: git push origin feature/your-feature-name.
5. Submit a pull request.

🌐 GitHub Repository

This project is ready to be uploaded to GitHub. The repository includes:

• A .gitignore file to exclude sensitive information and logs.
• A .env.example file to guide users in setting up environment variables.
• A requirements.txt file listing the dependencies.
• A LICENSE file containing the MIT license.
• A fully documented README.md.

📄 License

This project is released under the MIT License. For more details, please refer to the LICENSE file.