prowler-mcp

概要

Prowler MCP サーバーでは、プレフィックス付きの名前空間を使用する 3 つのサブサーバーを利用します。

サブサーバー	プレフィックス	認証	目的
Prowler	prowler_*	必須	Prowler Cloud、Private Cloud、ローカルサーバーの管理ツール
Prowler Hub	prowler_hub_*	不要	セキュリティチェックのカタログ
Prowler Docs	prowler_docs_*	不要	ドキュメント検索

アーキテクチャ、パターン、例について詳しくは、docs/developer-guide/mcp-server.mdx をご覧ください。

---

重要なルール（Prowler ツールのみ）

ツールの実装

• 必ず：BaseTool を継承します（tool_loader.py 経由で自動登録され、クラスのパブリックメソッドのみがツールとして公開されます）
• 禁止：BaseTool のサブクラスを手動で登録すること
• 禁止：server.py でツールを直接インポートすること

モデル

• 必ず：レスポンスには MinimalSerializerMixin を使用します
• 必ず：from_api_response() ファクトリーメソッドを実装します
• 必ず：2 段階のモデル（リスト用の簡易モデル、単一項目用の詳細モデル）を使用します
• 禁止：未加工の API レスポンスを返すこと

API クライアント

• 必ず：self.api_client シングルトンを使用します
• 必ず：クエリパラメーターには build_filter_params() を使用します
• 禁止：新しい httpx クライアントを作成すること

---

Hub／Docs ツール

@mcp.tool() デコレーターを直接使用します。BaseTool やモデルは不要です。

---

クイックリファレンス：新しい Prowler ツール

1. prowler_app/tools/ に BaseTool を継承するツールクラスを作成します
2. prowler_app/models/ に MinimalSerializerMixin を使用したモデルを作成します
3. ツールは tool_loader.py 経由で自動登録されます

---

QA チェックリスト（Prowler ツール）

• ツールの docstring で LLM に関連する動作を説明している
• モデルが MinimalSerializerMixin を使用している
• API レスポンスが簡易モデルに変換されている
• 失敗は必ず送出し、返してはいけません。エラー辞書を返すと成功として報告されます。不正な引数には InvalidArgument を送出し、ProwlerAPIError／ProwlerAPIUnreachable はそのまま伝播させます。また、lib/errors.py では判断できない情報（リソース名、前提条件、次に呼び出すツール）を含む文に限り、from 節なしで ToolError を送出します
• パラメーターに説明付きの Field() を使用している
• ハードコードされたシークレットがない
• mcp_server/tests/ にテストを追加している

---

リソース

• 完全ガイド：docs/developer-guide/mcp-server.mdx
• テンプレート：ツールとモデルのテンプレートについては、assets/ をご覧ください
• テスト：フィクスチャとテストパターンについては、prowler-test-mcp をご覧ください