Scout MCP Local

🚀 Scout Monitoring MCP

Scout Monitoring MCP 倉庫包含了可在本地運行 MCP 服務器的代碼，該服務器能夠通過 Scout 的 API 訪問 Scout Monitoring 的數據。我們提供了一個 Docker 鏡像，你的 AI 助手可以拉取並運行該鏡像來訪問 Scout Monitoring 的數據。

這使得 Scout Monitoring 的性能和錯誤數據能直接交由你的 AI 助手處理。它支持 Rails、Django、FastAPI、Laravel 等多種框架。藉助它，你可以獲取帶有代碼行信息的跟蹤和錯誤數據，AI 能夠利用這些信息直接在你的編輯器和代碼庫中定位並修復問題。N+1 查詢、慢速端點、慢速查詢、內存膨脹、吞吐量問題——所有你關注的性能問題都能在你工作的地方被發現和解釋。

如果這能讓你的生活變得更好一點，為何不給它點個 :star: 呢？！

🚀 快速開始

前提條件

你需要擁有或創建一個 Scout Monitoring 賬戶，並獲取一個 API 密鑰。

1. 註冊
2. 在你的應用程序中安裝 Scout 代理併發送 Scout 數據！
   • Ruby
   • Python
   • PHP
   • 如果你在本地嘗試，確保在你的配置中設置 monitor: true 和 errors_enabled: true，以獲得最佳體驗
3. 訪問 設置 頁面獲取或創建一個 API 密鑰
   • 這 不是 你的“代理密鑰”，而是可以在設置頁面創建的“API 密鑰”
   • 這是一個只讀密鑰，只能訪問你賬戶中的數據
4. 安裝 Docker。以下說明假設你可以啟動一個 Docker 容器

⚠️ 重要提示

如果未在環境中或在啟動時通過命令行參數設置 API 密鑰，MCP 服務器目前將無法啟動。

安裝

我們建議使用提供的 Docker 鏡像來運行 MCP 服務器。該鏡像旨在由你的 AI 助手啟動，並使用你的 Scout API 密鑰進行配置。許多本地客戶端允許在某個位置指定運行 MCP 服務器的命令。以下是一些示例。

Docker 鏡像可在 Docker Hub 上獲取。

當然，你也可以始終克隆此倉庫並直接運行 MCP 服務器；建議使用 uv 或其他環境管理工具。

設置嚮導

配置並開始使用 Scout MCP 的最簡單方法是使用我們的交互式設置嚮導：

通過 npx 運行：

npx @scout_apm/wizard

從源代碼構建並運行：

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

嚮導將引導你完成以下步驟：

• 選擇你的 AI 編碼平臺（Cursor、Claude Code、Claude Desktop）
• 輸入你的 Scout API 密鑰
• 自動配置 MCP 服務器設置

支持的平臺

嚮導目前支持以下平臺的設置：

• Cursor - 自動配置 MCP 設置
• Claude Code (CLI) - 提供正確的運行命令
• Claude Desktop - 更新 Windows/Mac 的配置文件

配置本地客戶端（例如 Claude/Cursor/VS Code Copilot）

如果你想手動配置 MCP，通常只需在環境中提供一個帶有你的 API 密鑰的命令來運行 MCP 服務器，並將其提供給你的 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"}
    }
  }
}

令牌使用

目前，我們更關注擴展可用信息，而不是嚴格控制 MCP 工具的響應大小。如果你的 AI 助手有可配置的令牌限制（例如 Claude Code export MAX_MCP_OUTPUT_TOKENS=50000），我們建議將其設置得足夠高，例如 50,000 個令牌。

使用方法

Scout 的 MCP 旨在將錯誤和性能數據直接交由你的 AI 助手處理。藉助它，你可以獲取帶有代碼行信息的跟蹤和錯誤數據，AI 能夠利用這些信息直接在你的編輯器中定位並修復問題。

大多數助手會向你展示原始工具調用並進行分析。桌面助手可以輕鬆創建自定義 JS 應用程序，以探索你所需的任何數據。集成到代碼編輯器中的助手可以使用跟蹤數據和錯誤回溯信息直接在你的代碼庫中進行修復。

將 Scout 的 MCP 與你的 AI 助手的其他工具結合使用，以實現以下功能：

• 根據錯誤和性能數據創建豐富的 GitHub/GitLab 問題
• 讓 JIRA 變得有趣——讓你的 AI 助手創建包含所有詳細信息的工單
• 生成修復特定錯誤和性能問題的 PR

工具

Scout MCP 提供了以下用於訪問 Scout APM 數據的工具：

• list_apps - 列出可用的 Scout APM 應用程序，可根據最後活動日期進行可選過濾
• get_app_metrics - 獲取特定應用程序的單個指標數據（響應時間、吞吐量等）
• get_app_endpoints - 獲取應用程序的所有端點及其聚合性能指標
• get_endpoint_metrics - 獲取應用程序中特定端點的時間序列指標
• get_app_endpoint_traces - 獲取應用程序中特定端點的近期跟蹤信息
• get_app_trace - 獲取包含所有跨度和詳細執行信息的單個跟蹤
• get_app_error_groups - 獲取應用程序的近期錯誤組，可根據端點進行可選過濾
• get_app_insights - 獲取性能洞察，包括 N+1 查詢、內存膨脹和慢速查詢

有用的提示

• "總結 Scout Monitoring MCP 中的可用工具。"
• "查找應用程序 my-app-name 在過去 7 天內最慢的端點。生成一個包含平均響應時間、吞吐量和 P95 響應時間的結果表。"
• "顯示應用程序 Foo 在過去 24 小時內出現頻率最高的錯誤。獲取最新的錯誤詳細信息，檢查回溯信息並建議修復方案。"
• "獲取應用程序 Bar 的任何近期 N+1 洞察。通過 ID 提取特定跟蹤，並根據回溯數據幫助我對其進行優化。"

本地開發

我們使用 uv 和 taskipy 來管理此項目的環境和運行任務。

使用檢查器運行

uv run task dev

在檢查器中連接以添加 API 密鑰，並設置為 STDIO 傳輸

構建 Docker 鏡像

docker build -t scout-mcp-local .