Scout Monitoring MCP

Scout Monitoring MCP

Kho lưu trữ này chứa mã để chạy cục bộ một máy chủ MCP có thể truy cập dữ liệu Scout Monitoring thông qua API của Scout. Chúng tôi cung cấp một image Docker có thể được tải về và chạy bởi Trợ lý AI của bạn để truy cập dữ liệu Scout Monitoring.

Điều này đặt dữ liệu hiệu suất và lỗi của Scout Monitoring trực tiếp vào tay Trợ lý AI của bạn. Dành cho Rails, Django, FastAPI, Laravel và nhiều hơn nữa. Sử dụng nó để lấy traces và lỗi với thông tin dòng mã mà AI có thể sử dụng để nhắm mục tiêu sửa lỗi ngay trong trình soạn thảo và cơ sở mã của bạn. Truy vấn N+1, endpoint chậm, truy vấn chậm, phình bộ nhớ, vấn đề thông lượng - tất cả các vấn đề hiệu suất yêu thích của bạn được hiển thị và giải thích ngay tại nơi bạn đang làm việc.

Nếu điều này làm cho cuộc sống của bạn tốt hơn một chút, tại sao không :star: nó?!

Trình hướng dẫn thiết lập

Cách đơn giản nhất để cấu hình và bắt đầu sử dụng Scout MCP là với trình hướng dẫn thiết lập tương tác của chúng tôi. Nó xử lý tất cả các điều kiện tiên quyết và các bước cài đặt cho bạn.

Chạy qua npx:

npx @scout_apm/wizard

Xây dựng và chạy từ mã nguồn:

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

Trình hướng dẫn sẽ hướng dẫn bạn qua:

• Chọn nền tảng lập trình AI của bạn (Cursor, Claude Code, Claude Desktop)
• Nhập khóa API Scout của bạn
• Tự động cấu hình cài đặt máy chủ MCP

Nền tảng được hỗ trợ

Trình hướng dẫn hiện hỗ trợ thiết lập cho:

• Cursor - Tự động cấu hình cài đặt MCP
• Claude Code (CLI) - Cung cấp lệnh chính xác để chạy
• Claude Desktop - Cập nhật tệp cấu hình cho Windows/Mac

Đối với tất cả các nền tảng khác, nó sẽ xuất ra JSON mà bạn có thể sao chép/dán vào cấu hình MCP của Trợ lý AI.

Điều kiện tiên quyết

Trình hướng dẫn là một cách tuyệt vời để bắt đầu, nhưng bạn cũng có thể thiết lập mọi thứ thủ công. Bạn sẽ cần có hoặc tạo một tài khoản Scout Monitoring và lấy khóa API.

1. Đăng ký
2. Cài đặt Scout Agent trong ứng dụng của bạn và gửi dữ liệu Scout!
   • Ruby
   • Python
   • PHP
   • Nếu bạn đang thử nghiệm cục bộ, hãy đảm bảo monitor: true, errors_enabled: true được đặt trong cấu hình của bạn để có trải nghiệm tốt nhất
3. Truy cập cài đặt để lấy hoặc tạo khóa API
   • Đây không phải là "Khóa Agent" của bạn; đó là "Khóa API" có thể được tạo trên trang Cài đặt
   • Đây là khóa chỉ đọc chỉ có thể truy cập dữ liệu trong tài khoản của bạn
4. Cài đặt Docker. Các hướng dẫn bên dưới giả định bạn có thể khởi động một container Docker

Máy chủ MCP hiện sẽ không khởi động nếu không có khóa API được đặt, trong môi trường hoặc bằng đối số dòng lệnh khi khởi động.

Cài đặt

Chúng tôi khuyên bạn nên sử dụng image Docker được cung cấp để chạy máy chủ MCP. Nó được dự định để được khởi động bởi Trợ lý AI của bạn và được cấu hình với khóa API Scout của bạn. Nhiều máy khách cục bộ cho phép chỉ định một lệnh để chạy máy chủ MCP ở một số vị trí. Một vài ví dụ được cung cấp bên dưới.

Image Docker có sẵn trên Docker Hub.

Tất nhiên, bạn luôn có thể sao chép kho lưu trữ này và chạy máy chủ MCP trực tiếp; uv hoặc các công cụ quản lý môi trường khác được khuyến nghị.

Cấu hình Máy khách cục bộ (ví dụ: Claude/Cursor/VS Code Copilot)

Nếu bạn muốn cấu hình MCP thủ công, điều này thường chỉ có nghĩa là cung cấp một lệnh để chạy máy chủ MCP với khóa API của bạn trong môi trường cho cấu hình của Trợ lý AI. Đây là hình dạng của JSON (khóa cấp cao nhất thay đổi):

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

Sử dụng Scout Monitoring MCP

MCP của Scout được dự định để đặt dữ liệu lỗi và hiệu suất trực tiếp vào... tay? của Trợ lý AI của bạn. Sử dụng nó để lấy traces và lỗi với thông tin dòng mã mà AI có thể sử dụng để nhắm mục tiêu sửa lỗi ngay trong trình soạn thảo của bạn.

Hầu hết các trợ lý sẽ hiển thị cho bạn cả các lệnh gọi công cụ thô và thực hiện phân tích. Trợ lý máy tính để bàn có thể dễ dàng tạo các ứng dụng JS tùy chỉnh để khám phá bất kỳ dữ liệu nào bạn muốn. Trợ lý được tích hợp vào trình soạn thảo mã có thể sử dụng dữ liệu trace và backtrace lỗi để thực hiện sửa lỗi ngay trong cơ sở mã của bạn.

Kết hợp MCP của Scout với các công cụ khác của Trợ lý AI để:

• Tạo các vấn đề GitHub/GitLab phong phú dựa trên lỗi và dữ liệu hiệu suất
• Làm cho JIRA thú vị - để Trợ lý AI của bạn tạo vé với tất cả các chi tiết
• Tạo PR sửa các lỗi và vấn đề hiệu suất cụ thể

Công cụ

Scout MCP cung cấp các công cụ sau để truy cập dữ liệu Scout APM:

• list_apps - Liệt kê các ứng dụng Scout APM có sẵn, với bộ lọc tùy chọn theo ngày hoạt động cuối cùng
• get_app_metrics - Lấy dữ liệu metric riêng lẻ (response_time, throughput, v.v.) cho một ứng dụng cụ thể
• get_app_endpoints - Lấy tất cả các endpoint cho một ứng dụng với các metric hiệu suất tổng hợp
• get_endpoint_metrics - Lấy metric chuỗi thời gian cho một endpoint cụ thể trong một ứng dụng
• get_app_endpoint_traces - Lấy các trace gần đây cho một ứng dụng được lọc theo một endpoint cụ thể
• get_app_trace - Lấy một trace riêng lẻ với tất cả các span và thông tin thực thi chi tiết
• get_app_error_groups - Lấy các nhóm lỗi gần đây cho một ứng dụng, tùy chọn lọc theo endpoint
• get_app_insights - Lấy thông tin chi tiết về hiệu suất bao gồm truy vấn N+1, phình bộ nhớ và truy vấn chậm

Tài nguyên

Scout MCP cung cấp các mẫu cấu hình dưới dạng tài nguyên mà trợ lý AI của bạn có thể đọc và áp dụng:

• scoutapm://config-resources/{framework} - Hướng dẫn thiết lập cho framework hoặc thư viện được hỗ trợ (rails, django, flask, fastapi)
• scoutapm://config-resources/list - Liệt kê tất cả các mẫu cấu hình có sẵn
• scoutapm://metrics - Danh sách tất cả các metric có sẵn cho Scout APM

Lời nhắc hữu ích

Thiết lập & Cấu hình

• "Giúp tôi thiết lập Scout monitoring cho ứng dụng Rails của tôi"
• "Tạo tệp cấu hình Scout APM cho dự án Django của tôi với khóa ABC123"

Hiệu suất & Giám sát

• "Tóm tắt các công cụ có sẵn trong Scout Monitoring MCP."
• "Tìm các endpoint chậm nhất cho ứng dụng my-app-name trong 7 ngày qua. Tạo một bảng với kết quả bao gồm thời gian phản hồi trung bình, thông lượng và thời gian phản hồi P95."
• "Hiển thị cho tôi các lỗi tần suất cao nhất cho ứng dụng Foo trong 24 giờ qua. Lấy chi tiết lỗi mới nhất, kiểm tra backtrace và đề xuất cách sửa."
• "Lấy bất kỳ thông tin chi tiết n+1 gần đây nào cho ứng dụng Bar. Lấy trace cụ thể theo id và giúp tôi tối ưu hóa nó dựa trên dữ liệu backtrace."

Sử dụng Token

Chúng tôi hiện quan tâm nhiều hơn đến việc mở rộng thông tin có sẵn hơn là kiểm soát chặt chẽ kích thước phản hồi từ các công cụ MCP của chúng tôi. Nếu Trợ lý AI của bạn có giới hạn token có thể cấu hình (ví dụ: Claude Code export MAX_MCP_OUTPUT_TOKENS=50000), chúng tôi khuyên bạn nên đặt nó cao một cách hào phóng, ví dụ: 50.000 token.

Phát triển cục bộ

Chúng tôi sử dụng uv và taskipy để quản lý môi trường và chạy các tác vụ cho dự án này.

Chạy với Inspector

uv run task dev

Kết nối trong inspector để thêm khóa API, đặt thành vận chuyển STDIO

Xây dựng image Docker

docker build -t scout-mcp-local .

Phát hành

1. Phân nhánh và tăng phiên bản với uv run python bump_versions.py
2. Hợp nhất nó
3. Tạo một bản phát hành GitHub với phiên bản mới (gh release create v2025.11.3 --generate-notes --draft)

Dành cho bot:

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