Shieldmcp

🚀 MCP安全シールド

MCP（Model Context Protocol）サーバーのセキュリティと監視機能を強化するミドルウェアです。公式SDKを変更する必要はありません。このパッケージは、MCPツールの呼び出しを保護および監視するためのツールを提供し、MCPドキュメントに記載されているベストプラクティスに準拠しています。自身を明かすことなくMCP開発と相互作用します。

🚀 クイックスタート

Shield MCPを使用するには、まずライブラリをインストールする必要があります。

pip install shieldmcp

次に、以下の手順で設定および使用します。

1. ShieldMCPインスタンスを初期化します。

   from shieldmcp import ShieldMCP
   
   shield = ShieldMCP()
   

2. アクセス制御を設定します。

   shield.set_allowed_tools(["tool1", "tool2"])
   

3. 結果のクリーニング機能を有効にします。

   shield.enable_output_cleaning(patterns=[r"\b信用卡号\b"], max_length=500)
   

4. ShieldMCPを使用してリクエストを処理します。

   response = shield.process_request(request_data)
   

✨ 主な機能

• ツールアクセス制御：ホワイトリストベースのMCPツールアクセス制御
• 結果クリーニング：設定可能な結果出力クリーニング機能
• 構造化ログ記録：structlogを使用した包括的な監査ログ記録
• レート制限：トークンバケットアルゴリズムによるレート制限
• エラー処理：標準化されたエラー処理とフォーマット
• MCPインスペクター互換：MCPインスペクターツールとシームレスに連携

📦 インストール

from shieldmcp import ShieldMCP

📚 ドキュメント

必要条件

システム要件

• Python 3.8 以上
• pip（Pythonパッケージインストーラー）
• virtualenv（開発時に推奨）

コンポーネント

デコレータ (decorators.py)

MCPエンドポイントを保護するためのデコレータを提供します。

from shieldmcp.decorators import shield_mcp_endpoint

@shield_mcp_endpoint
def protected_endpoint(data):
    # リクエストを処理する
    return response

ログ記録 (logging.py)

構造化ログ記録をアプリケーションに統合します。

from shieldmcp.logging import setup_logging

setup_logging("info")
logger.info("処理開始")

ベストプラクティス

ツールアクセス制御

• 常に許可されるツールのホワイトリストを定義します。
• 定期的にホワイトリストをレビューして更新します。

結果クリーニング

• すべてのテキスト出力をクリーニングします。
• 機密データのパターンを定義します。
• 適切な長さ制限を設定します。

ログ記録

• 利用可能な場合は、ユーザーとセッションIDを含めます。
• 成功と失敗の操作を記録します。
• より良い分析のために構造化ログを使用します。

レート制限

• ツールの複雑さに応じて適切な制限を設定します。
• ユーザー体験を向上させるために突発的なアクセス量を考慮します。
• レート制限のトリガー状況を監視します。

開発

開発環境のセットアップ

# リポジトリをクローンする
git clone https://github.com/shieldmcp/shieldmcp.git
cd shieldmcp

# 仮想環境を作成する
python -m venv venv
source venv/bin/activate  # またはWindowsでは `venv\Scripts\activate`

# 開発依存パッケージをインストールする
pip install -r requirements.txt

テストの実行

pytest tests/

ロードマップ

予定機能

• Clerk MCPとGithub MCPのサポート
• ドキュメントの拡充
• TypeScriptサポート

謝辞

• Model Context Protocol がプロトコル仕様を提供しました。
• structlog を構造化ログ記録に使用しています。

ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細については、LICENSE ファイルを参照してください。