Scout Monitoring MCP Server

Scout Monitoring MCP

Repositori ini berisi kode untuk menjalankan server MCP secara lokal yang dapat mengakses data Scout Monitoring melalui API Scout. Kami menyediakan image Docker yang dapat ditarik dan dijalankan oleh AI Assistant Anda untuk mengakses data Scout Monitoring.

Ini menempatkan data performa dan error Scout Monitoring langsung di tangan AI Assistant Anda. Untuk Rails, Django, FastAPI, Laravel, dan lainnya. Gunakan untuk mendapatkan trace dan error dengan informasi baris kode yang dapat digunakan AI untuk menargetkan perbaikan langsung di editor dan basis kode Anda. N+1 query, endpoint lambat, query lambat, pembengkakan memori, masalah throughput - semua masalah performa favorit Anda dimunculkan dan dijelaskan tepat di tempat Anda bekerja.

Jika ini membuat hidup Anda sedikit lebih baik, mengapa tidak :star: saja?!

Wizard Pengaturan

Cara termudah untuk mengonfigurasi dan mulai menggunakan Scout MCP adalah dengan wizard pengaturan interaktif kami. Ini menangani semua prasyarat dan langkah instalasi untuk Anda.

Jalankan melalui npx:

npx @scout_apm/wizard

Bangun dan jalankan dari sumber:

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

Wizard akan memandu Anda melalui:

• Memilih platform AI coding Anda (Cursor, Claude Code, Claude Desktop)
• Memasukkan kunci API Scout Anda
• Mengonfigurasi pengaturan server MCP secara otomatis

Platform yang Didukung

Wizard saat ini mendukung pengaturan untuk:

• Cursor - Mengonfigurasi pengaturan MCP secara otomatis
• Claude Code (CLI) - Menyediakan perintah yang benar untuk dijalankan
• Claude Desktop - Memperbarui file konfigurasi untuk Windows/Mac

Untuk semua yang lain, ini akan menghasilkan JSON yang dapat Anda salin/tempel ke konfigurasi MCP AI Assistant Anda.

Prasyarat

Wizard adalah cara yang bagus untuk memulai, tetapi Anda juga dapat mengatur semuanya secara manual. Anda perlu memiliki atau membuat akun Scout Monitoring dan mendapatkan kunci API.

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. Instal Agen Scout di aplikasi Anda dan kirim data Scout!
   • Ruby
   • Python
   • PHP
   • Jika Anda mencoba ini secara lokal, pastikan monitor: true, errors_enabled: true diatur dalam konfigurasi Anda untuk pengalaman terbaik
3. Kunjungi pengaturan untuk mendapatkan atau membuat kunci API
   • Ini bukan "Kunci Agen" Anda; ini adalah "Kunci API" yang dapat dibuat di halaman Pengaturan
   • Ini adalah kunci hanya-baca yang hanya dapat mengakses data di akun Anda
4. Instal Docker. Instruksi di bawah mengasumsikan Anda dapat memulai kontainer Docker

Server MCP saat ini tidak akan mulai tanpa kunci API yang diatur, baik di lingkungan atau oleh argumen baris perintah saat startup.

Instalasi

Kami merekomendasikan menggunakan image Docker yang disediakan untuk menjalankan server MCP. Ini dimaksudkan untuk dimulai oleh AI Assistant Anda dan dikonfigurasi dengan kunci API Scout Anda. Banyak klien lokal mengizinkan penentuan perintah untuk menjalankan server MCP di beberapa lokasi. Beberapa contoh disediakan di bawah.

Image Docker tersedia di Docker Hub.

Tentu saja, Anda selalu dapat mengkloning repo ini dan menjalankan server MCP secara langsung; uv atau alat manajemen lingkungan lainnya direkomendasikan.

Konfigurasi Klien Lokal (mis. Claude/Cursor/VS Code Copilot)

Jika Anda ingin mengonfigurasi MCP secara manual, ini biasanya hanya berarti menyediakan perintah untuk menjalankan server MCP dengan kunci API Anda di lingkungan ke konfigurasi AI Assistant Anda. Berikut adalah bentuk JSON (kunci tingkat atas bervariasi):

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

Menggunakan Scout Monitoring MCP

Scout MCP dimaksudkan untuk menempatkan data error dan performa langsung di... tangan? AI Assistant Anda. Gunakan untuk mendapatkan trace dan error dengan informasi baris kode yang dapat digunakan AI untuk menargetkan perbaikan langsung di editor Anda.

Sebagian besar asisten akan menunjukkan panggilan alat mentah dan melakukan analisis. Asisten desktop dapat dengan mudah membuat aplikasi JS kustom untuk menjelajahi data apa pun yang Anda inginkan. Asisten yang terintegrasi ke dalam editor kode dapat menggunakan data trace dan backtrace error untuk membuat perbaikan langsung di basis kode Anda.

Gabungkan Scout MCP dengan alat lain AI Assistant Anda untuk:

• Membuat isu GitHub/GitLab yang kaya berdasarkan data error dan performa
• Membuat JIRA menyenangkan - minta AI Assistant Anda membuat tiket dengan semua detail
• Menghasilkan PR yang memperbaiki error dan masalah performa tertentu

Alat

Scout MCP menyediakan alat berikut untuk mengakses data Scout APM:

• list_apps - Daftar aplikasi Scout APM yang tersedia, dengan penyaringan opsional berdasarkan tanggal aktif terakhir
• get_app_metrics - Dapatkan data metrik individual (response_time, throughput, dll.) untuk aplikasi tertentu
• get_app_endpoints - Dapatkan semua endpoint untuk aplikasi dengan metrik performa agregat
• get_endpoint_metrics - Dapatkan metrik timeseries untuk endpoint tertentu dalam aplikasi
• get_app_endpoint_traces - Dapatkan trace terbaru untuk aplikasi yang difilter ke endpoint tertentu
• get_app_trace - Dapatkan trace individual dengan semua span dan informasi eksekusi terperinci
• get_app_error_groups - Dapatkan grup error terbaru untuk aplikasi, opsional difilter berdasarkan endpoint
• get_app_insights - Dapatkan wawasan performa termasuk N+1 query, pembengkakan memori, dan query lambat

Sumber Daya

Scout MCP menyediakan template konfigurasi sebagai sumber daya yang dapat dibaca dan diterapkan oleh AI assistant Anda:

• scoutapm://config-resources/{framework} - Instruksi pengaturan untuk framework atau pustaka yang didukung (rails, django, flask, fastapi)
• scoutapm://config-resources/list - Daftar semua template konfigurasi yang tersedia
• scoutapm://metrics - Daftar semua metrik yang tersedia untuk Scout APM

Prompt Berguna

Pengaturan & Konfigurasi

• "Bantu saya mengatur pemantauan Scout untuk aplikasi Rails saya"
• "Buat file konfigurasi Scout APM untuk proyek Django saya dengan kunci ABC123"

Performa & Pemantauan

• "Ringkas alat yang tersedia di Scout Monitoring MCP."
• "Temukan endpoint paling lambat untuk aplikasi my-app-name dalam 7 hari terakhir. Hasilkan tabel dengan hasil termasuk waktu respons rata-rata, throughput, dan waktu respons P95."
• "Tunjukkan error frekuensi tertinggi untuk aplikasi Foo dalam 24 jam terakhir. Dapatkan detail error terbaru, periksa backtrace dan sarankan perbaikan."
• "Dapatkan wawasan n+1 terbaru untuk aplikasi Bar. Tarik trace spesifik berdasarkan id dan bantu saya mengoptimalkannya berdasarkan data backtrace."

Penggunaan Token

Kami saat ini lebih tertarik untuk memperluas informasi yang tersedia daripada secara ketat mengontrol ukuran respons dari alat MCP kami. Jika AI Assistant Anda memiliki batas token yang dapat dikonfigurasi (mis. Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), kami merekomendasikan mengaturnya dengan murah hati tinggi, mis. 50.000 token.

Pengembangan Lokal

Kami menggunakan uv dan taskipy untuk mengelola lingkungan dan menjalankan tugas untuk proyek ini.

Jalankan dengan Inspector

uv run task dev

Hubungkan dalam inspector untuk menambahkan kunci API, atur ke transport STDIO

Bangun image Docker

docker build -t scout-mcp-local .

Rilis

1. Cabang dan naikkan versi dengan uv run python bump_versions.py
2. Gabungkan itu
3. Buat rilis GitHub dengan versi baru (gh release create v2025.11.3 --generate-notes --draft)

Untuk bot:

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