Metasploit Framework

🚀 Metasploit MCP Server

This is a Model Context Protocol (MCP) server that integrates large language models (such as Claude) with the Metasploit framework. It allows AI assistants to dynamically access and control Metasploit functions through standardized tools, providing a natural language interface to manage complex penetration testing workflows.

🚀 Quick Start

This MCP server serves as a bridge between large language models and the Metasploit penetration testing platform. It enables AI-assisted tools to dynamically configure and execute Metasploit functions through a standard interface, thereby automating security testing.

✨ Features

Module Information

• List Available Modules: List all available Metasploit modules.
• Get Module Details: Display detailed information about a specified module, including options and descriptions.

Operation Logs

• View Operation Logs: Retrieve operation logs related to a specific task.
• Clear Operation Logs: Delete operation records for a specified task.

Session Management

• Create New Session: Start a new penetration testing session based on the provided configuration parameters.
• List Active Sessions: Display all running sessions and their statuses.
• Terminate Session: Stop a specified session and release related resources.

Module Execution

• Execute Single Module: Execute a specific Metasploit module in a specified session and return the operation result.

Event Subscription

• Subscribe to Events: Register for notifications of specific types of events.
• Unsubscribe from Events: Stop receiving notifications for specified events.

📦 Installation

Log File Path

• By default, operation logs are saved in the ~/metasploit_mcp_server_logs directory. You can change the log storage location by setting the environment variable METASPLOIT_MCP_SERVER_LOG_PATH:
  • Windows (PowerShell):

    $env:METASPLOIT_MCP_SERVER_LOG_PATH = "C:\custom\log\path"
    

  • Windows (Command Prompt):

    set METASPLOIT_MCP_SERVER_LOG_PATH=C:\custom\log\path
    

  • Linux/macOS:

    export METASPLOIT_MCP_SERVER_LOG_PATH=/custom/log/path
    

Other Settings

• Enable Debug Mode: Enable debug output by setting the environment variable DEBUG_MODE=true:
  • Windows (PowerShell):

    $env:DEBUG_MODE = "true"
    

  • Windows (Command Prompt):

    set DEBUG_MODE=true
    

  • Linux/macOS:

    export DEBUG_MODE=true
    

🔧 Technical Details

Security Precautions

• Permission Control: Ensure that only authorized users can access this server.
• Log Review: Regularly review operation logs to monitor potential security events.
• Network Isolation: Run this service on a trusted network and avoid exposing it to the Internet.

📄 License

Apache 2.0