Skip to content

Add manual client configuration examples #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SrFlipFlop wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add manual client configuration examples #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbb4441
Add manual client configuration examples
SrFlipFlop May 5, 2026
2a5db4c
Refine manual client configuration examples
SrFlipFlop May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 54 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,17 +109,58 @@ The extension has an installer which will automatically configure the client set
If you want to install the MCP server manually you can either use the extension's SSE server directly or the packaged
Stdio proxy server.

### SSE MCP Server
In order to use the SSE server directly you can just provide the url for the server in your client's configuration. Depending
on your client and your configuration in the extension this may be with or without the `/sse` path.
### Client configuration examples

The examples below show how to configure some popular MCP clients to connect to Burp Suite.

#### OpenCode

OpenCode can connect directly to the Burp SSE endpoint using a remote MCP server definition.

Add the following to `~/.config/opencode/opencode.json` or your project `opencode.json`:

```json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"burp": {
"type": "remote",
"url": "http://127.0.0.1:9876",
"enabled": true
}
}
}
```
http://127.0.0.1:9876

#### GitHub Copilot CLI

GitHub Copilot CLI can connect directly to the Burp SSE endpoint:

```bash
copilot mcp add --transport sse burp http://127.0.0.1:9876
```
or

You can verify the configuration with:

```bash
copilot mcp list
copilot mcp get burp
```
http://127.0.0.1:9876/sse

#### Codex CLI

Codex CLI works well with the packaged stdio proxy server. You can add the Burp proxy with:

```bash
codex mcp add burp -- java -jar /path/to/mcp-proxy-all.jar --sse-url http://127.0.0.1:9876
```

This adds a stdio MCP server entry that forwards requests to the Burp SSE endpoint.

### SSE MCP Server
In order to use the SSE server directly you can just provide the url for the server in your client's configuration. Depending
on your client and your configuration in the extension this may be without the `/sse` path (`http://127.0.0.1:9876`) or with the `/sse` path (`http://127.0.0.1:9876/sse`).

### Stdio MCP Proxy Server
The source code for the proxy server can be found here: [MCP Proxy Server](https://github.com/PortSwigger/mcp-proxy)

Expand All @@ -129,7 +170,13 @@ passing requests to the SSE MCP server extension.
If you want to use the Stdio proxy server you can use the extension's installer option to extract the proxy server jar.
Once you have the jar you can add the following command and args to your client configuration:
```
/path/to/packaged/burp/java -jar /path/to/proxy/jar/mcp-proxy-all.jar --sse-url http://127.0.0.1:9876
/path/to/java -jar /path/to/mcp-proxy-all.jar --sse-url http://127.0.0.1:9876
```

If you have issues discovering tools when using Codex CLI, explicitly setting `model_reasoning_effort` can help:

```
codex -c model_reasoning_effort='"high"' mcp add burp -- java -jar /path/to/mcp-proxy-all.jar --sse-url http://127.0.0.1:9876
```

### Creating / modifying tools
Expand Down