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为每个请求启动此服务器。