Servidor MCP de Grafana

Un servidor de Protocolo de Contexto de Modelo (MCP) para Grafana.

Esto proporciona acceso a su instancia de Grafana y al ecosistema circundante.

Características

• [x] Buscar paneles de control

• [x] Paneles de control

  • [x] Obtener el panel por UID

  • [x] Actualizar o crear un panel (DESCARGO DE RESPONSABILIDAD: Tenga cuidado con las ventanas de contexto. Consulte https://github.com/grafana/mcp-grafana/issues/101 para obtener más detalles)

  • [x] Obtener el título, la cadena de consulta y la información de la fuente de datos (incluido el UID y el tipo, si está disponible) de cada panel en un tablero

• [x] Listar y obtener información de la fuente de datos

• [ ] Consultar fuentes de datos

  • [x] Prometeo

  • [x] Loki

    • [x] Consultas de registro

    • [x] Consultas métricas

  • [ ] Ritmo

  • [ ] Piroscopio

• [x] Consultar metadatos de Prometheus

  • [x] Metadatos métricos

  • [x] Nombres de métricas

  • [x] Nombres de etiquetas

  • [x] Valores de etiqueta

• [x] Consultar metadatos de Loki

  • [x] Nombres de etiquetas

  • [x] Valores de etiqueta

  • [x] Estadísticas

• [x] Buscar, crear, actualizar y cerrar incidentes

• [x] Iniciar investigaciones de Sift y ver los resultados

  • [x] Crear investigaciones

  • [x] Enumere las investigaciones con un parámetro límite

  • [x] Obtener investigación

  • [x] Obtener análisis

  • [x] Encuentre patrones de error en los registros usando Sift

  • [x] Encuentra solicitudes lentas usando Sift

  • [ ] Agregar herramientas en los otros controles de tamizado

• [ ] Alerta

  • [x] Listar y obtener información de reglas de alerta

  • [x] Obtener estados de reglas de alerta (activación/normal/error/etc.)

  • [ ] Crear y cambiar reglas de alerta

  • [x] Lista de puntos de contacto

  • [ ] Crear y cambiar puntos de contacto

• [x] Acceda a la funcionalidad de Grafana OnCall

  • [x] Enumerar y administrar horarios

  • [x] Obtener detalles del turno

  • [x] Obtener los usuarios de guardia actuales

  • [x] Lista de equipos y usuarios

  • [ ] Lista de grupos de alerta

• [x] Funcionalidad de administrador

  • [ ] Lista de usuarios

  • [x] Lista de equipos

  • [ ] Lista de roles

  • [ ] Enumere las asignaciones de roles

  • [ ] Asignaciones de roles de depuración

La lista de herramientas es configurable, por lo que puede elegir qué herramientas quiere que estén disponibles para el cliente MCP. Esto resulta útil si no utiliza alguna funcionalidad o si no desea ocupar demasiado espacio en la ventana de contexto. Para deshabilitar una categoría de herramientas, utilice el indicador --disable-<category> al iniciar el servidor. Por ejemplo, para deshabilitar las herramientas OnCall, utilice --disable-oncall .

Herramientas

Uso

1. Cree una cuenta de servicio en Grafana con permisos suficientes para usar las herramientas que desee, genere un token de cuenta de servicio y cópielo al portapapeles para usarlo en el archivo de configuración. Consulte la documentación de Grafana para obtener más información.

2. Tiene varias opciones para instalar mcp-grafana :

   • Imagen de Docker : utilice la imagen de Docker prediseñada desde Docker Hub:

     docker pull mcp/grafana docker run -p 8000:8000 -e GRAFANA_URL=http://localhost:3000 -e GRAFANA_API_KEY=<your service account token> mcp/grafana

   • Descargar binario : descargue la última versión de mcp-grafana desde la página de versiones y colóquela en su $PATH .

   • Compilar desde el código fuente : Si tiene instalada una cadena de herramientas Go, también puede compilarla e instalarla desde el código fuente. Para ello, utilice la variable de entorno GOBIN para especificar el directorio donde se instalará el binario. Esta variable también debe estar en su PATH .

     GOBIN="$HOME/go/bin" go install github.com/grafana/mcp-grafana/cmd/mcp-grafana@latest

3. Agregue la configuración del servidor al archivo de configuración del cliente. Por ejemplo, para Claude Desktop:

   Si se utiliza el binario:

   { "mcpServers": { "grafana": { "command": "mcp-grafana", "args": [], "env": { "GRAFANA_URL": "http://localhost:3000", "GRAFANA_API_KEY": "<your service account token>" } } } }

   Si usa Docker:

   { "mcpServers": { "grafana": { "command": "docker", "args": [ "run", "--rm", "-p", "8000:8000", "-e", "GRAFANA_URL", "-e", "GRAFANA_API_KEY", "mcp/grafana" ], "env": { "GRAFANA_URL": "http://localhost:3000", "GRAFANA_API_KEY": "<your service account token>" } } } }

Nota: si ve Error: spawn mcp-grafana ENOENT en Claude Desktop, debe especificar la ruta completa a mcp-grafana .

Uso de VSCode con un servidor MCP remoto

Asegúrese de que su .vscode/settings.json incluya:

Modo de depuración

Puede habilitar el modo de depuración para el transporte de Grafana añadiendo la opción -debug al comando. Esto proporcionará un registro detallado de las solicitudes y respuestas HTTP entre el servidor MCP y la API de Grafana, lo cual puede ser útil para la resolución de problemas.

Para utilizar el modo de depuración con la configuración de Claude Desktop, actualice su configuración de la siguiente manera:

Si se utiliza el binario:

Si usa Docker:

Desarrollo

¡Agradecemos sus contribuciones! Abra un problema o envíe una solicitud de incorporación de cambios si tiene alguna sugerencia o mejora.

Este proyecto está escrito en Go. Instale Go siguiendo las instrucciones para su plataforma.

Para ejecutar el servidor, utilice:

También puedes ejecutar el servidor usando el transporte SSE dentro de una imagen de Docker personalizada. Para crear la imagen, usa

Y para ejecutar la imagen, usa:

Pruebas

Hay tres tipos de pruebas disponibles:

1. Pruebas unitarias (no se requieren dependencias externas):

También puedes ejecutar pruebas unitarias con:

2. Pruebas de integración (requiere que los contenedores Docker estén en funcionamiento):

3. Pruebas en la nube (requiere instancia de Grafana en la nube y credenciales):

Nota: Las pruebas en la nube se configuran automáticamente en CI. Para el desarrollo local, deberá configurar su propia instancia y credenciales de Grafana Cloud.

Las pruebas de integración más completas requerirán que una instancia de Grafana se ejecute localmente en el puerto 3000; puede iniciar una con Docker Compose:

Las pruebas de integración se pueden ejecutar con:

Si va a agregar más herramientas, incorpore pruebas de integración para ellas. Las pruebas existentes deberían ser un buen punto de partida.

Pelusa

Para depurar el código, ejecute:

Esto incluye un linter personalizado que busca comas sin escape en las etiquetas de estructura jsonschema . Las comas en los campos description deben escaparse con \\, para evitar el truncamiento silencioso. Puede ejecutar este linter con:

Consulte la documentación de JSONSchema Linter para obtener más detalles.

Licencia

Este proyecto está licenciado bajo la Licencia Apache, Versión 2.0 .