AI助手与Nmap工具集成聊天

本项目提供了一个基于Gradio的Web聊天界面，用户可以通过该界面与由OpenAI API驱动的AI助手进行交互。该助手配备了与本地文件系统交互以及使用容器化的Nmap服务器执行网络扫描的工具。

概述

该应用程序使用OpenAI Agents SDK框架。用户请求由AI代理处理，该代理可以推理请求并决定是否使用可用工具。它具有以下特点：

• 一个用于轻松交互的Gradio前端。
• 一个利用OpenAI模型的AI代理后端（需要API密钥）。
• 一个用于文件系统访问的模型上下文协议（MCP）服务器（使用@modelcontextprotocol/server-filesystem）。
• 一个容器化的MCP服务器，提供Nmap扫描功能（ping、端口扫描、服务发现、SMB共享枚举）[cite: 14, 16, 18, 20, 22]。

Nmap服务器在Docker容器内运行，以便于依赖管理和隔离。

特性

• 对话式AI助手。
• 文件系统访问工具（范围限定于应用程序目录）。
• 通过Nmap进行网络扫描的工具：
  • ping_host [cite: 14]
  • scan_network (前100个端口) [cite: 16]
  • all_scan_network (-A 全面扫描) [cite: 18]
  • all_ports_scan_network (所有65535个端口) [cite: 20]
  • smb_share_enum_scan (SMB共享枚举) [cite: 22]
• 使用Gradio的Web UI[cite: 11, 12]。
• 使用Docker的容器化Nmap工具服务器。

架构

1. Gradio UI (app.txt): 处理用户输入并显示对话历史记录。
2. 主应用程序 (app.txt):
   • 初始化Gradio界面。
   • 管理对话状态。
   • 设置和管理MCP服务器。
   • 实例化并运行OpenAI Agent。
3. OpenAI Agent (agents 库): 处理用户消息，在需要时调用工具，并生成响应[cite: 1, 3]。
4. MCP 服务器:
   • 文件系统服务器: 通过 npx 运行，以提供本地文件访问[cite: 1]。
   • Nmap 工具包服务器 (nmap-server.txt 在 Docker 中): 在 Docker 容器内运行，通过 MCP 将 Nmap 扫描功能作为工具公开[cite: 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 内容正确，特别是 MCP 包名称，如果它不是 modelcontextprotocol)

4. 安装 Python 依赖项: 建议使用虚拟环境。

   python -m venv venv
   # 激活虚拟环境
   # Linux/macOS:
   source venv/bin/activate
   # Windows:
   .\venv\Scripts\activate
   # 安装 requirements
   pip install -r requirements.txt
   

运行应用程序

确保您的 OpenAI API 密钥已设置，Docker 正在运行，并且您位于项目的根目录中，并且虚拟环境已激活。

python app.py
 An example MCP server with a couple nmap scans as tools.