Scout Monitoring MCP Server

Scout Monitoring MCP

Ce dépôt contient le code pour exécuter localement un serveur MCP capable d'accéder aux données de Scout Monitoring via l'API de Scout. Nous fournissons une image Docker qui peut être récupérée et exécutée par votre Assistant IA pour accéder aux données de Scout Monitoring.

Cela met les données de performance et d'erreur de Scout Monitoring directement entre les mains de votre Assistant IA. Pour Rails, Django, FastAPI, Laravel et plus encore. Utilisez-le pour obtenir des traces et des erreurs avec des informations ligne de code que l'IA peut utiliser pour cibler des corrections directement dans votre éditeur et votre base de code. Requêtes N+1, points de terminaison lents, requêtes lentes, surcharge mémoire, problèmes de débit - tous vos problèmes de performance préférés sont mis en évidence et expliqués là où vous travaillez.

Si cela vous simplifie un tant soit peu la vie, pourquoi ne pas lui mettre une :star: ?!

Assistant de configuration

Le moyen le plus simple de configurer et de commencer à utiliser le Scout MCP est notre assistant de configuration interactif. Il gère tous les prérequis et les étapes d'installation pour vous.

Exécuter via npx :

npx @scout_apm/wizard

Compiler et exécuter à partir des sources :

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

L'assistant vous guidera à travers :

• La sélection de votre plateforme de codage IA (Cursor, Claude Code, Claude Desktop)
• La saisie de votre clé API Scout
• La configuration automatique des paramètres du serveur MCP

Plateformes prises en charge

L'assistant prend actuellement en charge la configuration pour :

• Cursor - Configure automatiquement les paramètres MCP
• Claude Code (CLI) - Fournit la commande correcte à exécuter
• Claude Desktop - Met à jour le fichier de configuration pour Windows/Mac

Pour toutes les autres, il produira du JSON que vous pourrez copier/coller dans la configuration MCP de votre Assistant IA.

Prérequis

L'assistant est un excellent moyen de démarrer, mais vous pouvez également configurer les choses manuellement. Vous devrez avoir ou créer un compte Scout Monitoring et obtenir une clé API.

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. Installez l'Agent Scout dans votre application et envoyez des données Scout !
   • Ruby
   • Python
   • PHP
   • Si vous essayez ceci localement, assurez-vous que monitor: true, errors_enabled: true sont définis dans votre configuration pour une expérience optimale
3. Visitez les paramètres pour obtenir ou créer une clé API
   • Il ne s'agit pas de votre "Clé d'agent" ; c'est la "Clé API" qui peut être créée sur la page Paramètres
   • Il s'agit d'une clé en lecture seule qui ne peut accéder qu'aux données de votre compte
4. Installez Docker. Les instructions ci-dessous supposent que vous pouvez démarrer un conteneur Docker

Le serveur MCP ne démarrera pas actuellement sans une clé API définie, soit dans l'environnement, soit par un argument de ligne de commande au démarrage.

Installation

Nous recommandons d'utiliser l'image Docker fournie pour exécuter le serveur MCP. Il est destiné à être démarré par votre Assistant IA et configuré avec votre clé API Scout. De nombreux clients locaux permettent de spécifier une commande pour exécuter le serveur MCP à un emplacement donné. Quelques exemples sont fournis ci-dessous.

L'image Docker est disponible sur Docker Hub.

Bien sûr, vous pouvez toujours cloner ce dépôt et exécuter le serveur MCP directement ; uv ou d'autres outils de gestion d'environnement sont recommandés.

Configurer un client local (par exemple Claude/Cursor/VS Code Copilot)

Si vous souhaitez configurer le MCP manuellement, cela signifie généralement simplement fournir une commande pour exécuter le serveur MCP avec votre clé API dans l'environnement à la configuration de votre Assistant IA. Voici la forme du JSON (la clé de premier niveau varie) :

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

Utilisation du Scout Monitoring MCP

Le MCP de Scout est destiné à mettre les données d'erreur et de performance directement entre les... mains ? de votre Assistant IA. Utilisez-le pour obtenir des traces et des erreurs avec des informations ligne de code que l'IA peut utiliser pour cibler des corrections directement dans votre éditeur.

La plupart des assistants vous montreront à la fois les appels d'outils bruts et effectueront des analyses. Les assistants de bureau peuvent facilement créer des applications JS personnalisées pour explorer les données que vous souhaitez. Les assistants intégrés aux éditeurs de code peuvent utiliser les données de trace et les traces d'erreurs pour apporter des corrections directement dans votre base de code.

Combinez le MCP de Scout avec les autres outils de votre Assistant IA pour :

• Créer des tickets GitHub/GitLab riches basés sur les erreurs et les données de performance
• Rendre JIRA amusant - demandez à votre Assistant IA de créer des tickets avec tous les détails
• Générer des PR qui corrigent des erreurs et des problèmes de performance spécifiques

Outils

Le Scout MCP fournit les outils suivants pour accéder aux données Scout APM :

• list_apps - Lister les applications Scout APM disponibles, avec filtrage optionnel par date de dernière activité
• get_app_metrics - Obtenir des données de métriques individuelles (temps de réponse, débit, etc.) pour une application spécifique
• get_app_endpoints - Obtenir tous les points de terminaison d'une application avec des métriques de performance agrégées
• get_endpoint_metrics - Obtenir des métriques de séries temporelles pour un point de terminaison spécifique dans une application
• get_app_endpoint_traces - Obtenir les traces récentes d'une application filtrées sur un point de terminaison spécifique
• get_app_trace - Obtenir une trace individuelle avec toutes les spans et des informations d'exécution détaillées
• get_app_error_groups - Obtenir les groupes d'erreurs récents pour une application, filtrés optionnellement par point de terminaison
• get_app_insights - Obtenir des informations de performance incluant les requêtes N+1, la surcharge mémoire et les requêtes lentes

Ressources

Le Scout MCP fournit des modèles de configuration en tant que ressources que votre assistant IA peut lire et appliquer :

• scoutapm://config-resources/{framework} - Instructions de configuration pour le framework ou la bibliothèque pris en charge (rails, django, flask, fastapi)
• scoutapm://config-resources/list - Lister tous les modèles de configuration disponibles
• scoutapm://metrics - Liste de toutes les métriques disponibles pour Scout APM

Invites utiles

Configuration et paramétrage

• "Aide-moi à configurer la surveillance Scout pour mon application Rails"
• "Crée un fichier de configuration Scout APM pour mon projet Django avec la clé ABC123"

Performance et surveillance

• "Résume les outils disponibles dans le Scout Monitoring MCP."
• "Trouve les points de terminaison les plus lents pour l'application my-app-name au cours des 7 derniers jours. Génère un tableau avec les résultats incluant le temps de réponse moyen, le débit et le temps de réponse P95."
• "Montre-moi les erreurs les plus fréquentes pour l'application Foo au cours des dernières 24 heures. Obtiens le dernier détail d'erreur, examine la trace et suggère une correction."
• "Obtiens toutes les informations récentes sur les N+1 pour l'application Bar. Récupère la trace spécifique par ID et aide-moi à l'optimiser en fonction des données de trace."

Utilisation des jetons

Nous sommes actuellement plus intéressés par l'expansion des informations disponibles que par le contrôle strict de la taille des réponses de nos outils MCP. Si votre Assistant IA a une limite de jetons configurable (par exemple Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), nous recommandons de la définir généreusement, par exemple 50 000 jetons.

Développement local

Nous utilisons uv et taskipy pour gérer les environnements et exécuter les tâches de ce projet.

Exécuter avec l'inspecteur

uv run task dev

Connectez-vous dans l'inspecteur pour ajouter la clé API, réglez sur le transport STDIO

Construire l'image Docker

docker build -t scout-mcp-local .

Publication

1. Créez une branche et incrémentez les versions avec uv run python bump_versions.py
2. Faites fusionner cela
3. Créez une version GitHub avec la nouvelle version (gh release create v2025.11.3 --generate-notes --draft)

Pour les robots :

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