Netbrain MCP

🚀 NetBrain MCP

NetBrain MCPは、オープンソースのネットワーク運用統合プラットフォームです。Model Context Protocol (MCP) を介して、大規模言語モデル（LLM）とネットワーク機器を接続します。これにより、AIアシスタントが標準化されたプロトコルを通じて、ネットワークの設定、診断、管理タスクを実行できます。

🎉 プロジェクトの状態：すべての計画機能が完了し、本番環境へのデプロイが可能です。

🚀 クイックスタート

NetBrain MCPを使用するには、以下の手順に従ってください。

🔧 MCPサーバーモード

Pythonを直接使用して実行する場合

python server.py

MCP開発ツールを使用して実行する場合

mcp run server.py

デバッグ界面付きで実行する場合 (MCP Inspector)

mcp dev server.py

🚀 本番環境へのデプロイ

# 依存関係をインストールする
pip install -r requirements.txt

# サーバーを起動する
python server.py

✨ 主な機能

🔧 核心機能

• ネットワーク機器管理 - シスコ、華為など、様々なメーカーのネットワーク機器を統一的に管理します。
• 機器接続 - SSHとTelnetプロトコルをサポートし、ネットワーク機器に接続します。
• コマンド実行 - リモートでネットワークコマンドを実行し、結果を取得します。
• 認証情報管理 - 機器へのアクセス認証情報を安全に管理します。
• MCPプロトコルサポート - 大規模言語モデルがネットワーク機器にアクセスし、制御できるようにします。
• リソース提供機能 - URIを通じて、機器、設定などのリソースをLLMに提供します。
• プロンプトテンプレートシステム - ネットワーク診断、設定レビューなどの専用プロンプトテンプレートを提供します。

🌐 Web界面機能

• 専用のターミナル体験 - XTerm.jsをベースとしたマルチタブターミナルで、コマンド補完と履歴機能をサポートします。
• ネットワークトポロジ可視化 - D3.jsをベースとしたインタラクティブなトポロジ図で、CDP/LLDP自動発見をサポートします。
• 機器管理界面 - 直感的な機器の追加、編集、状態監視界面です。
• セッション管理 - 複数の機器接続セッションを管理し、再接続とハートビート検出をサポートします。
• テーマシステム - 完全なダーク/ブライトテーマ切り替え機能があり、ログインページも含まれます。
• レスポンシブデザイン - デバイスを問わず互換性のある現代的なユーザーインターフェイスです。

🚀 高度な機能

• 自動トポロジ発見 - CDP/LLDPプロトコルに基づくネットワークトポロジの自動識別機能です。
• スマート機器識別 - メーカーのMACアドレス識別機能が組み込まれており、機器の種類を自動的に推測します。
• データの永続化 - JSONファイルによるデータストレージシステムで、データのバックアップと復元をサポートします。
• 多メーカーサポート - シスコ、華為、H3Cなどの主要メーカーの機器に対応しています。
• コマンドテンプレートライブラリ - メーカー固有のコマンドテンプレートと設定フラグメントが事前に用意されています。
• ネットワークスキャン - ネットワーク範囲のスキャンと機器の自動発見をサポートします。

📦 インストール

本番環境へのデプロイには、以下の手順で依存関係をインストールし、サーバーを起動します。

# 依存関係をインストールする
pip install -r requirements.txt

# サーバーを起動する
python server.py

💻 使用例

🌐 Web界面の使用

1. サーバーを起動する

   python server.py
   

2. Web界面にアクセスする

   • ブラウザを開き、http://localhost:8088 にアクセスします。
   • ログインページからシステムに入ります。

3. ターミナル機能を使用する

   • "ターミナル" タブをクリックします。
   • 新しい機器を追加するか、既存の機器を選択します。
   • SSH/Telnet接続を確立します。
   • 専用のターミナル体験（コマンド補完、履歴など）を楽しみます。

4. ネットワークトポロジを表示する

   • "ネットワークトポロジ" タブをクリックします。
   • "トポロジを発見" をクリックして自動スキャンを開始します。
   • 可視化されたネットワークトポロジ図を表示します。
   • ノードをダブルクリックすると、機器にすぐに接続できます。

5. 機器を管理する

   • "機器" ページで機器情報を追加、編集します。
   • 機器の認証情報と接続パラメータを設定します。
   • 機器のオンライン状態を監視します。

🔧 MCPプロトコルの使用

以下の手順で機能をテストできます。

1. MCPサーバーを起動します。
2. MCP Inspectorを使用して利用可能なツールを確認します。
3. list_devices ツールを使用して、事前に設定された機器を一覧表示します。
4. 機器IDと認証情報IDを使用して機器に接続します。
5. コマンドを送信し、シミュレートされた出力を表示します。

📊 リソースアクセスの例

機器情報を取得する:

GET device/1

機器設定を取得する:

GET device/1/config

トポロジデータを取得する:

GET topology

プロンプトテンプレートを使用する:

POST render_template
{
  "template_name": "device_diagnosis",
  "context": {
    "device_info": "...",
    "interfaces_info": "..."
  }
}

🚀 高度な機能の例

自動トポロジ発見:

# MCPツールを介して呼び出す
discover_topology({
  "device_ids": "device1,device2"
})

ネットワークスキャン:

# ネットワーク範囲をスキャンする
scan_network_range({
  "network": "192.168.1.0/24",
  "timeout": 3.0,
  "auto_create_devices": true
})

一括機器設定:

# コマンドテンプレートを使用する
send_commands({
  "device_id": "cisco_router_1", 
  "credential_id": "admin_cred",
  "commands": "interface gi0/1;ip address 192.168.10.1 255.255.255.0;no shutdown"
})

📚 ドキュメント

利用可能なツール

NetBrain MCPは、以下のネットワーク管理ツールを提供します。

機器管理ツール

• list_devices - ネットワーク機器を一覧表示し、メーカー、種類、状態、ラベルでのフィルタリングをサポートします。
• add_device - 新しいネットワーク機器を追加します。
• get_device - 機器の詳細情報を取得します。
• update_device - 機器情報を更新します。
• delete_device - 機器を削除します。

認証情報管理ツール

• add_credential - 機器へのアクセス認証情報を追加します。
• list_credentials - すべての機器認証情報を一覧表示します。

機器接続ツール

• connect_device - ネットワーク機器に接続します。
• disconnect_device - ネットワーク機器との接続を切断します。
• send_command - ネットワーク機器にコマンドを送信します。
• send_commands - ネットワーク機器に複数のコマンドを送信します。
• get_active_connections - 現在アクティブな機器接続を取得します。

トポロジ発見ツール

• discover_topology - CDP/LLDPプロトコルに基づいてネットワークトポロジを自動的に発見します。
• get_topology - 発見されたトポロジデータを取得します。
• clear_topology - トポロジデータをクリアします。
• get_device_neighbors - 機器の隣接機器情報を取得します。
• discover_device_neighbors - 単一の機器の隣接機器を発見します。
• get_topology_statistics - トポロジの統計情報を取得します。

ネットワークスキャンツール

• scan_network_range - ネットワークアドレス範囲をスキャンします。
• get_scan_results - スキャン結果を取得します。
• get_scan_statistics - スキャンの統計情報を取得します。
• discover_devices_from_scan_results - スキャン結果から機器を発見します。
• clear_scan_results - スキャン結果をクリアします。
• scan_single_host - 単一のホストをスキャンします。

リソース管理ツール

• list_resources - 利用可能なMCPリソースを一覧表示します。
• get_resource - 指定されたURIのリソースを取得します。
• clear_resource_cache - リソースキャッシュをクリアします。

テンプレート管理ツール

• list_templates - 利用可能なプロンプトテンプレートを一覧表示します。
• render_template - プロンプトテンプレートをレンダリングします。

テストツール

• test_scrapli_connection - Scrapli接続をテストします。
• test_telnet_connection - Telnet接続をテストします。
• send_telnet_command - Telnetコマンドを送信します。

利用可能なリソース

NetBrain MCPは、以下のMCPリソースを提供します。

機器リソース

• device/{device_id} - 機器の詳細情報を取得します。
• device/{device_id}/config - 機器の設定情報を取得します。
• device/{device_id}/interfaces - 機器のインターフェース情報を取得します。
• device/{device_id}/routes - 機器のルーティングテーブル情報を取得します。
• device/{device_id}/neighbors - 機器の隣接機器情報を取得します。

トポロジリソース

• topology - ネットワークトポロジデータを取得します。
• topology/statistics - トポロジの統計情報を取得します。

スキャンリソース

• scan/results - ネットワークスキャン結果を取得します。
• scan/statistics - スキャンの統計情報を取得します。
• scan/result/{ip_address} - 特定のIPのスキャン結果を取得します。

システムリソース

• greeting/{name} - パーソナライズされた挨拶メッセージを取得します。
• system/status - システムの状態情報を取得します。
• credentials - すべての認証情報を取得します（機密情報は非表示になっています）。

プロンプトテンプレート

NetBrain MCPは、以下のプロンプトテンプレートを提供します。

• device_diagnosis - 機器診断用のプロンプトテンプレートです。
• config_review - 機器設定レビュー用のプロンプトテンプレートです。
• route_analysis - ルーティング分析用のプロンプトテンプレートです。
• network_diagnosis - ネットワーク診断用のプロンプトテンプレートです。
• vlan_config - VLAN設定生成用のプロンプトテンプレートです。
• network_topology - ネットワークトポロジ分析用のプロンプトテンプレートです。
• network_security - ネットワークセキュリティ評価用のプロンプトテンプレートです。

🔧 技術詳細

🔧 バックエンド技術スタック

• 言語: Python 3.10+
• MCPフレームワーク: FastMCP (mcp Pythonパッケージに基づく)
• Webフレームワーク: FastAPI + WebSocket
• 機器接続: Scrapli (非同期/同期混合モードをサポート)
• 非同期サポート: asyncio を使用して、効率的なネットワーク操作を実現
• データストレージ: JSONファイルストレージ + メモリキャッシュ
• モジュール化設計: ネットワーク機器管理、コネクタ、ツール管理、リソース提供などの独立したモジュール

🌐 フロントエンド技術スタック

• ターミナルシミュレーション: XTerm.js - 専用のターミナル体験を提供
• データ可視化: D3.js - ネットワークトポロジを可視化
• リアルタイム通信: WebSocket - 双方向のリアルタイム通信を実現
• インターフェースフレームワーク: 最新のWeb技術 + CSS3アニメーション
• テーマシステム: CSS変数 + JavaScriptによるテーマ管理
• レスポンシブデザイン: Flexbox + Gridレイアウト

システムコンポーネント

🔧 核心コンポーネント

• ツールマネージャー (tool_manager.py): ツールの登録、分類、呼び出しを管理します。
• 機器マネージャー (network_devices.py): ネットワーク機器の情報と認証情報を管理します。
• 接続マネージャー (device_connector.py): ネットワーク機器との接続とコマンド実行を処理します。
• リソースマネージャー (mcp_resources.py): MCPリソースとプロンプトテンプレートを管理します。
• MCPサーバー (server.py): MCPインターフェースを提供し、他のコンポーネントを統合します。
• テンプレートシステム (template_system.py): AIプロンプトテンプレートの管理とレンダリングを行います。

🌐 Web界面コンポーネント

• Webサーバー (web/app.py): FastAPI Webサーバーで、RESTful APIとWebSocketをサポートします。
• WebSocketターミナル (web/static/js/terminal.js): リアルタイムのターミナル通信とXTerm.jsの統合を行います。
• トポロジ可視化 (web/static/js/topology.js): D3.jsによるネットワークトポロジのレンダリングエンジンです。
• テーマ管理 (web/static/js/theme.js): グローバルなテーマの切り替えと永続化を行います。
• 機器管理界面 (web/templates/): HTMLテンプレートとユーザーインターフェースです。

🚀 拡張コンポーネント

• トポロジ発見エンジン (topology_discovery_improved.py): CDP/LLDPプロトコルによるトポロジ発見を行います。
• ネットワークスキャナー (network_scanner.py): ネットワーク範囲のスキャンとメーカーのMACアドレス識別を行います。
• 機器プロンプトテンプレート (device_prompts.py): 機器固有のAIプロンプトテンプレートです。
• データストレージ層 (data/): JSONファイルによるデータストレージとデータの永続化を行います。
• コマンドテンプレートライブラリ (templates/): メーカー固有のコマンドテンプレートと設定フラグメントです。

プロジェクトのハイライト

🎯 完了した核心機能

✅ 完全なMCPプロトコルの実装 - FastMCPに基づく標準化されたAI - 機器通信プロトコル
✅ 専用のターミナル体験 - XTerm.jsに基づき、コマンド補完、履歴、実際のプロンプトをサポート
✅ ネットワークトポロジの可視化 - D3.jsに基づくインタラクティブなトポロジ図で、CDP/LLDP自動発見をサポート
✅ 多メーカー機器のサポート - シスコ、華為、H3Cなどの主要メーカーの機器を統一的に接続
✅ 現代的なWeb界面 - レスポンシブデザイン、ダーク/ブライトテーマ、デバイスを問わず互換性
✅ データの永続化ストレージ - JSONファイルによるストレージで、自動バックアップと復元
✅ スマート機器識別 - メーカーのMACアドレスライブラリが組み込まれ、機器の種類を自動的に推測
✅ ネットワークスキャン機能 - 大規模なネットワークの発見と機器の自動識別をサポート

🚀 技術的な特色

• 高度にモジュール化されたアーキテクチャ - 抽象ファクトリと戦略パターンに基づく拡張可能な設計
• 非同期性能の最適化 - 完全な非同期アーキテクチャにより、高い並列処理能力を実現
• AI駆動の操作 - MCPプロトコルにより、AIとネットワーク機器をシームレスに統合
• 専門的なエンジニアリング実践 - 完全なエラー処理、ログ記録、設定管理
• 混合接続モード - Scrapliの非同期/同期のスマートな適応により、最高の互換性を確保

🔮 将来の拡張方向

プロジェクトの核心機能は完了していますが、将来的には以下の機能強化を検討することができます。

• 企業向け機能 - ユーザー権限管理、監査ログ、コンプライアンスレポート
• 監視とアラート - ネットワーク性能の監視、障害の自動診断、予測的なメンテナンス
• プロトコルの拡張 - SNMP、NETCONF、RESTCONFなどのさらなるネットワークプロトコル
• 仮想化の統合 - eNSP、GNS3、EVE - NGなどのネットワークシミュレータのサポート
• AI機能の強化 - ネットワーク障害のスマートな分析、設定の最適化提案

プロジェクトチーム

• 技術責任者：Koreyoshi - MCPプロトコルの実装、システムアーキテクチャの設計
• 機能開発：Koreyoshi - 機器管理、データストレージ、トポロジ発見
• フロントエンド開発：Koreyoshi - Web界面、ターミナル機能、可視化の設計

貢献

Pull RequestsまたはIssuesを通じて、あなたの提案と改善案を投稿することを歓迎します。