Scout Monitoring MCP Server

Scout Monitoring MCP

ที่เก็บนี้มีโค้ดสำหรับรันเซิร์ฟเวอร์ MCP ในเครื่องที่สามารถเข้าถึงข้อมูล Scout Monitoring ผ่าน API ของ Scout เราให้อิมเมจ Docker ที่สามารถดึงและรันโดย ผู้ช่วย AI ของคุณเพื่อเข้าถึงข้อมูล Scout Monitoring

สิ่งนี้ทำให้ข้อมูลประสิทธิภาพและข้อผิดพลาดของ Scout Monitoring อยู่ในมือผู้ช่วย AI ของคุณโดยตรง สำหรับ Rails, Django, FastAPI, Laravel และอื่นๆ ใช้เพื่อรับ traces และ errors พร้อมข้อมูล line-of-code ที่ AI สามารถใช้เพื่อกำหนดเป้าหมายการแก้ไขได้ใน editor และ codebase ของคุณ N+1 queries, slow endpoints, slow queries, memory bloat, throughput issues - ปัญหาประสิทธิภาพทั้งหมดที่คุณชื่นชอบจะปรากฏ และอธิบายในที่ที่คุณทำงานอยู่

หากสิ่งนี้ทำให้ชีวิตคุณดีขึ้นเล็กน้อย ทำไมไม่ :star: มันล่ะ?!

ตัวช่วยตั้งค่า

วิธีที่ง่ายที่สุดในการกำหนดค่าและเริ่มใช้ Scout MCP คือการใช้ตัวช่วยตั้งค่าแบบโต้ตอบของเรา มันจัดการข้อกำหนดเบื้องต้นและขั้นตอนการติดตั้งทั้งหมดให้คุณ

รันผ่าน npx:

npx @scout_apm/wizard

สร้างและรันจากซอร์ส:

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

ตัวช่วยจะแนะนำคุณผ่าน:

• การเลือกแพลตฟอร์ม AI coding ของคุณ (Cursor, Claude Code, Claude Desktop)
• การป้อน Scout API key ของคุณ
• การกำหนดค่าการตั้งค่าเซิร์ฟเวอร์ MCP โดยอัตโนมัติ

แพลตฟอร์มที่รองรับ

ตัวช่วยปัจจุบันรองรับการตั้งค่าสำหรับ:

• Cursor - กำหนดค่าการตั้งค่า MCP โดยอัตโนมัติ
• Claude Code (CLI) - ให้คำสั่งที่ถูกต้องเพื่อรัน
• Claude Desktop - อัปเดตไฟล์การกำหนดค่าสำหรับ Windows/Mac

สำหรับอื่นๆ ทั้งหมด มันจะส่งออก JSON ที่คุณสามารถคัดลอก/วางลงในการกำหนดค่า MCP ของผู้ช่วย AI ของคุณ

ข้อกำหนดเบื้องต้น

ตัวช่วยเป็นวิธีที่ดีในการเริ่มต้น แต่คุณสามารถตั้งค่าด้วยตนเองได้เช่นกัน คุณจะต้องมีหรือสร้างบัญชี Scout Monitoring และรับ API key

1. https://scoutapm.com/users/sign_up?utm_source=github&utm_medium=github&utm_campaign=scout-mcp-local
2. ติดตั้ง Scout Agent ในแอปพลิเคชันของคุณและส่งข้อมูล Scout!
   • Ruby
   • Python
   • PHP
   • หากคุณกำลังลองใช้ในเครื่อง ตรวจสอบให้แน่ใจว่าได้ตั้งค่า monitor: true, errors_enabled: true ในการกำหนดค่าของคุณเพื่อประสบการณ์ที่ดีที่สุด
3. ไปที่ settings เพื่อรับหรือสร้าง API key
   • นี่ ไม่ใช่ "Agent Key" ของคุณ; มันคือ "API Key" ที่สามารถสร้างได้บน หน้า Settings
   • นี่คือคีย์แบบอ่านอย่างเดียวที่สามารถเข้าถึงข้อมูลในบัญชีของคุณเท่านั้น
4. ติดตั้ง Docker คำแนะนำด้านล่างถือว่าคุณสามารถเริ่มคอนเทนเนอร์ Docker ได้

เซิร์ฟเวอร์ MCP จะไม่เริ่มทำงานหากไม่มี API key ที่ตั้งไว้ ไม่ว่าจะใน environment หรือโดยอาร์กิวเมนต์บรรทัดคำสั่งเมื่อเริ่มต้น

การติดตั้ง

เราแนะนำให้ใช้อิมเมจ Docker ที่ให้มาเพื่อรันเซิร์ฟเวอร์ MCP มันมีจุดประสงค์ให้เริ่มโดยผู้ช่วย AI ของคุณและกำหนดค่าด้วย Scout API key ของคุณ ไคลเอนต์ท้องถิ่นจำนวนมากอนุญาตให้ระบุคำสั่งเพื่อรันเซิร์ฟเวอร์ MCP ในบาง ตำแหน่ง ตัวอย่างบางส่วนมีให้ด้านล่าง

อิมเมจ Docker มีให้บน Docker Hub

แน่นอน คุณสามารถโคลนที่เก็บนี้และรันเซิร์ฟเวอร์ MCP โดยตรงได้เสมอ; แนะนำให้ใช้ uv หรือเครื่องมือ จัดการ environment อื่นๆ

กำหนดค่าไคลเอนต์ท้องถิ่น (เช่น Claude/Cursor/VS Code Copilot)

หากคุณต้องการกำหนดค่า MCP ด้วยตนเอง โดยปกติแล้วนี่หมายถึงการให้คำสั่งเพื่อรันเซิร์ฟเวอร์ MCP พร้อม API key ของคุณใน environment ไปยังการกำหนดค่าของผู้ช่วย AI ของคุณ นี่คือรูปแบบของ JSON (คีย์ระดับบนสุดแตกต่างกันไป):

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

การใช้ Scout Monitoring MCP

MCP ของ Scout มีจุดประสงค์เพื่อนำข้อมูลข้อผิดพลาดและประสิทธิภาพไปอยู่ใน... มือ? ของผู้ช่วย AI ของคุณโดยตรง ใช้เพื่อรับ traces และ errors พร้อมข้อมูล line-of-code ที่ AI สามารถใช้เพื่อกำหนดเป้าหมาย การแก้ไขได้ใน editor ของคุณ

ผู้ช่วยส่วนใหญ่จะแสดงทั้งการเรียกใช้เครื่องมือดิบและทำการวิเคราะห์ ผู้ช่วยเดสก์ท็อป สามารถสร้างแอปพลิเคชัน JS แบบกำหนดเองเพื่อสำรวจข้อมูลใดๆ ที่คุณต้องการได้อย่างง่ายดาย ผู้ช่วยที่รวมเข้ากับ code editor สามารถใช้ข้อมูล trace และ error backtraces เพื่อทำ การแก้ไขใน codebase ของคุณ

รวม MCP ของ Scout กับเครื่องมืออื่นๆ ของผู้ช่วย AI ของคุณเพื่อ:

• สร้าง issues บน GitHub/GitLab ที่มีรายละเอียดตามข้อมูลข้อผิดพลาดและประสิทธิภาพ
• ทำให้ JIRA สนุก - ให้ผู้ช่วย AI ของคุณสร้าง tickets พร้อมรายละเอียดทั้งหมด
• สร้าง PRs ที่แก้ไขข้อผิดพลาดและปัญหาประสิทธิภาพเฉพาะ

เครื่องมือ

Scout MCP มีเครื่องมือต่อไปนี้สำหรับการเข้าถึงข้อมูล Scout APM:

• list_apps - แสดงรายการแอปพลิเคชัน Scout APM ที่มีอยู่ พร้อมการกรองตามวันที่ใช้งานล่าสุด
• get_app_metrics - รับข้อมูลเมตริกรายตัว (response_time, throughput, ฯลฯ) สำหรับแอปพลิเคชันเฉพาะ
• get_app_endpoints - รับ endpoints ทั้งหมดสำหรับแอปพลิเคชันพร้อมเมตริกประสิทธิภาพรวม
• get_endpoint_metrics - รับเมตริก timeseries สำหรับ endpoint เฉพาะในแอปพลิเคชัน
• get_app_endpoint_traces - รับ traces ล่าสุดสำหรับแอปที่กรองไปยัง endpoint เฉพาะ
• get_app_trace - รับ trace รายตัวพร้อม spans ทั้งหมดและข้อมูลการดำเนินการโดยละเอียด
• get_app_error_groups - รับกลุ่มข้อผิดพลาดล่าสุดสำหรับแอป กรองตาม endpoint ได้
• get_app_insights - รับข้อมูลเชิงลึกด้านประสิทธิภาพรวมถึง N+1 queries, memory bloat, และ slow queries

ทรัพยากร

Scout MCP มีเทมเพลตการกำหนดค่าเป็นทรัพยากรที่ผู้ช่วย AI ของคุณสามารถอ่านและนำไปใช้:

• scoutapm://config-resources/{framework} - คำแนะนำการตั้งค่าสำหรับ framework หรือ library ที่รองรับ (rails, django, flask, fastapi)
• scoutapm://config-resources/list - แสดงรายการเทมเพลตการกำหนดค่าทั้งหมดที่มี
• scoutapm://metrics - รายการเมตริกทั้งหมดที่มีสำหรับ Scout APM

พรอมต์ที่มีประโยชน์

การตั้งค่าและการกำหนดค่า

• "ช่วยฉันตั้งค่า Scout monitoring สำหรับแอปพลิเคชัน Rails ของฉัน"
• "สร้างไฟล์การกำหนดค่า Scout APM สำหรับโปรเจกต์ Django ของฉันด้วยคีย์ ABC123"

ประสิทธิภาพและการตรวจสอบ

• "สรุปเครื่องมือที่มีใน Scout Monitoring MCP"
• "ค้นหา endpoints ที่ช้าที่สุดสำหรับแอป my-app-name ใน 7 วันที่ผ่านมา สร้างตาราง พร้อมผลลัพธ์รวมถึงเวลาตอบสนองเฉลี่ย throughput และเวลาตอบสนอง P95"
• "แสดงข้อผิดพลาดที่มีความถี่สูงสุดสำหรับแอป Foo ใน 24 ชั่วโมงที่ผ่านมา รับ รายละเอียดข้อผิดพลาดล่าสุด ตรวจสอบ backtrace และแนะนำการแก้ไข"
• "รับข้อมูลเชิงลึก n+1 ล่าสุดสำหรับแอป Bar ดึง trace เฉพาะตาม id และช่วยฉัน ปรับให้เหมาะสมตามข้อมูล backtrace"

การใช้โทเค็น

ปัจจุบันเราสนใจในการขยายข้อมูลที่มีมากกว่าการควบคุม ขนาดการตอบกลับจากเครื่องมือ MCP ของเราอย่างเข้มงวด หากผู้ช่วย AI ของคุณมีขีดจำกัดโทเค็นที่กำหนดค่าได้ (เช่น Claude Code export MAX_MCP_OUTPUT_TOKENS=50000) เราแนะนำ ให้ตั้งค่าสูงพอสมควร เช่น 50,000 โทเค็น

การพัฒนาท้องถิ่น

เราใช้ uv และ taskipy เพื่อจัดการ environments และรันงานสำหรับโปรเจกต์นี้

รันด้วย Inspector

uv run task dev

เชื่อมต่อภายใน inspector เพื่อเพิ่ม API key ตั้งค่าเป็นการขนส่ง STDIO

สร้างอิมเมจ Docker

docker build -t scout-mcp-local .

การเผยแพร่

1. สร้าง branch และเพิ่มเวอร์ชันด้วย uv run python bump_versions.py
2. ให้ merge เข้าไป
3. สร้าง GitHub release ด้วยเวอร์ชันใหม่ (gh release create v2025.11.3 --generate-notes --draft)

สำหรับบอท:

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