Servidor MCP de Elasticsearch

Inglés | Chino

Servidor MCP para conectarse a su clúster Elasticsearch directamente desde cualquier cliente MCP (como Claude Desktop, Cursor).

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.

Manifestación

Descripción general de las funciones

Funciones disponibles

Gestión de clústeres

• elasticsearch_health : obtiene el estado de salud del clúster de Elasticsearch, incluyendo opcionalmente detalles a nivel de índice

Operaciones de índice

• list_indices : lista de índices de Elasticsearch disponibles, admite expresiones regulares

• create_index : crea un índice de Elasticsearch con configuraciones y asignaciones opcionales

• reindex : reindexar datos de un índice de origen a un índice de destino con una consulta y un script opcionales

Gestión de mapas

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

• create_mapping : crea o actualiza la estructura de mapeo para un índice de Elasticsearch

Búsqueda y operaciones de datos

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

• bulk : datos en masa en un índice de Elasticsearch

Gestión de plantillas

• create_index_template : Crea o actualiza una plantilla de índice

• get_index_template : Obtener información sobre las plantillas de índice

• delete_index_template : Eliminar una plantilla de índice

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.

Empezando

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, Cursor)

Instalación y configuración

Uso 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": { "command": "npx", "args": [ "-y", "@awesome-ai/elasticsearch-mcp" ], "env": { "ES_HOST": "your-elasticsearch-host", "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.

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: GXP5

5. Ejecutar localmente en el editor de cursores

   • Abrir el editor de cursores

   • Vaya a Configuración del cursor > MCP

   • Haga clic Add new global MCP Server y agregue un nuevo servidor MCP con la siguiente configuración: GXP6

6. Depuración con MCP Inspector

   ES_HOST=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 6277 🔍 MCP Inspector is up and running at http://127.0.0.1:6274 🚀

Consultas de ejemplo

Gestión de clústeres

• "¿Cuál es el estado de salud de mi clúster Elasticsearch?"

• "¿Cuántos nodos activos hay en mi clúster?"

Operaciones de índice

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

• "Crea un nuevo índice llamado 'usuarios' con 3 fragmentos y 1 réplica".

• "Reindexar datos de 'old_index' a 'new_index'."

Gestión de mapas

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

• "Agregue un campo de tipo palabra clave llamado 'etiquetas' al índice 'productos'".

Búsqueda y operaciones de datos

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

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

• "Importa masivamente estos registros de clientes al índice 'clientes'".

Gestión de plantillas

• "Crea una plantilla de índice para registros con el patrón 'logs-*'."

• "Muéstrame todas mis plantillas de índice".

• "Eliminar la plantilla de índice 'outdated_template'".

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