Scout MCP Local

🚀 Scout Monitoring MCP

このリポジトリには、ScoutのAPIを介してScout MonitoringのデータにアクセスできるMCPサーバーをローカルで実行するためのコードが含まれています。AIアシスタントがScout Monitoringのデータにアクセスするために、Dockerイメージを提供しています。

これにより、Scout Monitoringのパフォーマンスとエラーデータを直接AIアシスタントが利用できるようになります。Rails、Django、FastAPI、Laravelなどの様々なフレームワークで使用できます。コード行情報付きのトレースとエラーを取得し、AIがエディタやコードベース内で直接修正を行うことができます。N+1クエリ、低速エンドポイント、低速クエリ、メモリ膨張、スループットの問題など、あらゆるパフォーマンス問題を作業中の場所で可視化し、説明します。

もしこれがあなたの生活を少しでも良くするなら、⭐をつけてみませんか？

🚀 クイックスタート

前提条件

Scout Monitoringのアカウントを持っているか、作成する必要があり、APIキーを取得する必要があります。

1. サインアップ
2. アプリケーションにScoutエージェントをインストールし、Scoutデータを送信します。
   • Ruby
   • Python
   • PHP
   • ローカルで試す場合は、設定でmonitor: trueとerrors_enabled: trueを設定すると、最適な体験が得られます。
3. 設定にアクセスして、APIキーを取得または作成します。
   • これは「エージェントキー」ではなく、設定ページで作成できる「APIキー」です。
   • これはアカウント内のデータにのみアクセスできる読み取り専用のキーです。
4. Dockerをインストールします。以下の説明では、Dockerコンテナを起動できることを前提としています。

現在、環境変数または起動時のコマンドライン引数でAPIキーが設定されていないと、MCPサーバーは起動しません。

インストール

MCPサーバーを実行するには、提供されているDockerイメージの使用をおすすめします。これは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で利用可能なツールを要約してください。"
• "過去7日間でアプリ my-app-name の最も低速なエンドポイントを見つけてください。平均応答時間、スループット、P95応答時間を含む結果の表を生成してください。"
• "過去24時間でアプリ Foo の最も頻度の高いエラーを表示してください。最新のエラー詳細を取得し、バックトレースを調べて修正案を提案してください。"
• "アプリ Bar の最近のN+1インサイトを取得してください。IDで特定のトレースを取得し、バックトレースデータに基づいて最適化を支援してください。"

🔧 技術詳細

ローカル開発

このプロジェクトでは、環境の管理とタスクの実行にuvとtaskipyを使用しています。

インスペクターで実行

uv run task dev

インスペクター内で接続して、APIキーを追加し、STDIOトランスポートに設定します。

Dockerイメージのビルド

docker build -t scout-mcp-local .