Nmapmcp

🚀 NmapMCP

NmapMCP is an integrated tool that combines the powerful network scanning tool Nmap with the Model Context Protocol (MCP), enabling seamless network scanning capabilities in MCP-compatible environments. This project allows users to directly execute various network scanning tasks through the MCP interface, such as popular port scanning and DNS brute-forcing.

🚀 Quick Start

NmapMCP integrates the powerful network scanning tool Nmap with the Model Context Protocol (MCP), enabling seamless network scanning in MCP-compatible environments. Users can perform various network scanning tasks directly via the MCP interface.

✨ Features

• Popular Port Scanning: Quickly identify the most commonly used ports on the target host to assess potential intrusion points.
• DNS Brute-Forcing: Discover subdomains associated with the target domain to facilitate comprehensive domain mapping.
• List Scanning: Obtain a list of active hosts within a specified range without performing port scanning, suitable for network asset inventory.
• Operating System Detection: Determine the operating system of the target host by analyzing network responses to assist in vulnerability assessment.
• Version Detection: Identify the versions of services running on open ports to detect outdated or vulnerable services.
• FIN Scanning: Perform a stealthy scan by sending FIN packets to detect open ports without establishing a full connection.
• Idle Scanning: Use an idle host for highly stealthy scanning to reduce the risk of detection.
• Ping Scanning: Detect active hosts in the network by sending ICMP echo requests, suitable for network mapping.
• SYN Scanning: Perform a half-open TCP scan to identify open ports without completing the TCP handshake, reducing the possibility of being detected.
• TCP Connect Scanning: Establish a full TCP connection to detect open ports, which is particularly useful when SYN scanning is not feasible.
• UDP Scanning: Identify open UDP ports on the target host to detect services that do not use TCP.
• Port-Only Scanning: Focus on performing port scanning without additional host discovery to optimize the scanning process.
• No-Port Scanning: Perform host discovery without probing services, suitable for quickly identifying active hosts.
• ARP Discovery: Identify active devices in the local network segment through ARP requests, suitable for local area network environments.
• Disable DNS Resolution: Perform scanning without resolving IP addresses to domain names, reducing dependencies.

📦 Installation

Install via Smithery

Visit Smithery for a seamless installation experience.

Manual Installation

1. Clone the repository:

git clone https://github.com/yourusername/nmapmcp.git
cd nmapmcp

2. Install dependencies: Install the uv tool to run the project:

npm install uv

3. Create a virtual environment (optional):

uv init
uv run

4. Install dependencies:

npm install

📚 Documentation

Edit the claude_desktop_config.json file to customize the settings:

{
  "configuration": {
    "nmap_path": "/path/to/nmap",
    "mcp_endpoint": "http://localhost:8080"
  }
}

🤝 Contribution Guidelines

1. Clone the repository:

git clone https://github.com/yourusername/nmapmcp.git
cd nmapmcp

2. Create a branch:

git checkout -b feature/new-feature

3. Commit changes:

git add .
git commit -m "Add new feature"
git push origin feature/new-feature

4. Submit a pull request: Visit the original repository NmapMCP and click "New Pull Request" to submit your changes.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

Special thanks to the Nmap and MCP communities for providing valuable tools and technical support.