Scout Monitoring MCP

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 Agent в ваше приложение и отправляйте данные Scout!
   • Ruby
   • Python
   • PHP
   • Если вы пробуете это локально, убедитесь, что в вашей конфигурации заданы monitor: true, errors_enabled: true для наилучшего опыта
3. Перейдите в настройки, чтобы получить или создать API-ключ
   • Это не ваш «Agent Key»; это «API Key», который можно создать на странице Settings
   • Это ключ только для чтения, который может получать доступ только к данным в вашей учётной записи
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 для моего приложения на 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 для управления окружениями и запуска задач в этом проекте.

Запуск с Inspector

uv run task dev

Подключитесь в inspector, чтобы добавить 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)

Публикация релиза отправляет тег v*, и CI публикует Docker-образ, пакет PyPI, а затем записи в MCP Registry:

• server.json → com.scoutapm/scout-mcp-local (этот сервер; его версия поднимается с помощью bump_versions.py)
• server.remote.json → com.scoutapm/scout-monitoring (размещённый сервер по адресу https://scoutapm.com/mcp). Поднимайте его version вручную при изменении его метаданных; неизменённые версии пропускаются.

Ключ MCP Registry

Реестр проверяет, что мы владеем пространством имён com.scoutapm/*, через DNS TXT-запись на apex-домене scoutapm.com, содержащую публичный ключ Ed25519. CI входит в систему с соответствующим приватным ключом из секрета репозитория MCP_REGISTRY_PRIVATE_KEY. Чтобы сменить его:

openssl genpkey -algorithm Ed25519 -out key.pem
# Public key for the TXT record: replace the existing v=MCPv1 record, don't add a second one
echo "v=MCPv1; k=ed25519; p=$(openssl pkey -in key.pem -pubout -outform DER | tail -c 32 | base64)"
# Private key (hex) for the MCP_REGISTRY_PRIVATE_KEY secret
openssl pkey -in key.pem -noout -text | grep -A3 "priv:" | tail -n +2 | tr -d ' :\n'

Для ботов:

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