Scout Monitoring MCP Server

Scout Monitoring MCP

Dieses Repository enthält Code, um einen MCP-Server lokal auszuführen, der über die Scout-API auf Scout Monitoring-Daten zugreifen kann. Wir stellen ein Docker-Image bereit, das von Ihrem KI-Assistenten abgerufen und ausgeführt werden kann, um auf Scout-Monitoring-Daten zuzugreifen.

Damit erhalten Sie die Performance- und Fehlerdaten von Scout Monitoring direkt in die Hände Ihres KI-Assistenten. Für Rails, Django, FastAPI, Laravel und mehr. Nutzen Sie es, um Traces und Fehler mit Codezeilen-Informationen zu erhalten, die die KI verwenden kann, um Korrekturen direkt in Ihrem Editor und Ihrer Codebasis vorzunehmen. N+1-Abfragen, langsame Endpunkte, langsame Abfragen, Memory Bloat, Durchsatzprobleme – all Ihre bekannten Performance-Probleme werden genau dort aufgedeckt und erklärt, wo Sie arbeiten.

Wenn Ihnen das das Leben ein kleines bisschen erleichtert, warum geben Sie ihm nicht einen :star: ?!

Einrichtungsassistent

Der einfachste Weg, den Scout MCP zu konfigurieren und zu nutzen, ist unser interaktiver Einrichtungsassistent. Er übernimmt alle Voraussetzungen und Installationsschritte für Sie.

Ausführung via npx:

npx @scout_apm/wizard

Build und Ausführung aus dem Quellcode:

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

Der Assistent führt Sie durch:

• Auswahl Ihrer KI-Coding-Plattform (Cursor, Claude Code, Claude Desktop)
• Eingabe Ihres Scout-API-Schlüssels
• Automatische Konfiguration der MCP-Server-Einstellungen

Unterstützte Plattformen

Der Assistent unterstützt derzeit die Einrichtung für:

• Cursor – Konfiguriert die MCP-Einstellungen automatisch
• Claude Code (CLI) – Liefert den korrekten Ausführungsbefehl
• Claude Desktop – Aktualisiert die Konfigurationsdatei für Windows/Mac

Für alle anderen gibt er JSON aus, das Sie in die MCP-Konfiguration Ihres KI-Assistenten kopieren/einfügen können.

Voraussetzungen

Der Assistent ist ein großartiger Einstieg, aber Sie können die Einrichtung auch manuell vornehmen. Sie benötigen ein Scout-Monitoring-Konto oder müssen eines erstellen und einen API-Schlüssel beziehen.

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. Installieren Sie den Scout-Agenten in Ihrer Anwendung und senden Sie Scout-Daten!
   • Ruby
   • Python
   • PHP
   • Wenn Sie dies lokal ausprobieren, stellen Sie sicher, dass monitor: true, errors_enabled: true in Ihrer Konfiguration gesetzt sind, um das beste Erlebnis zu haben
3. Besuchen Sie die Einstellungen, um einen API-Schlüssel zu erhalten oder zu erstellen
   • Dies ist nicht Ihr „Agent Key“; es ist der „API Key“, der auf der Einstellungsseite erstellt werden kann
   • Dies ist ein schreibgeschützter Schlüssel, der nur auf Daten in Ihrem Konto zugreifen kann
4. Installieren Sie Docker. Die folgenden Anweisungen setzen voraus, dass Sie einen Docker-Container starten können

Der MCP-Server startet derzeit nicht ohne einen gesetzten API-Schlüssel, entweder in der Umgebung oder über ein Kommandozeilenargument beim Start.

Installation

Wir empfehlen, das bereitgestellte Docker-Image zu verwenden, um den MCP-Server auszuführen. Es ist dafür vorgesehen, von Ihrem KI-Assistenten gestartet und mit Ihrem Scout-API-Schlüssel konfiguriert zu werden. Viele lokale Clients erlauben die Angabe eines Befehls, um den MCP-Server an einem bestimmten Ort auszuführen. Nachfolgend einige Beispiele.

Das Docker-Image ist auf Docker Hub verfügbar.

Natürlich können Sie dieses Repository jederzeit klonen und den MCP-Server direkt ausführen; uv oder andere Umgebungsverwaltungstools werden empfohlen.

Einen lokalen Client konfigurieren (z. B. Claude/Cursor/VS Code Copilot)

Wenn Sie den MCP manuell konfigurieren möchten, bedeutet dies in der Regel nur, dass Sie einen Befehl zum Ausführen des MCP-Servers mit Ihrem API-Schlüssel in der Umgebung in der Konfiguration Ihres KI-Assistenten angeben. Hier ist die Struktur des JSON (der Schlüssel auf oberster Ebene variiert):

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

Verwendung des Scout Monitoring MCP

Scouts MCP ist dazu gedacht, Fehler- und Performancedaten direkt in die... Hände? Ihres KI-Assistenten zu legen. Nutzen Sie es, um Traces und Fehler mit Codezeilen-Informationen zu erhalten, die die KI verwenden kann, um Korrekturen direkt in Ihrem Editor vorzunehmen.

Die meisten Assistenten zeigen sowohl rohe Tool-Aufrufe als auch Analysen an. Desktop-Assistenten können problemlos benutzerdefinierte JS-Anwendungen erstellen, um beliebige Daten zu erkunden. In Code-Editoren integrierte Assistenten können Trace-Daten und Fehler-Backtraces nutzen, um Korrekturen direkt in Ihrer Codebasis vorzunehmen.

Kombinieren Sie Scouts MCP mit den anderen Tools Ihres KI-Assistenten, um:

• Umfangreiche GitHub-/GitLab-Issues basierend auf Fehlern und Performancedaten zu erstellen
• JIRA unterhaltsam zu machen – lassen Sie Ihren KI-Assistenten Tickets mit allen Details erstellen
• PRs zu generieren, die spezifische Fehler und Performance-Probleme beheben

Tools

Der Scout MCP bietet die folgenden Tools für den Zugriff auf Scout-APM-Daten:

• list_apps – Verfügbare Scout-APM-Anwendungen auflisten, mit optionaler Filterung nach letztem Aktivitätsdatum
• get_app_metrics – Einzelne Metrikdaten (response_time, throughput usw.) für eine bestimmte Anwendung abrufen
• get_app_endpoints – Alle Endpunkte für eine Anwendung mit aggregierten Performance-Metriken abrufen
• get_endpoint_metrics – Zeitreihenmetriken für einen bestimmten Endpunkt in einer Anwendung abrufen
• get_app_endpoint_traces – Aktuelle Traces für eine App abrufen, gefiltert nach einem bestimmten Endpunkt
• get_app_trace – Einen einzelnen Trace mit allen Spans und detaillierten Ausführungsinformationen abrufen
• get_app_error_groups – Aktuelle Fehlergruppen für eine App abrufen, optional gefiltert nach Endpunkt
• get_app_insights – Performance-Erkenntnisse abrufen, einschließlich N+1-Abfragen, Memory Bloat und langsamer Abfragen

Ressourcen

Der Scout MCP stellt Konfigurationsvorlagen als Ressourcen bereit, die Ihr KI-Assistent lesen und anwenden kann:

• scoutapm://config-resources/{framework} – Einrichtungsanweisungen für unterstützte Frameworks oder Bibliotheken (rails, django, flask, fastapi)
• scoutapm://config-resources/list – Alle verfügbaren Konfigurationsvorlagen auflisten
• scoutapm://metrics – Liste aller verfügbaren Metriken für Scout APM

Nützliche Prompts

Einrichtung & Konfiguration

• „Hilf mir, Scout Monitoring für meine Rails-Anwendung einzurichten“
• „Erstelle eine Scout-APM-Konfigurationsdatei für mein Django-Projekt mit dem Schlüssel ABC123“

Performance & Überwachung

• „Fasse die verfügbaren Tools im Scout Monitoring MCP zusammen.“
• „Finde die langsamsten Endpunkte für App my-app-name in den letzten 7 Tagen. Erstelle eine Tabelle mit den Ergebnissen, einschließlich der durchschnittlichen Antwortzeit, des Durchsatzes und der P95-Antwortzeit.“
• „Zeige mir die häufigsten Fehler für App Foo in den letzten 24 Stunden. Rufe das neueste Fehlerdetail ab, untersuche den Backtrace und schlage eine Lösung vor.“
• „Rufe alle aktuellen N+1-Erkenntnisse für App Bar ab. Hole den spezifischen Trace anhand der ID und hilf mir, ihn basierend auf den Backtrace-Daten zu optimieren.“

Token-Nutzung

Wir sind derzeit mehr daran interessiert, die verfügbaren Informationen zu erweitern, als die Antwortgröße unserer MCP-Tools strikt zu kontrollieren. Wenn Ihr KI-Assistent ein konfigurierbares Token-Limit hat (z. B. Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), empfehlen wir, es großzügig hoch anzusetzen, z. B. 50.000 Token.

Lokale Entwicklung

Wir verwenden uv und taskipy, um Umgebungen zu verwalten und Aufgaben für dieses Projekt auszuführen.

Mit Inspector ausführen

uv run task dev

Im Inspector verbinden, um den API-Schlüssel hinzuzufügen, auf STDIO-Transport einstellen

Das Docker-Image bauen

docker build -t scout-mcp-local .

Release

1. Branch erstellen und Versionen mit uv run python bump_versions.py erhöhen
2. Mergen lassen
3. Ein GitHub-Release mit der neuen Version erstellen (gh release create v2025.11.3 --generate-notes --draft)

Für die Bots:

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