Ai Assistant Chat With Nmap Tool Integration

🚀 AIエージェントチャットツールとNmapツールの統合

このプロジェクトは、WebベースのGradioチャットインターフェースを提供し、ユーザーはOpenAI APIで駆動されるAIアシスタントと対話できます。このアシスタントには、ローカルファイルシステムを使用し、コンテナ化されたNmapサーバーを通じてネットワークスキャンを行うツールが備えられています。

📋 概要

このアプリケーションはOpenAIエージェントSDKフレームワークを使用しています。ユーザーのリクエストはAIエージェントによって処理され、このエージェントはリクエストを理解し、利用可能なツールを使用するかどうかを判断できます。以下の特徴があります。

• GradioによるWebベースのインターフェースを使用し、ユーザーとの対話を容易にします。
• バックエンドはOpenAIモデルで駆動されるAIエージェント（APIキーが必要）を使用します。
• ファイルシステムアクセス用のモデルコンテキストプロトコル（MCP）サーバー（@modelcontextprotocol/server-filesystemを使用）。
• Dockerコンテナに包装されたMCPサーバーで、Nmapスキャン機能（ping、ポートスキャン、サービス発見、SMB共有列挙）を提供します[citation: 14, 16, 18, 20, 22]。

NmapサーバーはDockerコンテナ内で実行され、依存関係の管理と分離を容易にしています。

✨ 主な機能

• 対話型AIアシスタント。
• ファイルシステムアクセスツール（アプリケーションディレクトリに制限）。
• Nmapネットワークスキャンツール：
  • ping_host [citation: 14]
  • scan_network（上位100個のポート）[citation: 16]
  • all_scan_network（全面スキャン）[-A][citation: 18]
  • all_ports_scan_network（すべての65535個のポート）[citation: 20]
  • smb_share_enum_scan（SMB共有列挙）[citation: 22]
• Gradioを使用したWebベースのUI[citation: 11, 12]。
• Dockerコンテナ化されたNmapツールサーバーの使用。

🏗️ アーキテクチャ

1. Gradio UI (app.txt)：ユーザー入力を処理し、対話履歴を表示します。
2. メインアプリケーション (app.txt)：
   • Gradioインターフェースを初期化します。
   • 対話状態を管理します。
   • MCPサーバーを設定および管理します。
   • OpenAIエージェントをインスタンス化して実行します。
3. OpenAIエージェント (agentsライブラリ)：ユーザーメッセージを処理し、必要に応じてツールを呼び出し、応答を生成します[citation: 1, 3]。
4. MCPサーバー：
   • ファイルシステムサーバー：npxを通じてローカルファイルアクセスを提供します[citation: 1]。
   • Nmapツールパッケージサーバー (nmap-server.txt in Docker)：Dockerコンテナ内で実行され、MCPを通じてNmapスキャン機能をツールとして公開します[citation: 2, 14]。app.txtは各リクエストに対してdocker runを使用してこのサーバーを起動します。

📋 前提条件

• Python：3.9以上
• Docker：最新バージョンをインストールし、実行中であること。
• Node.js/npm：ファイルシステムMCPサーバーを実行するためにnpxが必要です。
• OpenAI APIキー：環境変数OPENAI_API_KEYとして設定する必要があります。

📦 インストール

1. リポジトリをクローンする：

   git clone <your-repository-url>
   cd <your-repository-directory>
   

2. OpenAI APIキーを設定する： APIキーを環境変数としてエクスポートします。your_api_key_hereを実際のキーに置き換えてください。

   • Linux/macOS：

     export OPENAI_API_KEY='your_api_key_here'
     

   • Windows（コマンドプロンプト）：

     set OPENAI_API_KEY=your_api_key_here
     

   • Windows（PowerShell）：

     $env:OPENAI_API_KEY='your_api_key_here'
     

3. Nmap Dockerイメージをビルドする： nmap-server.pyとDockerfileが含まれるディレクトリに移動し、以下のコマンドを実行します。

   docker build -t nmap-mcp-server .
   

   （Dockerfileの内容が正しいことを確認してください。特にmodelcontextprotocolではない場合は、MCPパッケージ名を確認してください）

4. Pythonの依存関係をインストールする： 仮想環境の使用をおすすめします。

   python -m venv venv
   # 仮想環境をアクティブ化する
   # Linux/macOS：
   source venv/bin/activate
   # Windows：
   .\venv\Scripts\activate
   # 必要なパッケージをインストールする
   pip install -r requirements.txt
   

💻 アプリケーションの実行

OpenAI APIキーが設定され、Dockerが実行中で、プロジェクトのルートディレクトリで仮想環境がアクティブ化されていることを確認してください。

python app.py
# いくつかのNmapスキャン機能を含むサンプルMCPサーバー。