owasp_cheatsheets_mcp_server

OWASP チートシートを提供する最小限のモデル コンテキスト プロトコル (MCP) 互換サーバー。

サーバーはFastAPIを使用して、 OWASP チートシート シリーズからチートシートの内容を返すシンプルな HTTP API を公開します。

前提条件

• Python 3.8以降

• Git (初回実行時にチートシートリポジトリをクローンするため)

Related MCP server: vuln-nist-mcp-server

使用法

1. インストール要件:

   pip install -r requirements.txt

2. *(オプション)*チートシートのローカルコピーがすでにある場合は、 CHEATSHEETS_DIR設定します。

   export CHEATSHEETS_DIR=/path/to/CheatSheetSeries/cheatsheets

3. uvicornでサーバーを実行します。

   uvicorn server.app:app --reload

4. CHEATSHEETS_DIRが設定されていない場合、サーバーは最初の起動時にチートシート リポジトリのクローンを作成します (ネットワーク アクセスが必要です)。

エンドポイント

• GET /health – 基本的なヘルスチェック。

• GET /cheatsheets – 利用可能なチートシート ファイルを一覧表示します。

• GET /cheatsheets/{name} – 特定のチートシートを取得します。

• GET /search?q=term – チートシートで用語を検索し、一致するファイル名を返します。

本番環境で実行中

デプロイ時に明示的なホストとポートを指定してuvicorn使用します。

uvicorn server.app:app --host 0.0.0.0 --port 8000

実際の展開では、 systemdなどのプロセス マネージャーやリバース プロキシの背後での実行を検討してください。

貢献

プルリクエストは歓迎します。pytestを使用して、 tests/ディレクトリ以下にテストを追加できます。

この実装は MCP サーバーの簡略化された例であり、仕様全体を網羅しているわけではありません。