Scout Monitoring MCP Server

Scout Monitoring MCP

Этот репозиторий содержит код для локального запуска MCP-сервера, который может получать доступ к данным Scout Monitoring через API Scout. Мы предоставляем образ Docker, который может быть загружен и запущен вашим AI-ассистентом для доступа к данным Scout Monitoring.

Это предоставляет данные о производительности и ошибках Scout Monitoring непосредственно в распоряжение вашего AI-ассистента. Для Rails, Django, FastAPI, Laravel и других фреймворков. Используйте его для получения трассировок и ошибок с информацией о строках кода, которую AI может использовать для целевых исправлений прямо в вашем редакторе и кодовой базе. N+1 запросы, медленные эндпоинты, медленные запросы, раздувание памяти, проблемы с пропускной способностью — все ваши любимые проблемы производительности выявляются и объясняются прямо там, где вы работаете.

Если это хоть немного упрощает вашу жизнь, почему бы не поставить :star:?!

Мастер настройки

Самый простой способ настроить и начать использовать Scout MCP — это наш интерактивный мастер настройки. Он выполняет все предварительные требования и шаги по установке за вас.

Запуск через npx:

npx @scout_apm/wizard

Сборка и запуск из исходного кода:

cd ./wizard
npm install
npm run build
node dist/wizard.js

Мастер проведет вас через:

• Выбор вашей AI-платформы для кодинга (Cursor, Claude Code, Claude Desktop)
• Ввод вашего API-ключа Scout
• Автоматическую настройку параметров MCP-сервера

Поддерживаемые платформы

В настоящее время мастер поддерживает настройку для:

• Cursor — автоматически настраивает параметры MCP
• Claude Code (CLI) — предоставляет правильную команду для запуска
• Claude Desktop — обновляет файл конфигурации для Windows/Mac

Для всех остальных он выведет JSON, который вы можете скопировать и вставить в конфигурацию MCP вашего AI-ассистента.

Предварительные требования

Мастер — отличный способ начать, но вы также можете настроить всё вручную. Вам потребуется иметь или создать учетную запись Scout Monitoring и получить API-ключ.

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. Установите агент Scout в ваше приложение и отправляйте данные Scout!
   • Ruby
   • Python
   • PHP
   • Если вы пробуете это локально, убедитесь, что monitor: true, errors_enabled: true заданы в вашей конфигурации для наилучшего опыта
3. Посетите настройки, чтобы получить или создать API-ключ
   • Это не ваш «Ключ агента»; это «API-ключ», который можно создать на странице настроек
   • Это ключ только для чтения, который может получать доступ только к данным в вашей учетной записи
4. Установите Docker. Инструкции ниже предполагают, что вы можете запустить контейнер Docker

MCP-сервер в настоящее время не запустится без установленного API-ключа, либо в переменной окружения, либо через аргумент командной строки при запуске.

Установка

Мы рекомендуем использовать предоставленный образ Docker для запуска MCP-сервера. Он предназначен для запуска вашим AI-ассистентом и настройки с вашим API-ключом Scout. Многие локальные клиенты позволяют указать команду для запуска MCP-сервера в определенном месте. Ниже приведены несколько примеров.

Образ Docker доступен на Docker Hub.

Конечно, вы всегда можете клонировать этот репозиторий и запустить MCP-сервер напрямую; рекомендуется использовать uv или другие инструменты управления окружением.

Настройка локального клиента (например, Claude/Cursor/VS Code Copilot)

Если вы хотите настроить MCP вручную, это обычно означает предоставление команды для запуска MCP-сервера с вашим API-ключом в переменной окружения в конфигурации вашего AI-ассистента. Вот форма JSON (ключ верхнего уровня может различаться):

{
  "mcpServers": {
    "scout-apm": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "--env", "SCOUT_API_KEY", "scoutapp/scout-mcp-local"],
      "env": { "SCOUT_API_KEY": "your_scout_api_key_here"}
    }
  }
}

claude mcp add scoutmcp -e SCOUT_API_KEY=your_scout_api_key_here -- docker run --rm -i -e SCOUT_API_KEY scoutapp/scout-mcp-local

{
  "mcpServers": {
    "scout-apm": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "--env", "SCOUT_API_KEY", "scoutapp/scout-mcp-local"],
      "env": { "SCOUT_API_KEY": "your_scout_api_key_here"}
    }
  }
}

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

MCP Scout предназначен для предоставления данных об ошибках и производительности непосредственно в... руки? вашего AI-ассистента. Используйте его для получения трассировок и ошибок с информацией о строках кода, которую AI может использовать для целевых исправлений прямо в вашем редакторе.

Большинство ассистентов покажут вам как прямые вызовы инструментов, так и выполнят анализ. Настольные ассистенты могут легко создавать пользовательские JS-приложения для изучения любых данных, которые вы пожелаете. Ассистенты, интегрированные в редакторы кода, могут использовать данные трассировки и обратные трассировки ошибок для внесения исправлений прямо в вашу кодовую базу.

Комбинируйте MCP Scout с другими инструментами вашего AI-ассистента для:

• Создания подробных задач на GitHub/GitLab на основе ошибок и данных о производительности
• Сделайте JIRA увлекательной — пусть ваш AI-ассистент создает тикеты со всеми деталями
• Генерации PR, которые исправляют конкретные ошибки и проблемы производительности

Инструменты

Scout MCP предоставляет следующие инструменты для доступа к данным Scout APM:

• list_apps — список доступных приложений Scout APM с возможностью фильтрации по дате последней активности
• get_app_metrics — получение данных отдельных метрик (response_time, throughput и т.д.) для конкретного приложения
• get_app_endpoints — получение всех эндпоинтов для приложения с агрегированными метриками производительности
• get_endpoint_metrics — получение временных рядов метрик для конкретного эндпоинта в приложении
• get_app_endpoint_traces — получение последних трассировок для приложения, отфильтрованных по конкретному эндпоинту
• get_app_trace — получение отдельной трассировки со всеми спанами и детальной информацией о выполнении
• get_app_error_groups — получение последних групп ошибок для приложения, опционально отфильтрованных по эндпоинту
• get_app_insights — получение аналитических данных о производительности, включая N+1 запросы, раздувание памяти и медленные запросы

Ресурсы

Scout MCP предоставляет шаблоны конфигурации в качестве ресурсов, которые ваш AI-ассистент может читать и применять:

• scoutapm://config-resources/{framework} — инструкции по настройке для поддерживаемого фреймворка или библиотеки (rails, django, flask, fastapi)
• scoutapm://config-resources/list — список всех доступных шаблонов конфигурации
• scoutapm://metrics — список всех доступных метрик для Scout APM

Полезные промпты

Настройка и конфигурация

• «Помоги мне настроить Scout monitoring для моего Rails-приложения»
• «Создай конфигурационный файл Scout APM для моего Django-проекта с ключом ABC123»

Производительность и мониторинг

• «Обобщи доступные инструменты в Scout Monitoring MCP.»
• «Найди самые медленные эндпоинты для приложения my-app-name за последние 7 дней. Создай таблицу с результатами, включая среднее время отклика, пропускную способность и P95 время отклика.»
• «Покажи мне самые частые ошибки для приложения Foo за последние 24 часа. Получи последнюю детализацию ошибки, изучи обратную трассировку и предложи исправление.»
• «Получи любые недавние аналитические данные по N+1 для приложения Bar. Извлеки конкретную трассировку по ID и помоги мне оптимизировать её на основе данных обратной трассировки.»

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

В настоящее время мы больше заинтересованы в расширении доступной информации, чем в строгом контроле размера ответа от наших инструментов MCP. Если ваш AI-ассистент имеет настраиваемый лимит токенов (например, Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), мы рекомендуем установить его щедро высоким, например, 50 000 токенов.

Локальная разработка

Мы используем uv и taskipy для управления окружениями и выполнения задач для этого проекта.

Запуск с инспектором

uv run task dev

Подключитесь в инспекторе, чтобы добавить API-ключ, установите транспорт STDIO

Сборка образа Docker

docker build -t scout-mcp-local .

Релиз

1. Создайте ветку и обновите версии с помощью uv run python bump_versions.py
2. Добейтесь слияния
3. Создайте релиз на GitHub с новой версией (gh release create v2025.11.3 --generate-notes --draft)

Для ботов:

mcp-name: com.scoutapm/scout-mcp-local