Scout Monitoring MCP Server

Scout Monitoring MCP

Este repositório contém código para executar localmente um servidor MCP que pode acessar dados do Scout Monitoring via API do Scout. Fornecemos uma imagem Docker que pode ser baixada e executada pelo seu Assistente de IA para acessar dados do Scout Monitoring.

Isso coloca os dados de desempenho e erros do Scout Monitoring diretamente nas mãos do seu Assistente de IA. Para Rails, Django, FastAPI, Laravel e mais. Use-o para obter traces e erros com informações de linha de código que a IA pode usar para direcionar correções diretamente no seu editor e base de código. Consultas N+1, endpoints lentos, consultas lentas, inchaço de memória, problemas de throughput - todos os seus problemas de desempenho favoritos expostos e explicados exatamente onde você está trabalhando.

Se isso tornar sua vida um pouquinho melhor, por que não dar uma :star:?!

Assistente de Configuração

A maneira mais simples de configurar e começar a usar o Scout MCP é com nosso assistente de configuração interativo. Ele cuida de todos os pré-requisitos e etapas de instalação para você.

Execute via npx:

npx @scout_apm/wizard

Compile e execute a partir do código fonte:

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

O assistente irá guiá-lo através de:

• Selecionar sua plataforma de codificação de IA (Cursor, Claude Code, Claude Desktop)
• Inserir sua chave de API do Scout
• Configurar automaticamente as definições do servidor MCP

Plataformas Suportadas

O assistente atualmente suporta configuração para:

• Cursor - Configura automaticamente as definições do MCP
• Claude Code (CLI) - Fornece o comando correto para executar
• Claude Desktop - Atualiza o arquivo de configuração para Windows/Mac

Para todos os outros, ele produzirá JSON que você pode copiar/colar na configuração MCP do seu Assistente de IA.

Pré-requisitos

O Assistente é uma ótima maneira de começar, mas você também pode configurar as coisas manualmente. Você precisará ter ou criar uma conta no Scout Monitoring e obter uma chave de API.

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. Instale o Scout Agent em sua aplicação e envie dados do Scout!
   • Ruby
   • Python
   • PHP
   • Se você estiver testando isso localmente, certifique-se de que monitor: true, errors_enabled: true estejam definidos em sua configuração para a melhor experiência
3. Visite configurações para obter ou criar uma chave de API
   • Esta não é sua "Chave de Agente"; é a "Chave de API" que pode ser criada na página de Configurações
   • Esta é uma chave somente leitura que só pode acessar dados em sua conta
4. Instale o Docker. As instruções abaixo assumem que você pode iniciar um contêiner Docker

O servidor MCP não iniciará atualmente sem uma chave de API definida, seja no ambiente ou por um argumento de linha de comando na inicialização.

Instalação

Recomendamos usar a imagem Docker fornecida para executar o servidor MCP. Ela é destinada a ser iniciada pelo seu Assistente de IA e configurada com sua chave de API do Scout. Muitos clientes locais permitem especificar um comando para executar o servidor MCP em algum local. Alguns exemplos são fornecidos abaixo.

A imagem Docker está disponível no Docker Hub.

Claro, você sempre pode clonar este repositório e executar o servidor MCP diretamente; uv ou outras ferramentas de gerenciamento de ambiente são recomendadas.

Configurar um Cliente local (ex.: Claude/Cursor/VS Code Copilot)

Se você deseja configurar o MCP manualmente, isso geralmente significa apenas fornecer um comando para executar o servidor MCP com sua chave de API no ambiente para a configuração do seu Assistente de IA. Aqui está o formato do JSON (a chave de nível superior varia):

{
  "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"}
    }
  }
}

Usando o Scout Monitoring MCP

O MCP do Scout destina-se a colocar dados de erros e desempenho diretamente nas... mãos? do seu Assistente de IA. Use-o para obter traces e erros com informações de linha de código que a IA pode usar para direcionar correções diretamente no seu editor.

A maioria dos assistentes mostrará tanto chamadas de ferramentas brutas quanto realizará análises. Assistentes de desktop podem prontamente criar aplicações JS personalizadas para explorar quaisquer dados que você desejar. Assistentes integrados a editores de código podem usar dados de trace e backtraces de erros para fazer correções diretamente em sua base de código.

Combine o MCP do Scout com outras ferramentas do seu Assistente de IA para:

• Criar issues ricas no GitHub/GitLab com base em erros e dados de desempenho
• Tornar o JIRA divertido - faça seu Assistente de IA criar tickets com todos os detalhes
• Gerar PRs que corrigem erros específicos e problemas de desempenho

Ferramentas

O Scout MCP fornece as seguintes ferramentas para acessar dados do Scout APM:

• list_apps - Listar aplicações Scout APM disponíveis, com filtragem opcional por última data ativa
• get_app_metrics - Obter dados de métricas individuais (response_time, throughput, etc.) para uma aplicação específica
• get_app_endpoints - Obter todos os endpoints para uma aplicação com métricas de desempenho agregadas
• get_endpoint_metrics - Obter métricas de séries temporais para um endpoint específico em uma aplicação
• get_app_endpoint_traces - Obter traces recentes para uma aplicação filtrados por um endpoint específico
• get_app_trace - Obter um trace individual com todos os spans e informações detalhadas de execução
• get_app_error_groups - Obter grupos de erros recentes para uma aplicação, opcionalmente filtrados por endpoint
• get_app_insights - Obter insights de desempenho incluindo consultas N+1, inchaço de memória e consultas lentas

Recursos

O Scout MCP fornece modelos de configuração como recursos que seu assistente de IA pode ler e aplicar:

• scoutapm://config-resources/{framework} - Instruções de configuração para framework ou biblioteca suportada (rails, django, flask, fastapi)
• scoutapm://config-resources/list - Listar todos os modelos de configuração disponíveis
• scoutapm://metrics - Lista de todas as métricas disponíveis para Scout APM

Prompts Úteis

Configuração & Setup

• "Ajude-me a configurar o monitoramento Scout para minha aplicação Rails"
• "Crie um arquivo de configuração Scout APM para meu projeto Django com a chave ABC123"

Desempenho & Monitoramento

• "Resuma as ferramentas disponíveis no Scout Monitoring MCP."
• "Encontre os endpoints mais lentos para a aplicação my-app-name nos últimos 7 dias. Gere uma tabela com os resultados incluindo o tempo médio de resposta, throughput e tempo de resposta P95."
• "Mostre-me os erros de maior frequência para a aplicação Foo nas últimas 24 horas. Obtenha o detalhe do erro mais recente, examine o backtrace e sugira uma correção."
• "Obtenha quaisquer insights recentes de n+1 para a aplicação Bar. Puxe o trace específico por id e ajude-me a otimizá-lo com base nos dados de backtrace."

Uso de Tokens

Atualmente, estamos mais interessados em expandir as informações disponíveis do que estritamente controlar o tamanho da resposta de nossas ferramentas MCP. Se o seu Assistente de IA tiver um limite de tokens configurável (ex.: Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), recomendamos defini-lo generosamente alto, por exemplo, 50.000 tokens.

Desenvolvimento Local

Usamos uv e taskipy para gerenciar ambientes e executar tarefas para este projeto.

Executar com Inspector

uv run task dev

Conecte-se dentro do inspector para adicionar a chave de API, defina para transporte STDIO

Construir a imagem Docker

docker build -t scout-mcp-local .

Lançamento

1. Crie um branch e incremente as versões com uv run python bump_versions.py
2. Faça o merge
3. Crie um release no GitHub com a nova versão (gh release create v2025.11.3 --generate-notes --draft)

Para os bots:

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