Servidor Kibana MCP

Especificación API
Este proyecto se basa en la documentación oficial de la API de Elastic Kibana y utiliza la especificación OpenAPI YAML de Elastic Stack 8.x (ES8) para recuperar y gestionar dinámicamente todos los endpoints de la API de Kibana. Para obtener la información más reciente, consulte la documentación de la API de Kibana .

Una implementación de servidor Kibana MCP que permite que cualquier cliente compatible con MCP (como Claude Desktop) acceda a su instancia de Kibana a través de lenguaje natural o solicitudes programáticas.

Este proyecto es mantenido por la comunidad y no es un producto oficial de Elastic o MCP.

Características

Conectarse a instancias locales o remotas de Kibana
Autenticación segura (nombre de usuario/contraseña)
Compatibilidad con certificados SSL/TLS y CA personalizados
Expone los puntos finales de la API de Kibana como herramientas y recursos
Busque, visualice y ejecute API de Kibana desde clientes MCP
Seguro de tipos, extensible y fácil de integrar

Estructura del directorio

├── index.ts                # Server entry point
├── src/
│   ├── types.ts            # Type definitions and schemas
│   ├── base-tools.ts       # Tool registration and API logic
│   ├── prompts.ts          # Prompt registration (expert & resource helper)
│   └── resources.ts        # Resource registration (API paths/URIs)
├── kibana-openapi-source.yaml # Kibana API OpenAPI index
├── README.md               # English documentation
├── README_zh.md            # Chinese documentation

Recursos

URI del recurso	Descripción
`kibana-api://paths`	Devuelve todos los puntos finales de API de Kibana disponibles (se pueden filtrar con el parámetro `search` )
`kibana-api://path/{method}/{encoded_path}`	Devuelve detalles para un punto final de API específico

Ejemplos:

kibana-api://paths?search=saved_objects
kibana-api://path/GET//api/status

Herramientas

Nombre de la herramienta	Descripción	Parámetros de entrada
`get_status`	Obtenga el estado actual del servidor Kibana	Ninguno
`execute_api`	Ejecutar una solicitud de API de Kibana personalizada	`method` (GET/POST/PUT/DELETE), `path` (cadena), `body` (opcional), `params` (opcional)
`search_kibana_api_paths`	Buscar puntos finales de la API de Kibana por palabra clave	`search` (cadena)
`list_all_kibana_api_paths`	Listar todos los puntos finales de la API de Kibana	Ninguno
`get_kibana_api_detail`	Obtener detalles de un punto final de API de Kibana específico	`method` (cadena), `path` (cadena)

Indicaciones

Nombre del aviso	Descripción
`kibana-tool-expert`	El modo experto de herramientas (muy recomendado en Claude Desktop) permite el análisis inteligente, la búsqueda, la ejecución y la explicación de las API de Kibana mediante herramientas. Recomendado para la mayoría de los usuarios.
`kibana-resource-helper`	El modo de ayuda de recursos guía el acceso y uso de la información de la API de Kibana mediante las URI de recursos. Ideal para clientes que solo admiten el acceso a recursos o necesitan metadatos de la API sin procesar.

Configuración

Configurar el servidor a través de variables de entorno:

Nombre de la variable	Descripción	Requerido
`KIBANA_URL`	Dirección del servidor Kibana (por ejemplo , http://localhost:5601 )	Sí
`KIBANA_USERNAME`	Nombre de usuario de Kibana	Sí
`KIBANA_PASSWORD`	Contraseña de Kibana	Sí
`KIBANA_CA_CERT`	Ruta del certificado CA (opcional, para verificación SSL)	No
`KIBANA_TIMEOUT`	Tiempo de espera de solicitud en ms (predeterminado 30000)	No
`KIBANA_MAX_RETRIES`	Máximo de reintentos de solicitud (predeterminado: 3)	No
`NODE_TLS_REJECT_UNAUTHORIZED`	Establezca en `0` para deshabilitar la validación del certificado SSL (úselo con precaución)	No

Uso

Iniciar el servidor

KIBANA_URL=http://your-kibana-server:5601 \
KIBANA_USERNAME=your-username \
KIBANA_PASSWORD=your-password \
NODE_TLS_REJECT_UNAUTHORIZED=0 \
npm start

Ejemplo de configuración de cliente MCP

Agregue al archivo de configuración de Claude Desktop (ruta de MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json ):

{
  "mcpServers": {
    "kibana-mcp-server": {
      "command": "node",
      "args": ["/path/to/mcp-server-kibana/dist/index.js"],
      "env": {
        "KIBANA_URL": "http://your-kibana-server:5601",
        "KIBANA_USERNAME": "your-username",
        "KIBANA_PASSWORD": "your-password",
        "NODE_TLS_REJECT_UNAUTHORIZED": "0"
      }
    }
  }
}

Consultas de ejemplo

"¿Cuál es el estado de mi servidor Kibana?"
"Enumere todos los puntos finales de la API de Kibana disponibles".
"Mostrar detalles del punto final POST /api/saved_objects/_find".
"Ejecutar una solicitud de API personalizada para /api/status."
"Obtenga una lista de todos los paneles en Kibana".
"Consultar puntos finales de API relacionados con eventos de puntos finales".
"Enumere todos los puntos finales de API relacionados con el caso".
"Crear un nuevo caso en Kibana."
"Crear un nuevo panel en Kibana".

Dos modos de aviso en Claude Desktop

Al utilizar este servidor con Claude Desktop, se admiten dos modos de interacción de solicitud diferentes:

1. Modo de aviso basado en herramientas

Cómo funciona: Claude Desktop puede llamar directamente a las herramientas del servidor (como get_status , execute_api , search_kibana_api_paths , etc.) para responder sus preguntas o realizar acciones.
Ideal para: Usuarios que buscan una experiencia conversacional y guiada. El servidor buscará, ejecutará y explicará automáticamente las API de Kibana.
Ejemplo: "Mostrar todos los puntos finales de la API de Kibana relacionados con los objetos guardados".
Consejo de prueba: seleccione el indicador kibana-tool-expert en Claude Desktop para realizar pruebas de integración y luego comience a usarlo.

2. Modo de solicitud basado en recursos

Cómo funciona: Claude Desktop interactúa con el servidor a través de URI de recursos (como kibana-api://paths o kibana-api://path/GET//api/status ) y el servidor devuelve datos estructurados para que Claude los analice.
Ideal para: usuarios avanzados, clientes MCP que solo admiten acceso a recursos o escenarios de programación que necesitan metadatos de API sin procesar.
Ejemplo: "Obtener el recurso kibana-api://paths?search=dashboard"

Nota: Los dos puntos finales en resources ( kibana-api://paths y kibana-api://path/{method}/{encoded_path} ) cuentan con sus herramientas base correspondientes ( list_all_kibana_api_paths y get_kibana_api_detail ). Este diseño garantiza la compatibilidad con clientes MCP que no pueden seleccionar varios recursos de forma inteligente, lo que facilita la interacción de herramientas como Claude Desktop con Kibana.

Consejo: Se recomienda a la mayoría de los usuarios utilizar el modo de herramienta para una experiencia más natural y potente; el modo de recurso ofrece la máxima flexibilidad para casos de uso avanzados y de compatibilidad.

Desarrollo

Instalar dependencias:

npm install

Construir el servidor:

npm run build

Reconstrucción automática en modo de desarrollo:

npm run watch

Depuración

Dado que el servidor MCP se comunica mediante stdio, la depuración puede resultar incómoda. Se recomienda usar MCP Inspector:

npm run inspector

Después de iniciarse, Inspector proporcionará una URL de herramienta de depuración accesible desde el navegador.

Comunidad

Este proyecto es mantenido por la comunidad. ¡Agradecemos sus contribuciones y comentarios! Por favor, sea respetuoso e inclusivo en todas las comunicaciones y respete el Código de Conducta de la Comunidad Elastic .

Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0. Consulte el archivo de LICENCIA para más detalles.

Solución de problemas

Compruebe si la configuración de MCP es correcta
Asegúrese de que la dirección de Kibana sea accesible
Verificar que las credenciales de autenticación tengan permisos suficientes
Si utiliza una CA personalizada, asegúrese de que la ruta del certificado sea correcta y legible
Si utiliza NODE_TLS_REJECT_UNAUTHORIZED=0 , tenga en cuenta los riesgos de seguridad
Comprobar la salida de los mensajes de error en la terminal

Kibana MCP Server