Skip to main content
Glama
elastic

Elasticsearch MCP Server

Official
by elastic

Servidor MCP de Elasticsearch

Este repositorio contiene características experimentales destinadas a la investigación y la evaluación y no están listas para producción.

Conéctese a sus datos de Elasticsearch directamente desde cualquier cliente MCP (como Claude Desktop) utilizando el Protocolo de contexto de modelo (MCP).

Este servidor conecta a los agentes con sus datos de Elasticsearch mediante el Protocolo de Contexto de Modelo. Le permite interactuar con sus índices de Elasticsearch mediante conversaciones en lenguaje natural.

Herramientas disponibles

  • list_indices : Lista todos los índices de Elasticsearch disponibles

  • get_mappings : obtiene asignaciones de campos para un índice Elasticsearch específico

  • search : Realiza una búsqueda de Elasticsearch con la consulta DSL proporcionada

  • get_shards : Obtener información de fragmentos para todos los índices o para índices específicos

Related MCP server: Elasticsearch MCP Server

Prerrequisitos

  • Una instancia de Elasticsearch

  • Credenciales de autenticación de Elasticsearch (clave API o nombre de usuario/contraseña)

  • Cliente MCP (por ejemplo, Claude Desktop)

Manifestación

https://github.com/user-attachments/assets/5dd292e1-a728-4ca7-8f01-1380d1bebe0c

Instalación y configuración

Uso del paquete NPM publicado

[!TIP] La forma más sencilla de utilizar Elasticsearch MCP Server es a través del paquete npm publicado.

  1. Configurar el cliente MCP

    • Abra su cliente MCP. Consulte la lista de clientes MCP . Aquí estamos configurando Claude Desktop.

    • Vaya a Configuración > Desarrollador > Servidores MCP

    • Haga clic Edit Config y agregue un nuevo servidor MCP con la siguiente configuración:

    {
      "mcpServers": {
        "elasticsearch-mcp-server": {
          "command": "npx",
          "args": [
            "-y",
            "@elastic/mcp-server-elasticsearch"
          ],
          "env": {
            "ES_URL": "your-elasticsearch-url",
            "ES_API_KEY": "your-api-key"
          }
        }
      }
    }
  2. Iniciar una conversación

    • Abra una nueva conversación en su cliente MCP

    • El servidor MCP debería conectarse automáticamente

    • Ahora puedes hacer preguntas sobre tus datos de Elasticsearch

Opciones de configuración

El servidor MCP de Elasticsearch admite opciones de configuración para conectarse a su Elasticsearch:

[!NOTA] Debe proporcionar una clave API o un nombre de usuario y una contraseña para la autenticación.

Variable de entorno

Descripción

Requerido

ES_URL

La URL de su instancia de Elasticsearch

Sí

ES_API_KEY

Clave API de Elasticsearch para autenticación

No

ES_USERNAME

Nombre de usuario de Elasticsearch para autenticación básica

No

ES_PASSWORD

Contraseña de Elasticsearch para autenticación básica

No

ES_CA_CERT

Ruta al certificado CA personalizado para Elasticsearch SSL/TLS

No

Desarrollo local

[!NOTA] Si desea modificar o ampliar el servidor MCP, siga estos pasos de desarrollo local.

  1. Utilice la versión correcta de Node.js

    nvm use
  2. Instalar dependencias

    npm install
  3. Construir el proyecto

    npm run build
  4. Ejecutar localmente en la aplicación de escritorio Claude

    • Abra la aplicación de escritorio Claude

    • Vaya a Configuración > Desarrollador > Servidores MCP

    • Haga clic Edit Config y agregue un nuevo servidor MCP con la siguiente configuración:

    {
      "mcpServers": {
        "elasticsearch-mcp-server-local": {
          "command": "node",
          "args": [
            "/path/to/your/project/dist/index.js"
          ],
          "env": {
            "ES_URL": "your-elasticsearch-url",
            "ES_API_KEY": "your-api-key"
          }
        }
      }
    }
  5. Depuración con MCP Inspector

    ES_URL=your-elasticsearch-url ES_API_KEY=your-api-key npm run inspector

    Esto iniciará el Inspector MCP, lo que le permitirá depurar y analizar solicitudes. Debería ver lo siguiente:

    Starting MCP inspector...
    Proxy server listening on port 3000
    
    🔍 MCP Inspector is up and running at http://localhost:5173 🚀

Contribuyendo

¡Agradecemos las contribuciones de la comunidad! Para más información sobre cómo contribuir, consulta las Pautas de Contribución .

Preguntas de ejemplo

[!TIP] Aquí hay algunas consultas en lenguaje natural que puedes probar con tu cliente MCP.

  • "¿Qué índices tengo en mi clúster Elasticsearch?"

  • "Muéstrame las asignaciones de campos para el índice 'productos'".

  • "Encuentre todos los pedidos superiores a $500 del mes pasado".

  • "¿Qué productos recibieron más reseñas de 5 estrellas?"

Cómo funciona

  1. El cliente MCP analiza su solicitud y determina qué operaciones de Elasticsearch son necesarias.

  2. El servidor MCP lleva a cabo estas operaciones (enumerar índices, obtener asignaciones, realizar búsquedas).

  3. El cliente MCP procesa los resultados y los presenta en un formato fácil de usar.

Mejores prácticas de seguridad

[!ADVERTENCIA] Evite usar privilegios de administrador del clúster. Cree claves de API dedicadas con alcance limitado y aplique un control de acceso preciso a nivel de índice para evitar el acceso no autorizado a los datos.

Puede crear una clave API de Elasticsearch dedicada con permisos mínimos para controlar el acceso a sus datos:

POST /_security/api_key
{
  "name": "es-mcp-server-access",
  "role_descriptors": {
    "mcp_server_role": {
      "cluster": [
        "monitor"
      ],
      "indices": [
        {
          "names": [
            "index-1",
            "index-2",
            "index-pattern-*"
          ],
          "privileges": [
            "read",
            "view_index_metadata"
          ]
        }
      ]
    }
  }
}

Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0.

Solución de problemas

  • Asegúrese de que la configuración de su MCP sea correcta.

  • Verifique que su URL de Elasticsearch sea accesible desde su máquina.

  • Verifique que sus credenciales de autenticación (clave API o nombre de usuario/contraseña) tengan los permisos necesarios.

  • Si usa SSL/TLS con una CA personalizada, verifique que la ruta del certificado sea correcta y que el archivo sea legible.

  • Observe la salida del terminal para ver si hay mensajes de error.

Si encuentra problemas, no dude en abrir un problema en el repositorio de GitHub.

Available Tools

3 tools
get_mappingsB

Get field mappings for a specific Elasticsearch index

ParametersJSON Schema
NameRequiredDescriptionDefault
indexYesName of the Elasticsearch index to get mappings for

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden but only states 'Get field mappings', implying read-only but not disclosing permissions, side effects, or behavior like error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, no unnecessary words, front-loaded with the action and target.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description could mention what the response contains; it is adequate but minimal for a simple get operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the parameter 'index' has a description; the tool description adds no extra meaning beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses specific verb 'Get' and resource 'field mappings' for a specific Elasticsearch index, clearly distinguishing from siblings like create_mapping or search.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives; for example, it doesn't explain how it differs from create_mapping or search in terms of use cases.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_indicesB

List all available Elasticsearch indices

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. While 'List' implies a read operation, it doesn't specify whether this requires special permissions, returns paginated results, includes hidden/system indices, or provides any metadata beyond names. For a tool with zero annotation coverage, this leaves significant behavioral questions unanswered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that communicates the core functionality without any wasted words. It's appropriately sized for a simple listing tool and front-loads the essential information. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter read operation without output schema, the description provides the minimum viable information about what the tool does. However, given the lack of annotations and sibling tools with potentially overlapping functionality, more context about when to use this versus alternatives would be helpful. The description is complete enough for basic understanding but leaves operational context gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters with 100% schema description coverage, so the schema already fully documents the parameter situation. The description appropriately doesn't mention parameters since none exist. A baseline of 4 is appropriate for zero-parameter tools where the schema handles all parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('List') and resource ('all available Elasticsearch indices'), making the tool's purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'get_mappings' or 'search' - it's unclear if this is a simple listing versus more detailed metadata retrieval.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'get_mappings' or 'search'. There's no indication of whether this is for administrative purposes, discovery, or as a prerequisite for other operations. The agent must infer usage context from tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 3 tool updatesv1.0.0
    • First observedget_mappings
    • First observedlist_indices
    • First observedsearch

TDQS

B3.2/5.0

Scored across 3 tools

Disambiguation5/5

Each tool has a clearly distinct purpose: get_mappings retrieves field mappings for a specific index, list_indices enumerates all indices, and search performs query-based searches. There is no overlap in functionality, making tool selection unambiguous.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern (get_mappings, list_indices, search), with clear and descriptive verbs that align with their actions. No deviations or mixed conventions are present.

Tool Count3/5

With only 3 tools, the set feels thin for an Elasticsearch server, as it lacks essential operations like creating/deleting indices, updating mappings, or performing CRUD operations on documents. While the tools are well-defined, the count is borderline for the domain's scope.

Completeness2/5

There are significant gaps in the tool surface for Elasticsearch functionality. Missing operations include index creation/deletion, document indexing/updating/deleting, and cluster management. This incompleteness will likely cause agent failures when attempting full workflows.

Maintenance

ActivityInactive
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    A
    maintenance
    Facilitates interaction with Elasticsearch clusters by allowing users to perform index operations, document searches, and cluster management via a Model Context Protocol server and natural language commands.
    20
    308
    Apache 2.0
  • A
    license
    B
    quality
    C
    maintenance
    Connects agents to Elasticsearch data using the Model Context Protocol, allowing natural language interaction with Elasticsearch indices through MCP Clients like Claude Desktop and Cursor.
    11
    71 npm
    23
    MIT
  • A
    license
    B
    quality
    D
    maintenance
    Connects to Elasticsearch databases using the Model Context Protocol, allowing users to query and interact with their Elasticsearch indices through natural language conversations.
    4
    7 npm
    Apache 2.0
  • A
    license
    Not graded
    quality
    D
    maintenance
    Connects agents to Elasticsearch data using the Model Context Protocol, allowing natural language interaction with Elasticsearch indices through tools for listing indices, getting field mappings, performing searches, and viewing shard information.
    2,662 npm
    Apache 2.0