Burp Suite

🚀 MCP Server Extension

Integrate Burp Suite with AI clients through the Model Context Protocol (MCP).

🚀 Quick Start

This README provides a comprehensive guide on integrating Burp Suite with AI clients using the Model Context Protocol (MCP).

✨ Features

• Connect Burp Suite with AI clients via MCP.
• Automatically install Claude Desktop.
• Include a packaged Stdio MCP proxy server.

💻 Usage Examples

Basic Usage

1. Install the extension in Burp Suite.
2. Configure your Burp MCP server in the extension settings.
3. Configure your MCP client to use the Burp SSE MCP server or the stdio proxy.
4. Interact with Burp through the client!

📦 Installation

Build the Extension

1. Clone the repository: Get the source code of the MCP Server Extension.

   git clone https://github.com/PortSwigger/mcp-server.git
   

2. Navigate to the project directory: Go to the root directory of the project.

   cd burp-mcp
   

3. Build the JAR file: Build the extension using Gradle.

   ./gradlew embedProxyJar
   

   This command compiles the source code and packages it into a JAR file located at build/libs/burp-mcp-all.jar.

Load the Extension into Burp Suite

1. Open Burp Suite: Launch your Burp Suite application.
2. Access the Extensions tab: Navigate to the Extensions tab.
3. Add the extension:
   • Click Add.
   • Set Extension Type to Java.
   • Click Select file ... and choose the JAR file built in the previous step.
   • Click Next to load the extension.

After successful loading, the MCP Server Extension will be active in Burp Suite.

📚 Documentation

Configure the Extension

Configure through the MCP tab in the Burp Suite UI.

• Enable the MCP server: The Enabled checkbox controls whether the MCP server is active.
• Allow configuration editing tools: The Enable tools that can edit your config checkbox allows the MCP server to expose tools that can edit the Burp configuration file.
• Advanced options: You can configure the port and host of the MCP server. By default, it listens on http://127.0.0.1:9876.

Claude Desktop Client

To fully utilize the MCP Server Extension in combination with Claude, you need to properly configure your Claude client settings. The extension has an installer that can automatically configure the client settings for you.

1. Currently, Claude Desktop only supports the STDIO MCP server, which it requires. This method is not ideal for desktop applications like Burp. Instead, Claude launches a proxy server that points to the Burp instance running the MCP extension, which hosts a web server on a known port (localhost:9876).

2. Configure Claude to use the Burp MCP server You can do this in one of the following two ways:

   • Option 1: Run the installer from the extension This will add the Burp MCP server to the Claude Desktop configuration.

   • Option 2: Manually edit the configuration file Open the file located at ~/Library/Application Support/Claude/claude_desktop_config.json and replace or update it with the following content:

     {
       "mcpServers": {
         "burp": {
           "command": "<Path to the Java executable containing Burp>",
           "args": [
               "-jar",
               "/path/to/mcp/proxy/jar/mcp-proxy-all.jar",
               "--sse-url",
               "<http://127.0.0.1:9876>"
           ]
         }
       }
     }
     

Create/Modify Tools

Tools are defined in src/main/kotlin/net/portswigger/mcp/tools/Tools.kt. To define a new tool, create a new serializable data class that contains the parameters required by the LLM. The tool name is automatically generated from its parameter data class. You also need to provide a description for the LLM. You can return a string (or other more rich PromptMessageContents) to provide more data to the LLM.

Add automatic pagination support by extending the Paginated interface.

For more information about the protocol, please visit: modelcontextprotocol.io