Pfsense MCP Server

🚀 pfSense MCP Server

このサーバーは、Claude Desktopや他のGenAIアプリケーションを通じて、pfSenseファイアウォールとの自然言語対話を可能にする、本番環境向けのModel Context Protocol (MCP) サーバーです。

🚀 クイックスタート

1. インストールと設定

# リポジトリをクローンする
git clone https://github.com/gensecaihq/pfsense-mcp-server.git
cd pfsense-mcp-server

# 環境テンプレートをコピーする
cp .env.example .env

# 設定を編集する
nano .env  # pfSenseの詳細を追加する

2. Dockerで実行

# ビルドして起動する
docker-compose up -d

# ヘルスチェックを行う
curl http://localhost:8000/health

3. Claude Desktopの設定

Claude Desktopの設定ファイル（macOSでは ~/Library/Application Support/Claude/claude_desktop_config.json）に追加します。

Dockerを使用する場合:

{
  "mcpServers": {
    "pfsense": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file", "/path/to/.env", "pfsense-mcp:latest"],
      "env": {
        "MCP_MODE": "stdio"
      }
    }
  }
}

ローカルで実行する場合:

{
  "mcpServers": {
    "pfsense": {
      "command": "python",
      "args": ["/path/to/pfsense-mcp-server/main.py"],
      "env": {
        "PFSENSE_URL": "https://your-pfsense.local",
        "PFSENSE_API_KEY": "your-api-key"
      }
    }
  }
}

✨ 主な機能

• 自然言語インターフェース：平易な英語を使ってpfSenseを制御できます。
• 5つのアクセスレベル：読み取り専用の監視から緊急対応まで、幅広いアクセスレベルを提供します。
• 複数の接続方法：REST API、XML-RPC、SSHをサポートしています。
• 6つの機能カテゴリ：包括的なセキュリティ操作をカバーしています。
• GenAI統合：Claude Desktop、Continue、その他のMCPクライアントと連携可能です。
• 本番環境対応：監査ログ、レート制限、キャッシュ機能を備えています。

🔐 アクセスレベル

💬 使用例

"システムの状態を表示して"
"現在ブロックされているIPを教えて"
"IP 192.168.1.100をブロックして"
"PCIコンプライアンスチェックを実行して"
"過去1時間の脅威を分析して"
"緊急: ロシアからのすべてのトラフィックをブロックして"

📚 ドキュメント

• Claude Desktopのセットアップ
• GenAI統合ガイド
• APIドキュメント
• デプロイメントガイド
• パーミッションガイド

🧪 テスト

# 接続テストを行う
python scripts/test_connection.py

# テストを実行する
pytest tests/

# トークンを生成する
python scripts/generate_token.py alice READ_ONLY

📄 ライセンス

MITライセンス - 詳細は LICENSE を参照してください。