Ai Assistant Chat With Nmap Tool Integration

🚀 AI代理聊天工具集成Nmap工具

本項目提供了一個基於網絡的Gradio聊天界面，用戶可藉此與由OpenAI API驅動的AI助手進行交互。該助手具備使用本地文件系統和通過容器化Nmap服務器開展網絡掃描的能力，為用戶提供便捷的網絡交互與掃描服務。

🚀 快速開始

確保滿足以下先決條件後，按照安裝與設置步驟操作，即可運行應用程序。

先決條件

• Python：3.9+
• Docker：安裝最新版本並運行。
• Node.js/npm：需要npx來運行文件系統MCP服務器。
• 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
# 一個示例MCP服務器，其中包含幾個Nmap掃描功能。

✨ 主要特性

對話式交互

• 提供基於網絡的Gradio界面，方便用戶與AI助手進行對話式交互。

工具集成

• 文件系統訪問：具備文件系統訪問工具，但限制在應用程序目錄。
• Nmap網絡掃描：集成了多種Nmap掃描功能，包括ping_host、scan_network（前100個端口）、all_scan_network（全面掃描）、all_ports_scan_network（所有65535個端口）和smb_share_enum_scan（SMB共享枚舉）。

容器化管理

• Nmap服務器運行在Docker容器中，便於依賴管理和隔離。

📚 詳細文檔

概述

應用程序採用了OpenAI代理SDK框架。用戶的請求由AI代理處理，該代理能夠理解請求並決定是否使用可用工具。其具體組成如下：

• 網絡界面：使用Gradio提供基於網絡的界面，方便用戶交互。
• AI代理：後端使用OpenAI模型驅動的AI代理（需要API密鑰）。
• MCP服務器：
  • 文件系統服務器：通過npx運行提供本地文件訪問（使用@modelcontextprotocol/server-filesystem）。
  • Nmap掃描服務器：包裝在Docker容器中的MCP服務器，提供Nmap掃描功能（ping、端口掃描、服務發現、SMB共享枚舉）[citation: 14, 16, 18, 20, 22]。

功能

• 對話式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]
• 基於網絡的UI：使用Gradio構建，方便用戶操作[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在Docker中)：在一個Docker容器中運行，通過MCP暴露Nmap掃描功能作為工具[citation: 2, 14]。app.txt使用docker run為每個請求啟動此服務器。