AI Assistant Chat with Nmap Tool Integration

What is AI Assistant Chat with Nmap Tool Integration?

This project provides a web-based chat interface using Gradio where users interact with an AI assistant powered by the OpenAI API. The assistant is equipped with tools to interact with the local filesystem and perform network scans using a containerized Nmap server. It is built on the OpenAI Agents SDK and uses Model Context Protocol (MCP) servers for tool integration.

How to use AI Assistant Chat with Nmap Tool Integration?

After cloning the repository, set the OPENAI_API_KEY environment variable, build the Nmap Docker image with docker build -t nmap-mcp-server ., install Python dependencies from requirements.txt, and run python app.py. Ensure Docker is running and a virtual environment is activated.

Key features of AI Assistant Chat with Nmap Tool Integration

• Conversational AI assistant powered by OpenAI.
• Filesystem access tool scoped to the application directory.
• Nmap scanning tools: ping_host, scan_network, all_scan_network, all_ports_scan_network, smb_share_enum_scan.
• Web-based UI using Gradio.
• Containerized Nmap server via Docker for isolation.

Use cases of AI Assistant Chat with Nmap Tool Integration

• Perform network ping tests through natural language requests.
• Scan top 100 ports on a target host or network.
• Run comprehensive network scans with service detection.
• Enumerate SMB shares on discovered hosts.
• Read or write local files within the application directory via chat.

FAQ from AI Assistant Chat with Nmap Tool Integration

What are the prerequisites?

Python 3.9+, Docker (latest), Node.js/npm (for the filesystem MCP server), and an OpenAI API key are required.

How do I set the OpenAI API key?

Export it as the environment variable OPENAI_API_KEY. Commands are provided in the README for Linux/macOS, Windows Command Prompt, and PowerShell.

Does the Nmap server require Docker?

Yes, the Nmap toolkit server runs inside a Docker container built from the provided Dockerfile using docker build -t nmap-mcp-server ..

What specific Nmap scans are available?

Five tools: ping_host, scan_network (top 100 ports), all_scan_network (comprehensive -A scan), all_ports_scan_network (all 65535 ports), and smb_share_enum_scan (SMB share enumeration).

How do I run the application?

Ensure your API key is set, Docker is running, and you are in the project root with the virtual environment activated, then execute python app.py.