Broxy

Why Broxy

Features

Connections

STDIO (local connection)

Use STDIO when your client expects a local MCP process.

{
    "mcpServers": {
        "broxy": {
            "command": "/Applications/broxy.app/Contents/MacOS/broxy",
            "args": [
                "--stdio-proxy"
            ]
        }
    }
}

Streamable HTTP

Broxy exposes Streamable HTTP on http://localhost:3335/mcp by default.

{
    "mcpServers": {
        "broxy": {
            "url": "http://localhost:3335/mcp"
        }
    }
}

SSE inbound

SSE is served on the same host and port at /sse.

• GET http://localhost:3335/sse opens the SSE stream and returns the session endpoint.
• POST http://localhost:3335/sse?sessionId=... forwards MCP JSON-RPC messages into the session.

Developer Documentation

For contributors and AI code agents:

• Start with docs/readme.md (2-level docs index).
• Use docs/agent_quickstart.md for task-to-doc mapping, invariants, and required checks.
• Canonical runtime contracts are in:
  • docs/core_contracts.md
  • docs/proxy_facade.md
  • docs/inbound_transports.md
  • docs/presets_and_filtering.md
  • docs/configuration_and_hot_reload.md

CLI jar

Build the jar

./gradlew :cli:shadowJar

The jar is generated at cli/build/libs/broxy-cli.jar.

Run STDIO

java -jar cli/build/libs/broxy-cli.jar proxy \
  --preset-id <preset-id> \
  --config-dir ~/.config/broxy \
  --inbound stdio

Run Streamable HTTP + SSE

java -jar cli/build/libs/broxy-cli.jar proxy \
  --preset-id <preset-id> \
  --config-dir ~/.config/broxy \
  --inbound http \
  --url http://localhost:3335/mcp

The CLI expects mcp.json and preset_<id>.json in the config directory (default ~/.config/broxy).