Browser Relay Skill

Control a real Chrome browser via the Browser Relay CLI, HTTP API, or MCP. The browser runs on the user's machine, carrying their login state, cookies, and extensions.

When to Use

Use Browser Relay when you need to:

Scrape dynamic pages — JavaScript-rendered content, SPAs, dashboards
Interact with login-protected sites — pages that require the user's session (Twitter, Gmail, Notion, etc.)
Perform actions — click buttons, fill forms, scroll, take screenshots
Get structured page text — annotated DOM snapshot with [link], [button], [input] markers
Evaluate arbitrary JavaScript in the page context

When NOT to use:

Simple static pages without login — use WebFetch or Jina Reader (faster, cheaper)
Pure API calls — use the site's REST API directly

Prerequisites

Relay Server running (Node.js, default port 18795)
Browser Relay Chrome Extension installed and configured with the relay port
At least one Chrome tab open and attached (extension auto-attaches all tabs)

Connection Info

Relay URL:  http://127.0.0.1:18795
WebSocket:  ws://127.0.0.1:18795/extension

No authentication needed — the relay only accepts connections from localhost.

Remote mode ("Remote Relay") lets an agent drive a browser on another machine. The user opens the extension Options, turns on Remote Relay, and copies the generated remote-device-id — a secret capability like br-xxx. Only then use remote flags (the hosted hub relay.linso.ai is the default host):

browser-relay tabs --remote-device-id br-xxx
browser-relay remote add mymac br-xxx    # or save an alias once…
browser-relay tabs --remote mymac        # …and use the short name (remote ls / rm to manage)

Never invent or guess a remote-device-id; it is a secret generated by the extension. The local relay stays bound to localhost — remote mode connects the browser out to the hub and does not need it.

Preferred CLI Workflow

When shell access is available, use the browser-relay CLI for browser interaction. Do not hand-write curl for normal agent browsing tasks. The CLI avoids JSON escaping, keeps commands short, and prints compact output by default.

Use the HTTP API directly only when you are writing code, tests, scripts, or an integration against Browser Relay, or when the CLI is unavailable. Use --json only when you need the full API response.

browser-relay tabs
browser-relay console --tab <tabId> --limit 50
browser-relay network --tab <tabId> --type response --status 500 --limit 20
browser-relay snapshot --tab <tabId> --max-length 20000
browser-relay click 'button[type=submit]' --tab <tabId>
browser-relay type 'hello world' --selector 'input[name=q]' --clear --submit --tab <tabId>
browser-relay key Control+L --tab <tabId>
browser-relay scroll down --amount 1000 --tab <tabId>
browser-relay download-start https://example.com/file.pdf --filename files/file.pdf
browser-relay downloads --limit 20
browser-relay screenshot /tmp/page.png --full-page --tab <tabId>
browser-relay eval 'document.title' --tab <tabId>

For maintenance, upgrade Browser Relay with:

browser-relay update

For long text or JavaScript, avoid shell escaping with stdin:

printf '%s' "$TEXT" | browser-relay type --selector textarea --stdin --tab <tabId>
browser-relay eval --stdin --tab <tabId> < script.js

HTTP API Reference

The HTTP API below is for code, tests, custom tools, and low-level debugging. For interactive agent work, prefer the CLI workflow above.

Errors are structured across HTTP, CLI --json, and MCP tool errors:

{ "ok": false, "code": "invalid_request", "error": "url is required", "message": "url is required", "status": 400, "retryable": false }

Agents should branch on code rather than matching localized/free-form error text. retryable: true means a reconnect/retry is reasonable.

1. browser_tabs

List all attached browser tabs.

GET http://127.0.0.1:18795/api/tabs

Returns: { ok: true, tabs: [{ id, sessionId, title, url }] }

2. browser_navigate

Navigate a tab to a URL.

POST http://127.0.0.1:18795/api/navigate
Header: Content-Type: application/json
Body: { "url": "https://example.com", "tabId?": "optional-target-id" }

2b. browser_console

Read captured console, page error, and browser log entries.

GET http://127.0.0.1:18795/api/console?tabId=<id>&limit=100&level=error&clear=false
POST http://127.0.0.1:18795/api/console/clear
Body: { "tabId?": "...", "level?": "error" }

Use this after actions that may trigger frontend errors or warnings.

2c. browser_network

Read captured request/response/finished/failed network events. Sensitive headers such as Authorization, Cookie, Proxy-Authorization, and Set-Cookie are redacted; request bodies are not captured.

GET http://127.0.0.1:18795/api/network?tabId=<id>&type=response&status=500&limit=100&clear=false
POST http://127.0.0.1:18795/api/network/clear
Body: { "tabId?": "...", "type?": "request|response|finished|failed", "method?": "GET", "status?": 500, "requestId?": "...", "url?": "substring" }

Use this after actions that fail silently, after form submits, or when console errors imply an API request failed.

3. browser_snapshot

Get a text representation of the current page (interactive elements annotated).

GET http://127.0.0.1:18795/api/snapshot?tabId=<id>&format=text&maxLength=100000

Format can be "text" (annotated DOM) or "html" (raw HTML).

4. browser_click

Click an element by CSS selector. Scrolls into view first, uses real mouse events.

POST http://127.0.0.1:18795/api/click
Body: { "selector": "button.submit", "tabId?": "...", "doubleClick?": false }

5. browser_type

Type text into an input field. Optionally clear and submit.

POST http://127.0.0.1:18795/api/type
Body: {
  "text": "hello world",
  "selector?": "input[name='q']",
  "clear?": true,
  "submit?": true,
  "tabId?": "..."
}

6. browser_scroll

Scroll the page.

POST http://127.0.0.1:18795/api/scroll
Body: { "direction": "down|up|top|bottom", "amount?": 800, "tabId?": "..." }

7. browser_key

Press a key or keyboard shortcut using real keyboard events.

POST http://127.0.0.1:18795/api/key
Body: { "key?": "Enter", "combo?": "Control+L", "tabId?": "..." }

Use combo for shortcuts (Control+L, Meta+K, Shift+Tab) and key for single keys (Enter, Escape, ArrowDown, a).

8. browser_screenshot

Capture a PNG screenshot (base64).

POST/GET http://127.0.0.1:18795/api/screenshot?tabId=<id>&fullPage=true

Full-page captures use layout metrics plus a clipped screenshot when possible, then fall back to Chrome's captureBeyondViewport path. Returns: { ok: true, data: "base64...", format: "png", fullPage, strategy, width?, height?, bytes }

9. browser_eval

Evaluate arbitrary JavaScript in the page. The escape hatch.

POST http://127.0.0.1:18795/api/eval
Body: { "expression": "document.querySelector('h1').innerText", "tabId?": "..." }

10. browser_download

Get the URL of an image/media/link element.

POST http://127.0.0.1:18795/api/download
Body: { "selector": "img.profile-pic", "tabId?": "..." }

10. browser_download_start

Start a real Chrome download from a URL using the user's browser profile.

POST http://127.0.0.1:18795/api/download/start
Body: {
  "url": "https://example.com/file.pdf",
  "filename?": "files/file.pdf",
  "saveAs?": false,
  "conflictAction?": "uniquify|overwrite|prompt"
}

Returns: { ok: true, downloadId, id, options }

11. browser_downloads

List Chrome downloads plus recent Browser Relay download events.

GET http://127.0.0.1:18795/api/downloads?limit=20&state=complete
POST http://127.0.0.1:18795/api/downloads/clear

Use this after browser_download_start to verify completion or diagnose interruptions.

Real downloads require the extension's downloads permission. If Browser Relay was already loaded in Chrome before this capability was installed, reload the unpacked extension in chrome://extensions.

Agent Decision Workflow

When asked to do something with a web page:

browser-relay tabs first — discover available tabs and their URLs
browser-relay navigate if needed — go to the target page
browser-relay snapshot — understand the page structure
Plan actions based on snapshot (click what, type where)
Execute (browser-relay click, browser-relay type, browser-relay key, browser-relay scroll) one at a time
browser-relay console if the page behaves unexpectedly or after risky actions
browser-relay network if a request fails, hangs, or the UI changes without visible errors
Re-snapshot after each action to verify state
Use browser-relay download-start and browser-relay downloads for real file downloads
Screenshot if visual confirmation is needed

Example Session

# 1. List tabs
browser-relay tabs
# ABC123    Google    https://google.com

# 2. Take snapshot to see the page
browser-relay snapshot --tab ABC123
# [input type=text name=q placeholder="Search Google"]
# [button "Google Search"]

# 3. Type into the search box
browser-relay type 'browser relay' --selector 'input[name=q]' --submit --tab ABC123

# 4. New snapshot after navigation
browser-relay snapshot --tab ABC123

# 5. Click a result
browser-relay click 'a[href*="github.com"]' --tab ABC123

MCP Registration (Claude Desktop / Cursor / Windsurf)

Add to your MCP config (~/.claude/mcp.json or equivalent):

{
  "mcpServers": {
    "browser": {
      "command": "browser-relay-mcp",
      "env": {
        "BROWSER_RELAY_URL": "http://127.0.0.1:18795"
      }
    }
  }
}

Error Patterns

Error	Meaning	Fix
Extension not connected	Relay server is running but no browser extension connected	Check that Chrome is running with the Browser Relay extension installed
No attached tabs	Extension connected but no tab is attached	The extension auto-attaches all regular tabs. Make sure at least one non-chrome:// tab is open
Element not found: selector	The CSS selector did not match anything on the page	Try a different selector, or take a snapshot first to inspect the DOM
Session with given id not found (-32001)	The relay holds stale session state (e.g. after an extension reload)	Run `browser-relay fix` — restarts the relay and clears stale sessions; the extension reconnects automatically

Health Check

curl http://127.0.0.1:18795/
# → OK

curl http://127.0.0.1:18795/api/debug
# → { "version": "<package-version>", "connected": true/false, "tabCount": N }

reliefeai/browser-relay

O que é browser-relay?

Perguntar na sua IA favorita

Documentação