$git clone https://github.com/PortSwigger/mcp-serverIntegrate Burp Suite with AI Clients using the Model Context Protocol (MCP).
| 1 | # Burp Suite MCP Server Extension |
| 2 | |
| 3 | ## Overview |
| 4 | |
| 5 | Integrate Burp Suite with AI Clients using the Model Context Protocol (MCP). |
| 6 | |
| 7 | For more information about the protocol visit: [modelcontextprotocol.io](https://modelcontextprotocol.io/) |
| 8 | |
| 9 | ## Features |
| 10 | |
| 11 | - Connect Burp Suite to AI clients through MCP |
| 12 | - Automatic installation for Claude Desktop |
| 13 | - Comes with packaged Stdio MCP proxy server |
| 14 | |
| 15 | ## Usage |
| 16 | |
| 17 | - Install the extension in Burp Suite |
| 18 | - Configure your Burp MCP server in the extension settings |
| 19 | - Configure your MCP client to use the Burp SSE MCP server or stdio proxy |
| 20 | - Interact with Burp through your client! |
| 21 | |
| 22 | ## Installation |
| 23 | |
| 24 | ### Prerequisites |
| 25 | |
| 26 | Ensure that the following prerequisites are met before building and installing the extension: |
| 27 | |
| 28 | 1. **Java**: Java must be installed and available in your system's PATH. You can verify this by running `java --version` in your terminal. |
| 29 | 2. **jar Command**: The `jar` command must be executable and available in your system's PATH. You can verify this by running `jar --version` in your terminal. This is required for building and installing the extension. |
| 30 | |
| 31 | ### Building the Extension |
| 32 | |
| 33 | 1. **Clone the Repository**: Obtain the source code for the MCP Server Extension. |
| 34 | ``` |
| 35 | git clone https://github.com/PortSwigger/mcp-server.git |
| 36 | ``` |
| 37 | |
| 38 | 2. **Navigate to the Project Directory**: Move into the project's root directory. |
| 39 | ``` |
| 40 | cd mcp-server |
| 41 | ``` |
| 42 | |
| 43 | 3. **Build the JAR File**: Use Gradle to build the extension. |
| 44 | ``` |
| 45 | ./gradlew embedProxyJar |
| 46 | ``` |
| 47 | |
| 48 | This command compiles the source code and packages it into a JAR file located in `build/libs/burp-mcp-all.jar`. |
| 49 | |
| 50 | ### Loading the Extension into Burp Suite |
| 51 | |
| 52 | 1. **Open Burp Suite**: Launch your Burp Suite application. |
| 53 | 2. **Access the Extensions Tab**: Navigate to the `Extensions` tab. |
| 54 | 3. **Add the Extension**: |
| 55 | - Click on `Add`. |
| 56 | - Set `Extension Type` to `Java`. |
| 57 | - Click `Select file ...` and choose the JAR file built in the previous step. |
| 58 | - Click `Next` to load the extension. |
| 59 | |
| 60 | Upon successful loading, the MCP Server Extension will be active within Burp Suite. |
| 61 | |
| 62 | ## Configuration |
| 63 | |
| 64 | ### Configuring the Extension |
| 65 | Configuration for the extension is done through the Burp Suite UI in the `MCP` tab. |
| 66 | - **Toggle the MCP Server**: The `Enabled` checkbox controls whether the MCP server is active. |
| 67 | - **Enable config editing**: The `Enable tools that can edit your config` checkbox allows the MCP server to expose tools which can edit Burp configuration files. |
| 68 | - **Advanced options**: You can configure the port and host for the MCP server. By default, it listens on `http://127.0.0.1:9876`. |
| 69 | |
| 70 | ### Claude Desktop Client |
| 71 | |
| 72 | To fully utilize the MCP Server Extension with Claude, you need to configure your Claude client settings appropriately. |
| 73 | The extension has an installer which will automatically configure the client settings for you. |
| 74 | |
| 75 | 1. Currently, Claude Desktop only support STDIO MCP Servers |
| 76 | for the service it needs. |
| 77 | This approach isn't ideal for desktop apps like Burp, so instead, Claude will start a proxy server that points to the |
| 78 | Burp instance, |
| 79 | which hosts a web server at a known port (`localhost:9876`). |
| 80 | |
| 81 | 2. **Configure Claude to use the Burp MCP server** |
| 82 | You can do this in one of two ways: |
| 83 | |
| 84 | - **Option 1: Run the installer from the extension** |
| 85 | This will add the Burp MCP server to the Claude Desktop config. |
| 86 | |
| 87 | - **Option 2: Manually edit the config file** |
| 88 | Open the file located at `~/Library/Application Support/Claude/claude_desktop_config.json`, |
| 89 | and replace or update it with the following: |
| 90 | ```json |
| 91 | { |
| 92 | "mcpServers": { |
| 93 | "burp": { |
| 94 | "command": "<path to Java executable packaged with Burp>", |
| 95 | "args": [ |
| 96 | "-jar", |
| 97 | "/path/to/mcp/proxy/jar/mcp-proxy-all.jar", |
| 98 | "--sse-url", |
| 99 | "<your Burp MCP server URL configured in the extension>" |
| 100 | ] |
| 101 | } |
| 102 | } |
| 103 | } |
| 104 | ``` |
| 105 | |
| 106 | 3. **Restart Claude Desktop** - assu |