Skip to main content

Strawgate's Elasticsearch MCP project

Project description

strawgate_es_mcp

Strawgate's Unofficial MCP Server for Elasticsearch.

Use at your own risk. This is not an official Elasticsearch product. This MCP Server will probably break your Elasticsearch cluster. Do not use it.

This project provides a Model Context Protocol (MCP) server implemented in Python using fastmcp. Its primary purpose is to expose a wide range of Elasticsearch client functionalities as callable MCP tools, allowing for interaction with an Elasticsearch cluster via the MCP.

Features

  • Elasticsearch Tooling: Exposes numerous Elasticsearch client APIs as MCP tools, including:
    • CAT APIs (allocation, aliases, count, indices, nodes, shards, etc.)
    • Cluster APIs (health, state, stats)
    • Nodes APIs (info, stats)
    • Indices APIs (create/get data stream, stats, resolve index)
    • ILM and SLM APIs (get/explain lifecycle, get status, get stats)
    • Shutdown APIs (get node)
    • Search API
  • CLI: A CLI for the MCP Server.
  • Extensible: Easily add new Elasticsearch client methods as MCP tools or integrate with other MCP tools.
  • Sample Script: Includes sample_multisearch.py to demonstrate using the Elasticsearch Python client for multi-searches.
  • Testing: Includes unit tests for the exposed tools and sample scripts using pytest.

Setup in Windsurf

On the right in the cascade window press the hammer icon and add a server with the following configuration:

{
    "mcpServers": {
        "es-mcp": {
            "command": "uvx",
            "args": [
                "--from",
                "git+https://github.com/strawgate/py-mcp-collection.git#subdirectory=es-mcp",
                "es-mcp"
            ],
            "env": {
                "ES_HOST": "https://my-cloud-cluster:443",
                "ES_API_KEY": "MYCOOLAPIKEY"
            }
        }
    }
}

VS Code McpServer Usage

  1. Open the command palette (Ctrl+Shift+P or Cmd+Shift+P).
  2. Type "Settings" and select "Preferences: Open User Settings (JSON)".
  3. Add the following MCP Server configuration
{
    "mcp": {
        "servers": {
            "Es Mcp": {
                "command": "uvx",
                "args": [
                    "--from",
                    "git+https://github.com/strawgate/py-mcp-collection.git#subdirectory=es_mcp",
                    "es-mcp"
                ]
            }
        }
    }
}

Roo Code / Cline McpServer Usage

Simply add the following to your McpServer configuration. Edit the AlwaysAllow list to include the tools you want to use without confirmation.

    "es-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/strawgate/py-mcp-collection.git#subdirectory=es_mcp",
        "es-mcp"
      ]
    }

License

See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

strawgate_es_mcp-0.6.0.tar.gz (83.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

strawgate_es_mcp-0.6.0-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file strawgate_es_mcp-0.6.0.tar.gz.

File metadata

  • Download URL: strawgate_es_mcp-0.6.0.tar.gz
  • Upload date:
  • Size: 83.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.4

File hashes

Hashes for strawgate_es_mcp-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3373ae9cc842a6148cb7dd34ea972d1c8b6e4b478de0b1ac46a9bb69f2691405
MD5 95cb13fe89e67fd1613ee1f65eb51a77
BLAKE2b-256 350450865517fe8b26029a79aed284f3c86308cff1a5fdd9089a481d19ed1997

See more details on using hashes here.

File details

Details for the file strawgate_es_mcp-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for strawgate_es_mcp-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c67514ef1cb3a4b3604f78a72717a2c4ea417f3c5e89fd875313c27a0607891
MD5 4e979b3c555e55e1850e2e2a97e88906
BLAKE2b-256 d2fcd5e1aebb504e486567b44b3f895dce85b583096967b39d19c16bafa19f5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page