Elasticsearch MCP

🚀 Elasticsearch MCP Server

Elasticsearch MCP Server is a tool for managing Elasticsearch clusters. It supports a variety of operations, including cluster health checks, index management, mapping configuration, data import/export, and template management. Integrated with the MCP client, users can conveniently interact using natural language.

🚀 Quick Start

Prerequisites

• The Elasticsearch cluster is running and accessible.
• The Node.js environment is configured.
• npm is installed and available.

Installation and Setup

1. Use the npm package:

   npm install elastic-mcp-server
   

2. Configure the MCP client:

   • Open your editor and go to the MCP settings interface.
   • Add a new global MCP server and specify the following configuration:

     {
       "mcpServers": {
         "elasticsearch-mcp": {
           "command": "node",
           "args": [
             "/path/to/your/project/dist/index.js"
           ],
           "env": {
             "ES_HOST": "your-elasticsearch-host",
             "ES_API_KEY": "your-api-key"
           }
         }
       }
     }
     

✨ Features

Available Features

• Cluster Management: View and monitor the overall status of the Elasticsearch cluster.
• Index Operations: Create, delete, and query index information.
• Mapping Configuration: Define and modify index field types.
• Data Operations: Perform complex queries, aggregation analysis, and batch import data.
• Template Management: Manage and maintain index templates.

How It Works

The MCP client sends requests to the MCP server, which parses and executes the corresponding Elasticsearch operations. Users can interact with the MCP client through natural language or the command line to complete management tasks for the Elasticsearch cluster.

💻 Local Development

1. Use the correct Node.js version:

   nvm use
   

2. Install dependencies:

   npm install
   

3. Start the MCP server:

   node index.js
   

⚙️ Configuration Options

The following environment variables can configure the behavior of the MCP server:

💻 Usage Examples

Basic Usage

You can use natural - language queries to interact with the Elasticsearch MCP Server. Here are some example queries:

Cluster Management

• "What is the health status of my Elasticsearch cluster?"
• "How many active nodes are there in the cluster?"

Index Operations

• "What Elasticsearch indexes do I have?"
• "Create a new index named 'users' with 3 shards and 1 replica."
• "Reindex data from 'old_index' to 'new_index'."

Mapping Configuration

• "View the mapping information of the 'users' index."
• "Add an integer type constraint for the 'age' field."

Data Operations

• "Find all users older than 30."
• "Count the number of user logins in the past week."
• "Batch import a batch of new user data."

Template Management

• "List all current index templates."
• "Apply a specified template to a newly created index."

With these features, the Elasticsearch MCP Server provides users with an efficient and convenient way to manage and operate Elasticsearch clusters. Both developers and operations engineers can benefit from it and improve work efficiency.