byviz/mcp-server-elasticsearch-ai

🔍 Elasticsearch MCP Server AI

A Model Context Protocol (MCP) server that transforms your Elasticsearch cluster into an AI-powered observability engine.
Enables natural language interaction for analyzing logs, APM traces (with waterfall and RCA), and system metrics — delivering deep performance and troubleshooting insights with minimal effort.

💡 Demo Examples Elasticsearch MCP Server AI

• Demo APM Waterfall Trace Performance Analysis, how to analyze application traces using waterfall visualization for in-depth performance insights. Quickly identify bottlenecks, latency issues, and service dependencies in real APM data.

• Demo RCA APM (Root Cause Analysis), Demonstrates how to automatically identify the underlying causes of errors and performance issues in APM traces, providing actionable insights for rapid troubleshooting.

• Demo Perform performance analysis by APM service, Analyze and compare the performance metrics for each APM service, identifying latency, throughput, and resource bottlenecks across your architecture.

🎯 Core Value: Advanced APM Analysis

This MCP server transforms your Elasticsearch cluster into a powerful AI-driven APM analysis platform. The key differentiator is our specialized APM analysis tools that provide automated insights impossible with basic Elasticsearch queries:

🔬 APM Waterfall Analysis - analyzeTracePerformance

• Complete waterfall analysis of APM traces with visual timeline reconstruction
• Automatic correlation with system errors and infrastructure metrics
• Performance optimization recommendations based on detected patterns
• Deep bottleneck detection across microservices and dependencies
• Perfect for: Latency debugging, performance optimization, dependency analysis

🎯 APM Root Cause Analysis (RCA) - findErrorPatterns

• Temporal error analysis with automatic aggregations and pattern detection
• Intelligent Root Cause Analysis with specific, actionable recommendations
• Anomaly detection in error frequency, types, and service impact
• Automated correlation between error spikes and system events
• Perfect for: Proactive troubleshooting, stability analysis, incident prevention

🔗 Business Event Correlation - correlateBusinessEvents

• Complete user journey reconstruction across all system touchpoints
• Cross-index correlation (APM + logs + metrics + business events)
• Timeline analysis of related events with business impact assessment
• End-to-end transaction tracking from user action to system response
• Perfect for: Business impact analysis, critical flow debugging, customer experience optimization

💡 These tools implement specialized logic that's impossible with basic Elasticsearch queries, providing deep insights and automated analysis for SRE and DevOps teams. They represent the core value proposition of this MCP server.

🎯 What is this MCP Server?

This MCP server converts your Elasticsearch cluster into a powerful tool for AI assistants, enabling:

• 🔍 Intelligent searches in logs, metrics, and documents
• 📊 APM analysis to detect errors and performance issues
• 🖥️ System monitoring with CPU, memory, and disk metrics
• 🔧 Automatic diagnosis of application problems

🛠️ Available Tools (25 Tools)

🔧 Optimized APM Tools ⭐ CORE VALUE

🔍 Search and Queries

📊 Cluster Information

🗂️ Index Management

🚨 APM and Monitoring

📝 Common Parameters

🔍 Search Parameters

• q (query): Elasticsearch query string (e.g., "error AND @timestamp:>now-1h")
• size: Number of results (default: 10, recommended max: 100)
• from: Offset for pagination (default: 0)
• sort: Sorting (e.g., "@timestamp:desc", "_score:desc")
• _source: Specific fields to include (e.g., "@timestamp,message,service.name")
• timeout: Search timeout (default: "30s")

📊 Temporal Parameters

• time_range: Time range (e.g., "now-1h", "now-24h", "now-7d")
• time_window: Time window (e.g., "30m", "1h", "5m")
• @timestamp: Temporal filter in query (e.g., "@timestamp:>now-2h")

🏷️ Filtering Parameters

• index: Specific index or pattern (e.g., "logs-2024", "logs-apm.error-*")
• service_name: APM service name (e.g., "api-users", "servicio-local")
• error_type: Error type (e.g., "ConnectionError", "TimeoutError")
• level: Detail level (e.g., "cluster", "indices", "shards")

🔧 Format Parameters

• format: Output format (e.g., "json", "yaml", "text")
• v: Verbose output with headers (true/false)
• h: Specific columns to display (e.g., "index,health,status")
• s: Columns to sort by (e.g., "index:desc")

🚀 Installation

📦 From Source Code (Recommended)

Option 1: Simple Installation (Recommended for users)

# Clone repository
git clone https://github.com/byviz/mcp-server-elasticsearch-ai.git
cd elasticsearch-mcp

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install ALL dependencies (production + development)
pip install -r requirements-all.txt

# Install package in development mode
pip install -e .

Option 2: Minimal Installation (Run only)

# If you only want to run the server (no development)
pip install -r requirements.txt
pip install -e .

Option 3: Using pyproject.toml (Advanced)

# Clone repository
git clone https://github.com/byviz/elasticsearch-mcp-ai.git
cd elasticsearch-mcp

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install directly from pyproject.toml
pip install -e .

📋 Dependencies Files Summary

📋 Verify Installation

# Verify package was installed correctly
python -c "import elasticsearch_mcp; print('✅ Installation successful')"

# Check version
python -m elasticsearch_mcp --version

⚙️ Configuration

📋 Required Environment Variables

Elasticsearch

# Cluster connection
ELASTICSEARCH_URL="https://your-cluster.es.io:9243"

# Authentication (choose one option)
ELASTICSEARCH_USERNAME="your-username"
ELASTICSEARCH_PASSWORD="your-password"
# Or alternatively:
# ELASTICSEARCH_API_KEY="your-api-key"

🔧 Optional Variables

Advanced Elasticsearch

ELASTICSEARCH_TIMEOUT=30                     # Timeout in seconds
ELASTICSEARCH_VERIFY_CERTS=true              # Verify SSL certificates
ELASTICSEARCH_CA_CERTS="/path/to/ca.crt"     # CA certificates
ELASTICSEARCH_CLIENT_CERT="/path/to/client.crt"  # Client certificate
ELASTICSEARCH_CLIENT_KEY="/path/to/client.key"   # Private key

MCP Server

MCP_TRANSPORT=stdio                          # Transport (stdio/http/sse)
MCP_PORT=8000                               # Port for HTTP/SSE
MCP_LOG_LEVEL=INFO                          # Logging level
MCP_ENABLE_SECURITY_FILTERING=true          # Security filtering

🚀 Usage

📝 Quick Configuration

1. Create configuration file:

cp config.env.example .env

2. Edit variables:

# Elasticsearch
ELASTICSEARCH_URL=https://your-cluster.es.io:9243
ELASTICSEARCH_USERNAME=your-username
ELASTICSEARCH_PASSWORD=your-password

3. Run the server:

source .env
python -m elasticsearch_mcp

🎯 Integration with Claude Desktop

Add to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Linux: ~/.config/claude/claude_desktop_config.json

{
  "mcpServers": {
    "elasticsearch": {
      "command": "python",
      "args": ["-m", "elasticsearch_mcp"],
      "env": {
        "ELASTICSEARCH_URL": "https://your-cluster.es.io:9243",
        "ELASTICSEARCH_USERNAME": "your-username",
        "ELASTICSEARCH_PASSWORD": "your-password"
      }
    }
  }
}

🔒 Security

By default, the server runs with security filtering enabled (MCP_ENABLE_SECURITY_FILTERING=true), which restricts operations to read-only.

✅ Allowed Operations

• Searches and queries (GET, POST for searches)
• Reading mappings, configurations, and statistics
• APM analysis and metrics
• Cluster and node information
• Data visualization

❌ Blocked Operations

• Creating, modifying, or deleting indices
• Indexing, updating, or deleting documents
• Modifying cluster configurations
• Any destructive operations

📊 Usage Examples

🔍 Basic Search

"Search for documents containing 'error' in the last 30 minutes"
→ Use searchAllIndices with q="error AND @timestamp:>now-30m"

"Count how many documents are in the 'logs-2024' index"
→ Use countDocumentsInIndex with index="logs-2024"

📊 Cluster Monitoring

"Is the cluster working well?"
→ Use getClusterHealth to check status (green/yellow/red)

"How many nodes does the cluster have and how much memory do they use?"
→ Use getNodeStats with metric="os,jvm" for detailed metrics

"Show basic cluster information"
→ Use getClusterInfo for name, version, and UUID

🗂️ Index Management

"List all indices with their health status"
→ Use getCatIndices with format="json" and v=true

"What fields does the 'products' index have?"
→ Use getMapping with index="products" to see structure

"What is the configuration of the 'logs-app' index?"
→ Use getSettings with index="logs-app"

🚨 APM and Troubleshooting

"Search for errors in the 'api-users' service from the last 2 hours"
→ Use searchAPMErrors with q="service.name:api-users AND @timestamp:>now-2h"

"What are the slowest transactions?"
→ Use searchAPMPerformance with sort="transaction.duration.us:desc"

"Analyze trace ID '430dbab7a0e0322274f076569cdc0c3d'"
→ Use analyzeTracePerformance with trace_id="430dbab7a0e0322274f076569cdc0c3d"

"Find ConnectionError patterns"
→ Use findErrorPatterns with error_type="ConnectionError"

🖥️ System Metrics

"Show CPU usage from the last 5 minutes"
→ Use searchSystemMetrics with q="metricset.name:cpu AND @timestamp:>now-5m"

"Search for ERROR level logs"
→ Use searchLogData with q="log.level:ERROR"

"Check Watcher alerts from the last 24 hours"
→ Use searchWatcherAlerts with q="@timestamp:>now-24h"

🔧 Advanced Analysis

"Find error patterns in servicio-local"
→ Use findErrorPatterns with service_name="servicio-local" and time_range="now-1h"

🛡️ Troubleshooting

❌ Connection Error

ERROR - Connection failed

Solution: Verify ELASTICSEARCH_URL and credentials

❌ Authentication Error

ERROR - Authentication failed

Solution: Verify ELASTICSEARCH_USERNAME/PASSWORD or ELASTICSEARCH_API_KEY

❌ Certificate Error

ERROR - SSL verification failed

Solution: Configure ELASTICSEARCH_VERIFY_CERTS=false or provide certificates

📄 License

Apache 2.0 - see LICENSE file for details

🤝 Contributions

Contributions are welcome! Please:

1. Fork the project
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

📞 Support

Need help, have questions, or want to suggest new features?
Join our growing community! Open an issue or contact us — we're here to help you get the most out of AI-powered Elasticsearch.

Iván Frías Molina
Elastic & Byviz

- 📧 ivan.frias@elastic.co
- 📧 ivan.frias@byviz.com

• LinkedIn
• Web