MCP Vulnerability Scanner

🚀 MCP Vulnerability Scanner

An MCP (Model Context Protocol) server for scanning vulnerabilities in IP addresses. It offers tools to conduct security scans on single or multiple IPs.

🚀 Quick Start

The MCP Vulnerability Scanner is a powerful tool designed to scan IP addresses for potential vulnerabilities. It supports both single and batch IP scanning, providing detailed reports on detected issues.

✨ Features

• Multiple Scanning Methods: Employ various techniques to scan IP addresses, including Nmap vulnerability scanning and API - based vulnerability checks.
• Flexible Scanning Modes: Support scanning of a single IP or multiple IPs in batches.
• Comprehensive Reports: Return detailed reports that include the severity, description, and repair steps of detected vulnerabilities.
• MCP Integration: Implement the Model Context Protocol for seamless integration with MCP clients.

📦 Installation

Prerequisites

• Node.js (v14.x or higher)
• npm (v7.x or higher)
• Nmap (Optional, for enhanced scanning capabilities)

Steps

1. Clone the repository:

   git clone <repository-url>
   cd mcp-vulnerability-scanner
   

2. Install dependencies:

   npm install
   

3. Install Nmap (Optional but recommended):

   # For Ubuntu/Debian
   sudo apt-get update
   sudo apt-get install nmap
   
   # For CentOS/RHEL
   sudo yum install nmap
   
   # For macOS
   brew install nmap
   

📚 Documentation

Configuration

The MCP Vulnerability Scanner is configured through the following files:

1. .mcp.json

This is the main MCP configuration file:

{
  "name": "vulnerability-scanner",
  "version": "1.0.0",
  "description": "An MCP server for scanning vulnerabilities on IP addresses",
  "command": "npm",
  "args": ["run", "dev"],
  "capabilities": {
    "contextItemTypes": ["ip"]
  }
}

2. Integration with VS Code

Configure VS Code in .vscode/mcp.json:

{
  "mcpServers": {
    "mcp_vuln": {
      "command": "npm",
      "args": [
        "run",
        "dev",
        "mcp-vulnerability-scanner",
        "--prefix",
        "/path/to/mcp-vulnerability-scanner"
      ],
      "env": {
        "MCP_SERVER_PORT": "3000"
      }
    }
  }
}

Update the --prefix path to point to your installation location.

Deployment Options

Integrate into an Existing Project

To integrate the MCP Vulnerability Scanner into an existing project, follow these steps:

1. Add mcp-vulnerability-scanner to the project's dependencies:

   "dependencies": {
     "mcp-vulnerability-scanner": "^1.0.0"
   }
   

2. Use the scanner in your code:

   const { scan } = require('mcp-vulnerability-scanner');
   
   // Perform a scan
   scan(targetIP, (result) => {
     console.log(result);
   });
   

💻 Usage Examples

Basic Usage

Here are some examples showing how the vulnerability scanner works:

• Single IP Address Scanning

• Multiple IP Addresses Scanning

Available Tools

Scanner

# Install the scanner
npm install mcp-vulnerability-scanner --save

Sample Code

const { scan } = require('mcp-vulnerability-scanner');

// Perform a scan
scan(targetIP, (result) => {
  console.log(result);
});

🔧 Technical Details

Security Precautions

• Ensure that all API requests are authenticated and authorized.
• Regularly update the vulnerability database to obtain the latest security information.
• Avoid exposing the scanning function publicly in a production environment.

By following these steps, you can easily integrate the MCP Vulnerability Scanner into your project and enhance your network security capabilities.