Scout Monitoring MCP

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 di-pull dan dijalankan oleh Asisten AI Anda untuk mengakses data Scout Monitoring.

Ini menempatkan data performa dan error Scout Monitoring langsung di tangan Asisten AI 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. Query N+1, endpoint lambat, query lambat, pembengkakan memori, masalah throughput - semua masalah performa favorit Anda muncul dan dijelaskan tepat di tempat Anda bekerja.

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

Wizard Penyiapan

Cara paling sederhana untuk mengonfigurasi dan mulai menggunakan Scout MCP adalah dengan wizard penyiapan interaktif kami. Wizard ini menangani semua prasyarat dan langkah instalasi untuk Anda.

Jalankan via npx:

npx @scout_apm/wizard

Build dan jalankan dari sumber:

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

Wizard akan memandu Anda melalui:

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

Platform yang Didukung

Wizard saat ini mendukung penyiapan untuk:

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

Untuk platform lainnya, wizard akan menampilkan JSON yang dapat Anda salin/tempel ke konfigurasi MCP Asisten AI Anda.

Prasyarat

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

1. Daftar di sini
2. Instal Scout Agent di aplikasi Anda dan kirim data Scout!
   • Ruby
   • Python
   • PHP
   • Jika Anda mencoba ini secara lokal, pastikan monitor: true, errors_enabled: true diatur di konfigurasi Anda untuk pengalaman terbaik
3. Kunjungi pengaturan untuk mendapatkan atau membuat API key
   • Ini bukan "Agent Key" Anda; ini adalah "API Key" yang dapat dibuat di halaman Settings
   • Ini adalah key read-only yang hanya dapat mengakses data di akun Anda
4. Instal Docker. Petunjuk di bawah mengasumsikan Anda dapat menjalankan kontainer Docker

Server MCP saat ini tidak akan berjalan tanpa API key yang diatur, baik di environment maupun melalui argumen command-line saat startup.

Instalasi

Kami merekomendasikan menggunakan image Docker yang disediakan untuk menjalankan server MCP. Image ini dimaksudkan untuk dijalankan oleh Asisten AI Anda dan dikonfigurasi dengan API key Scout Anda. Banyak klien lokal memungkinkan Anda menentukan perintah untuk menjalankan server MCP di suatu lokasi. Beberapa contoh disediakan di bawah.

Image Docker tersedia di Docker Hub.

Tentu saja, Anda selalu dapat meng-clone repo ini dan menjalankan server MCP secara langsung; uv atau alat manajemen environment lainnya direkomendasikan.

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

Jika Anda ingin mengonfigurasi MCP secara manual, ini biasanya hanya berarti memberikan perintah untuk menjalankan server MCP dengan API key Anda di environment ke konfigurasi Asisten AI Anda. Berikut adalah bentuk JSON-nya (key 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

MCP Scout dimaksudkan untuk menempatkan data error dan performa langsung di... tangan? Asisten AI 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 menampilkan panggilan tool 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 editor kode dapat menggunakan data trace dan backtrace error untuk melakukan perbaikan langsung di basis kode Anda.

Gabungkan MCP Scout dengan tool lain Asisten AI Anda untuk:

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

Tool

Scout MCP menyediakan tool berikut untuk mengakses data Scout APM:

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

Resource

Scout MCP menyediakan template konfigurasi sebagai resource yang dapat dibaca dan diterapkan oleh asisten AI Anda:

• scoutapm://config-resources/{framework} - Petunjuk penyiapan untuk framework atau library yang didukung (rails, django, flask, fastapi)
• scoutapm://config-resources/list - Menampilkan daftar semua template konfigurasi yang tersedia
• scoutapm://metrics - Daftar semua metrik yang tersedia untuk Scout APM

Prompt yang Berguna

Penyiapan & Konfigurasi

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

Performa & Pemantauan

• "Ringkas tool yang tersedia di Scout Monitoring MCP."
• "Temukan endpoint paling lambat untuk aplikasi my-app-name dalam 7 hari terakhir. Buat tabel dengan hasilnya termasuk rata-rata response time, throughput, dan P95 response time."
• "Tampilkan error dengan frekuensi tertinggi untuk aplikasi Foo dalam 24 jam terakhir. Dapatkan detail error terbaru, periksa backtrace dan sarankan perbaikan."
• "Dapatkan insight n+1 terbaru untuk aplikasi Bar. Ambil trace spesifik berdasarkan id dan bantu saya mengoptimalkannya berdasarkan data backtrace."

Penggunaan Token

Saat ini kami lebih tertarik untuk memperluas informasi yang tersedia daripada secara ketat mengendalikan ukuran respons dari tool MCP kami. Jika Asisten AI Anda memiliki batas token yang dapat dikonfigurasi (mis. Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), kami merekomendasikan mengaturnya dengan nilai yang cukup tinggi, mis. 50.000 token.

Pengembangan Lokal

Kami menggunakan uv dan taskipy untuk mengelola environment dan menjalankan task untuk proyek ini.

Jalankan dengan Inspector

uv run task dev

Hubungkan di dalam inspector untuk menambahkan API key, atur ke transport STDIO

Build image Docker

docker build -t scout-mcp-local .

Rilis

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

Menerbitkan rilis akan mendorong tag v*, dan CI menerbitkan image Docker, paket PyPI, lalu entri MCP Registry:

• server.json → com.scoutapm/scout-mcp-local (server ini; versinya dinaikkan oleh bump_versions.py)
• server.remote.json → com.scoutapm/scout-monitoring (server yang dihosting di https://scoutapm.com/mcp). Naikkan version secara manual saat Anda mengubah metadatanya; versi yang tidak berubah akan dilewati.

Key MCP Registry

Registry memverifikasi bahwa kami memiliki namespace com.scoutapm/* melalui record DNS TXT di apex scoutapm.com yang berisi public key Ed25519. CI masuk dengan private key yang cocok dari secret repositori MCP_REGISTRY_PRIVATE_KEY. Untuk merotasinya:

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'

Untuk bot:

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