MCP Nuclei Server

🚀 MCP Nuclei Server

A security scanning server based on the MCP (Model Control Protocol), providing convenient vulnerability scanning services.

🚀 Quick Start

The MCP Nuclei Server is a security scanning service developed based on the MCP protocol. It allows large language models to perform core security scans and supports multiple scanning options and result output formats.

✨ Features

• Support for core security scanning
• Configurable template and tag filtering
• Support for filtering vulnerabilities by severity
• Output results in JSON format
• MCP service for easy integration

📦 Installation

Prerequisites

• Python 3.8 or higher
• A configured core binary file

Installation Steps

1. Clone the repository:

git clone https://github.com/crazyMarky/mcp_nuclei_server.git
cd mcp_nuclei_server

2. Install UV and activate the environment:

curl -LsSf https://astral.sh/uv/install.sh | sh # Linux/Mac
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"  # Windows

3. Install dependencies:

# Create and activate a virtual environment
uv venv
source .venv/bin/activate
# Install MCP-related packages
uv pip install mcp

💻 Usage Examples

MCP Configuration (Example CLINE)

1. Refer to the MCP JSON configuration:

{
  "mcpServers": {
    "nuclei_mcp_server": {
      "command": "/path/to/uv", # Path to uv
      "args": [
        "--directory",
        "/path/to/nuclei_mcp_server/",
        "run",
        "main.py"
      ],
      "env": {
        "NUCLEI_BIN_PATH": "/path/to/nuclei" # Path to the core binary file
      }
    }
  }
}

Basic Usage

Parameter Explanation

• target: Target URL or IP address
• templates: Specific template list (optional)
• severity: Vulnerability severity filtering (critical, high, medium, low, info)
• template_tags: Template tag filtering (optional)
• output_format: Output format (default: "json")

📚 Documentation

Output Format

The scan results are returned in JSON format, containing the following fields:

{
    "success": true,
    "target": "https://example.com",
    "time_cost_seconds": 10.5,
    "results": [
        {
            "template": "Template Name",
            "severity": "high",
            "matched_at": "https://example.com/path",
            "info": {
                "name": "Vulnerability Name",
                "description": "Vulnerability Description"
            }
        }
    ]
}

🤝 Contribution

We welcome you to submit issues and pull requests!

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

📄 License

This project is open-source under the MIT License. For details, please refer to the LICENSE file.

📞 Contact

If you have any questions or suggestions, please contact us via the following methods:

• Submit an ISSUE.
• Email: [Your Email]
• Join the discussion group: [Discussion Group Link]