NMAP Scanner

🚀 MCP NMAP Server

A Model Context Protocol (MCP) server that enables AI assistants to perform network scanning operations using NMAP. This server provides a standardized interface for AI models to interact with NMAP, facilitating network analysis and security assessment through AI conversations.

🚀 Quick Start

This is a Model Context Protocol (MCP) server that allows AI assistants to use NMAP for network scanning operations. It offers a standardized interface for AI models to interact with NMAP, enabling network analysis and security assessment via AI conversations.

✨ Features

The server provides a simple interface to access the core functions of NMAP. It supports quick scans, full port scans, version detection, and custom time templates. The implementation uses the native NMAP command - line interface, ensuring reliability and consistency with standard NMAP operations.

📦 Installation

Automatic Installation via Smithery

To automatically install the NMAP server for Claude Desktop via Smithery:

npx -y @smithery/cli install mcp-nmap-server --client claude

Manual Installation

Install globally using npm:

npm install -g mcp-nmap-server

Or install locally in your project:

npm install mcp-nmap-server

💻 Usage Examples

Configuration with Claude Desktop

To use this server with Claude Desktop on Windows, you need to configure it in the Claude configuration file, which is located at: C:\Users\YOUR_USERNAME\AppData\Roaming\Claude\config.json

Configure it by adding the NMAP server to the mcpServers section. Here is a complete example of the Claude Desktop configuration file:

{
    "mcpServers": {
        "nmap": {
            "command": "node",
            "args": [
                "C:\\Users\\YOUR_USERNAME\\Downloads\\mcp-nmap-server\\dist\\index.js"
            ]
        }
    },
    "globalShortcut": "Ctrl+Q"
}

Replace YOUR_USERNAME with your Windows username and adjust the installation path of the NMAP server.

Using with AI

After configuration, an AI assistant (such as Claude) can use the server by calling the run_nmap_scan function. This function accepts the following parameters:

{
    target: string;            // The target host or network to scan
    ports?: string;           // Optional port specification (e.g., "80,443" or "1 - 1000")
    scanType?: 'quick' | 'full' | 'version';  // Scan type (default: 'quick')
    timing?: number;          // NMAP timing template 0 - 5 (default: 3)
    additionalFlags?: string; // Optional additional NMAP flags
}

Example conversation with Claude:

Human: Can you scan the open ports on the local host?

Claude: I'll help you scan the local host using NMAP.

<Execute an nmap scan targeting localhost, with a quick scan type and timing set to 3>

📄 License

MIT License

💡 Usage Tip

For issues, suggestions, or contributions, please visit the GitHub repository.