What is Nmap Mcpserver

nmap-mcpserver is a Model Control Protocol (MCP) server that provides access to nmap network scanning functionality, allowing users to perform network scans and manage results effectively.

Use cases

Use cases include performing routine network scans to identify open ports, analyzing security vulnerabilities in systems, and managing scan results for compliance and reporting.

How to use

To use nmap-mcpserver, install the required dependencies, run the server using Python, and utilize available tools to execute scans, retrieve scan details, and analyze results.

Key features

Key features include the ability to run customizable nmap scans on specified targets, store and retrieve scan results, and analyze those results using AI prompts.

Where to use

nmap-mcpserver can be used in various fields such as network security assessments, vulnerability scanning, and IT infrastructure management.

Nmap MCP Server

This is a Model Control Protocol (MCP) server that provides access to nmap network scanning functionality.

Features

• Run nmap scans on specified targets with customizable options
• Store and retrieve scan results
• Analyze scan results using AI prompts

Installation

Requirements:

• Python 3.10+
• python-libnmap
• nmap (installed on the system)

pip install python-libnmap

Make sure nmap is installed on your system:

# On Debian/Ubuntu
sudo apt-get install nmap

# On Fedora/CentOS
sudo dnf install nmap

Usage

Running the Server

To run the server directly from the source code:

python -m src.nmap_mcp

To install the package and run as a command:

pip install -e .
nmap-mcp

Available Tools

1. run-nmap-scan

   • Run an nmap scan on specified targets
   • Parameters:
     • target: Target host or network (e.g., 192.168.1.1 or 192.168.1.0/24)
     • options: Nmap options (e.g., -sV -p 1-1000)

2. get-scan-details

   • Get detailed information about a specific scan
   • Parameters:
     • scan_id: ID of the scan to retrieve

3. list-all-scans

   • List all available scan results
   • No parameters required

Available Prompts

1. analyze-scan
   • Analyze an nmap scan result
   • Parameters:
     • scan_id: ID of the scan to analyze
     • focus: Focus area (security/services/overview)

Resources

Scan results are available as resources with the nmap://scan/{scan_id} URI scheme.

Example Workflow

1. Run a scan:

   Call tool: run-nmap-scan
   Parameters: {"target": "192.168.1.0/24", "options": "-sV -p 22,80,443"}
   

2. Get scan details:

   Call tool: get-scan-details
   Parameters: {"scan_id": "<scan_id from previous step>"}
   

3. List all scans:

   Call tool: list-all-scans
   

4. Analyze scan results:

   Get prompt: analyze-scan
   Parameters: {"scan_id": "<scan_id>", "focus": "security"}
   

Security Considerations

This server executes nmap commands on your system. Be cautious when scanning networks you don’t own or have permission to scan, as unauthorized scanning may be illegal in some jurisdictions.

Troubleshooting

If you encounter errors related to nmap not being found or being executed incorrectly:

1. Make sure nmap is installed and available in your PATH
2. Check the logs for which nmap executable is being used
3. The server will attempt to use the full path to nmap to avoid conflicts

Docker Usage

You can run the MCP server in a Docker container:

# Build the Docker image
docker build -t nmap-mcp-server .

# Run the Docker container
docker run -it --rm nmap-mcp-server

For integration with the Glama MCP directory, the Docker container allows others to easily use this MCP server without worrying about installation dependencies.

License

This project is licensed under the MIT License - see the LICENSE file for details.