Сервер Grafana MCP

Сервер протокола контекста модели (MCP) для Grafana.

Это обеспечивает доступ к вашему экземпляру Grafana и окружающей экосистеме.

Функции

• [x] Поиск панелей мониторинга

• [x] Панели управления

  • [x] Получить панель инструментов по UID

  • [x] Обновите или создайте панель мониторинга (ОТКАЗ ОТ ОТВЕТСТВЕННОСТИ: будьте осторожны с контекстными окнами. Подробности см. на странице https://github.com/grafana/mcp-grafana/issues/101 )

  • [x] Получите заголовок, строку запроса и информацию об источнике данных (включая UID и тип, если доступно) из каждой панели на панели мониторинга.

• [x] Список и выборка информации об источниках данных

• [ ] Запросить источники данных

  • [x] Прометей

  • [x] Локи

    • [x] Журнал запросов

    • [x] Метрические запросы

  • [ ] Темп

  • [ ] Пироскоп

• [x] Запрос метаданных Prometheus

  • [x] Метаданные метрики

  • [x] Названия метрик

  • [x] Названия меток

  • [x] Значения меток

• [x] Запрос метаданных Loki

  • [x] Названия меток

  • [x] Значения меток

  • [x] Статистика

• [x] Поиск, создание, обновление и закрытие инцидентов

• [x] Запустите расследования Sift и просмотрите результаты

  • [x] Создать расследования

  • [x] Список расследований с предельным параметром

  • [x] Получить расследование

  • [x] Получить анализы

  • [x] Поиск шаблонов ошибок в журналах с помощью Sift

  • [x] Найти медленные запросы с помощью Sift

  • [ ] Добавить инструменты для других проверок Sift

• [ ] Оповещение

  • [x] Список и выборка информации о правилах оповещения

  • [x] Получить статусы правил оповещения (срабатывание/нормальное/ошибка/и т. д.)

  • [ ] Создание и изменение правил оповещения

  • [x] Список контактных точек

  • [ ] Создание и изменение точек контакта

• [x] Доступ к функциональности Grafana OnCall

  • [x] Список и управление расписаниями

  • [x] Получить данные смены

  • [x] Получить текущих дежурных пользователей

  • [x] Список команд и пользователей

  • [ ] Список групп оповещений

• [x] Функциональность администратора

  • [ ] Список пользователей

  • [x] Список команд

  • [ ] Список ролей

  • [ ] Список назначений ролей

  • [ ] Отладка назначений ролей

Список инструментов настраивается, поэтому вы можете выбрать, какие инструменты вы хотите сделать доступными для клиента MCP. Это полезно, если вы не используете определенные функции или не хотите занимать слишком много места в окне контекста. Чтобы отключить категорию инструментов, используйте флаг --disable-<category> при запуске сервера. Например, чтобы отключить инструменты OnCall, используйте --disable-oncall .

Инструменты

Использование

1. Создайте учетную запись службы в Grafana с достаточными правами для использования инструментов, которые вы хотите использовать, сгенерируйте токен учетной записи службы и скопируйте его в буфер обмена для использования в файле конфигурации. Подробности см. в документации Grafana .

2. У вас есть несколько вариантов установки mcp-grafana :

   • Образ Docker : используйте готовый образ Docker из 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

   • Загрузите двоичный файл : Загрузите последнюю версию mcp-grafana со страницы релизов и поместите ее в $PATH .

   • Сборка из исходного кода : Если у вас установлен Go toolchain, вы также можете собрать и установить его из исходного кода, используя переменную среды GOBIN для указания каталога, в который должен быть установлен двоичный файл. Он также должен быть в вашем PATH .

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

3. Добавьте конфигурацию сервера в файл конфигурации клиента. Например, для Claude Desktop:

   При использовании двоичного файла:

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

   При использовании 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>" } } } }

Примечание: если вы видите Error: spawn mcp-grafana ENOENT в Claude Desktop, вам необходимо указать полный путь к mcp-grafana .

Использование VSCode с удаленным сервером MCP

Убедитесь, что ваш .vscode/settings.json включает:

Режим отладки

Вы можете включить режим отладки для транспорта Grafana, добавив флаг -debug к команде. Это обеспечит подробное протоколирование HTTP-запросов и ответов между сервером MCP и API Grafana, что может быть полезно для устранения неполадок.

Чтобы использовать режим отладки с конфигурацией Claude Desktop, обновите конфигурацию следующим образом:

При использовании двоичного файла:

При использовании Docker:

Разработка

Вклады приветствуются! Пожалуйста, откройте тему или отправьте запрос на извлечение, если у вас есть какие-либо предложения или улучшения.

Этот проект написан на Go. Установите Go, следуя инструкциям для вашей платформы.

Для запуска сервера используйте:

Вы также можете запустить сервер с помощью транспорта SSE внутри созданного образа Docker. Чтобы создать образ, используйте

А для запуска образа используйте:

Тестирование

Доступны три типа тестов:

1. Модульные тесты (внешние зависимости не требуются):

Вы также можете запустить модульные тесты с помощью:

2. Интеграционные тесты (требуются запущенные и работающие контейнеры Docker):

3. Облачные тесты (требуется облачный экземпляр Grafana и учетные данные):

Примечание: Облачные тесты автоматически настраиваются в CI. Для локальной разработки вам нужно будет настроить собственный экземпляр Grafana Cloud и учетные данные.

Для более комплексных интеграционных тестов потребуется, чтобы экземпляр Grafana был запущен локально на порту 3000; вы можете запустить его с помощью Docker Compose:

Интеграционные тесты можно запустить с помощью:

Если вы добавляете больше инструментов, пожалуйста, добавьте интеграционные тесты для них. Существующие тесты должны быть хорошей отправной точкой.

Линтинг

Чтобы выполнить линтинг кода, выполните:

Это включает в себя пользовательский линтер, который проверяет наличие неэкранированных запятых в тегах структуры jsonschema . Запятые в полях description должны быть экранированы с помощью \\, чтобы предотвратить молчаливое усечение. Вы можете запустить только этот линтер с помощью:

Более подробную информацию смотрите в документации JSONSchema Linter .

Лицензия

Данный проект лицензирован по лицензии Apache License, версия 2.0 .