Scout Monitoring MCP Server

Scout Monitoring MCP

此儲存庫包含可在本機執行 MCP 伺服器的程式碼，該伺服器可透過 Scout 的 API 存取 Scout Monitoring 資料。我們提供一個 Docker 映像檔，可供您的 AI 助理拉取並執行，以存取 Scout Monitoring 資料。

這能將 Scout Monitoring 的效能與錯誤資料直接交到您的 AI 助理手中。 適用於 Rails、Django、FastAPI、Laravel 等框架。使用它來取得包含程式碼行資訊的追蹤記錄與錯誤，讓 AI 能夠直接在您的編輯器與程式碼庫中針對性地進行修復。N+1 查詢、緩慢的端點、緩慢的查詢、記憶體膨脹、吞吐量問題——所有您喜愛的效能問題，都會在您工作的當下浮現並獲得解釋。

如果這能讓您的生活稍微輕鬆一點，何不給它一顆 :star: 呢？！

設定精靈

開始使用 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 的設定檔

對於所有其他平台，它將輸出 JSON，您可以將其複製並貼到 AI 助理的 MCP 組態中。

前置需求

精靈是入門的好方法，但您也可以手動進行設定。 您需要擁有或建立一個 Scout Monitoring 帳戶，並取得 API 金鑰。

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. 前往設定以取得或建立 API 金鑰
   • 這不是您的「Agent Key」；而是可以在「設定」頁面上建立的「API Key」
   • 這是一個唯讀金鑰，只能存取您帳戶中的資料
4. 安裝 Docker。以下說明假設您可以啟動 Docker 容器

目前，若未在環境變數中或透過啟動命令列引數設定 API 金鑰，MCP 伺服器將無法啟動。

安裝

我們建議使用提供的 Docker 映像檔來執行 MCP 伺服器。 它旨在由您的 AI 助理啟動，並使用您的 Scout API 金鑰進行設定。許多本機客戶端允許指定在某個位置執行 MCP 伺服器的命令。以下提供幾個範例。

Docker 映像檔可在 Docker Hub 上取得。

當然，您隨時可以複製此儲存庫並直接執行 MCP 伺服器；建議使用 uv 或其他環境管理工具。

設定本機客戶端（例如 Claude/Cursor/VS Code Copilot）

如果您想手動設定 MCP，通常只需在 AI 助理的組態中，提供一個在環境中包含您的 API 金鑰來執行 MCP 伺服器的命令。以下是 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

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 MCP 提供設定範本作為資源，供您的 AI 助理讀取並套用：

• scoutapm://config-resources/{framework} - 支援的框架或函式庫（rails、django、flask、fastapi）的設定說明
• scoutapm://config-resources/list - 列出所有可用的設定範本
• scoutapm://metrics - Scout APM 所有可用指標的清單

實用提示

設定與組態

• 「協助我為我的 Rails 應用程式設定 Scout 監控」
• 「為我的 Django 專案建立一個 Scout APM 設定檔，金鑰為 ABC123」

效能與監控

• 「摘要說明 Scout Monitoring MCP 中可用的工具。」
• 「找出應用程式 my-app-name 在過去 7 天內最慢的端點。產生一個包含平均回應時間、吞吐量和 P95 回應時間的表格。」
• 「顯示應用程式 Foo 在過去 24 小時內最高頻率的錯誤。取得最新的錯誤詳細資料，檢查回溯並建議修復方案。」
• 「取得應用程式 Bar 的任何近期 N+1 洞察。依 ID 提取特定的追蹤記錄，並根據回溯資料協助我進行最佳化。」

Token 使用量

我們目前更專注於擴展可用的資訊，而非嚴格控制 MCP 工具的回應大小。如果您的 AI 助理具有可設定的 token 限制（例如 Claude Code export MAX_MCP_OUTPUT_TOKENS=50000），我們建議將其設定得較高，例如 50,000 個 token。

本機開發

我們使用 uv 和 taskipy 來管理此專案的環境並執行任務。

使用 Inspector 執行

uv run task dev

在 Inspector 內連線以新增 API 金鑰，設定為 STDIO 傳輸

建置 Docker 映像檔

docker build -t scout-mcp-local .

發佈

1. 使用 uv run python bump_versions.py 建立分支並提升版本號
2. 合併該分支
3. 建立包含新版本號的 GitHub 發佈版本 (gh release create v2025.11.3 --generate-notes --draft)

給機器人的資訊：

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