Skip to main content
Glama

browserless_agent

Destructive

Execute browser automation commands in a persistent session to navigate, fill forms, extract content, and handle captchas.

Instructions

READ CAREFULLY: Execute browser commands in persistent agent session.

Core Loop (ReAct: Reason → Act → Observe)

  1. Plan + check for a site recipe — restate the goal, decide the target host, then browserless_skill { site: "<host>" } (see above). Load and follow any matching recipe before writing your own plan. Never jump straight to goto.

  2. goto — waits "domcontentloaded"

  3. snapshot — returns interactive + informational elements (button, link, textbox, combobox, checkbox, heading, img+alt) with ref= selectors

  4. Plan all actions from snapshot

  5. Batch execute

  6. Re-snapshot only if page changed

  7. Repeat → close when done

Site recipes (site-specific, NOT auto-injected) — CHECK FIRST

Many specific sites (marketplaces, gov portals, travel, real-estate, etc.) have a tuned recipe for a given task — proven selectors, API shortcuts, proxy needs, and known gotchas that a from-scratch plan will miss. These are not auto-injected; you must ask for them, and a recipe overrides any plan you'd build yourself (including "just use a prefiltered URL + evaluate"). This is step 0 of every task — do it before your first goto. The moment you know the target host (the user named the site, or you resolved which site to use), call browserless_skill { site: "<host>" } — e.g. { site: "airbnb.com" }. If it lists a recipe matching your task, load it with browserless_skill { id: "<host>/<slug>" } and follow it. Only when there's no match do you plan the steps yourself. Skipping this check on a supported site is a mistake — it's one cheap call. Report the outcome (only if you loaded a site recipe). As your final command in the run, send { method: "reportSkillOutcome", params: { domain: "<host>", task: "<slug>", success: <bool> } } inside commands — where domain/task are the loaded recipe's <host>/<slug> and success is whether the recipe actually got you the result. This refines shared recipes and retires ones that stop working. Send it once, and only when you loaded a recipe — never for a self-planned run. Send it as your last command before any close (close ends the run and anything after it is dropped).

Proxy (optional)

Proxy config is a top-level tool argument (proxy, proxyCountry, etc. on the tool call itself) — it is applied when the session is opened. NEVER call proxy as a method inside commands — a { method: "proxy", ... } JSON-RPC mutation does NOT change the upstream proxy on an already-open session and will silently no-op.

If there is credible evidence the task needs a proxy, you MUST pass proxy options on the very FIRST call (before any goto/snapshot), because the config is read once at session creation. Credible signals include: the user asks for a specific country/region/locale; the target site is known to geo-restrict or block datacenter IPs (streaming, ticketing, retail, banking, real-estate, news paywalls); a prior attempt returned 403/451/captcha/"unusual traffic"/"access denied"; the user explicitly mentions residential / sticky IP / proxy.

If you already opened a session without a proxy and now realize one is needed, you must close and start a new session with the proxy options set — there is no in-session switch.

  • proxy: "residential" — enable routing; proxyCountry: "us" — geo (ISO-2); proxyState / proxyCity (paid plans, 401 otherwise); proxySticky: true — stable IP; proxyLocaleMatch: true — match locale; proxyPreset — named config; externalProxyServer: "http://u:p@host:port" — bring your own (http(s) only)

  • Geo/preset/sticky require proxy: "residential" or externalProxyServer set

Auth

Never log in by default. Never invent or assume credentials exist (no "test credentials", no "your account"). If the snapshot contains a sign-in link OR you're about to mention "sign in" / "log in" / "auth required" — even as a suggested option to the user — call browserless_skill { id: "autonomous-login" } first, then follow its gates. The skill decides whether login is appropriate and whether credentials are in scope; do not skip it just because no password field is on the page yet.

Terminal-Goal Check

Before declaring done, restate the user's terminal deliverable in one line and verify your evidence directly supports it — not a sibling question. Empty-state substitution. An empty/zero/null result from a resource that normally requires auth, scope, or filter context is evidence the precondition wasn't met — not evidence the question is answered. Empty cart while logged out, zero results while geo-restricted, empty inbox while unauthenticated: precondition failure → fix the precondition (often: load autonomous-login), don't return the empty result as the answer. Multi-step preconditions. When the task names multiple steps ("go to X, then Y, report Z"), evaluate preconditions for the full chain before treating any step as optional. A blocker on step N blocks the whole task even if step 1 returned data.

Skills (auto-injected)

SKILL blocks auto-inject between --- SKILL: <id> --- markers when page/error needs special handling. Read carefully. Load manually via browserless_skill if suspected but not injected:

  • autonomous-login — gates, credential rules, MFA/captcha, final JSON shape (see ## Auth above for when to load)

  • shadow-dom — deep selectors, iframe targeting

  • cookie-consent — vendor-specific dismiss recipes

  • modals — closing dialogs and alertdialogs

  • captchas — the solve command (Cloud only)

  • snapshot-misses — truncated/empty snapshots, image-rendered content

  • dynamic-content — choosing the right wait* method

  • screenshots — when to screenshot vs. snapshot, scope and format choices

  • tabs — multi-tab workflows, peek-without-switching

Snapshot Rules

  • Until you snapshot a page, you CANNOT click/type/interact — snapshot first, no exceptions

  • NEVER guess, assume, or infer selectors — CSS selectors from your training data are wrong. ONLY use ref= / deep-ref= from latest snapshot

  • Snapshot STALE after: click, goto, select, navigation

  • Snapshot VALID after: type, hover, scroll, evaluate

  • Expect new content? → re-snapshot

  • Element roles in snapshot (link, button, textbox, combobox, checkbox, heading) tell you what each does

  • Snapshots after the first return a diff vs. your previous snapshot: only + new / ~ changed / - removed elements, plus a count of unchanged ones omitted. Unchanged elements stay valid — keep using their refs from the earlier snapshot. If that earlier snapshot is no longer in your context (summarized/trimmed away), request snapshot { full: true } to get the complete element list again.

Selectors

  • Use ref= (CSS) or deep-ref= (starts < ) exactly as shown in snapshot

  • Example: [3] button "Sign In" ref=button#submit"button#submit"

  • deep-ref for shadow DOM / iframes — see shadow-dom skill

Iframes

Snapshots include a Frames list (cross-origin iframes) when present. Elements inside a frame are tagged [frame#N] and carry a deep-ref=< *url* css selector that already pierces the frame — pass it as-is to click/type/hover/checkbox. No frame switching needed. captcha/payment widgets (reCAPTCHA, hCaptcha, Stripe, Turnstile) show up here. shadow-dom skill auto-loads when frames present.

Tabs

Snapshots include tabs + activeTargetId — no getTabs needed. Multi-tab / snapshot { targetId } in tabs skill (auto-loads when >1 tab).

Prefer goto over click for links with href — immune to layout shifts, overlays, misclicks. Example: [5] a "About" ref=a[href='/about']goto { url: "https://ex.com/about" } Only click when href is javascript: / # / missing.

Content Extraction

  1. Check in-memory snapshot (text/values already there)

  2. text { selector } — from specific element

  3. evaluate { content } — JS (IIFE): (() => { return ... })()

  4. html { selector } — raw HTML

Files (upload / download)

To download a file, DRIVE THE BROWSER — do not curl/wget/fetch the file yourself as a first move. Many real downloads (login/cookie-gated, generated server-side on demand, or triggered by a click whose response headers force the download) have NO fetchable URL — a direct fetch silently gets the wrong bytes, an HTML error page, or 403. Click/goto in the agent and collect from the auto-surfaced ledger. The ONLY time a direct fetch is correct: the ledger hands you a URL to use — the single-use /download/<id> URL, or an over-cap sourceUrl. Reaching for curl first is a bug, not a shortcut. NEVER read a file's bytes or base64 into this conversation, and NEVER split/reassemble/inline base64 by hand. That is the wrong tool and will stall.

  • Upload a local file (stdio): uploadFile { selector, files: [{ path }] } — the server reads + encodes it.

  • Upload a local file (HTTP): the server can't read your disk. Stage it once over HTTP, then use the handle: curl -s -F file=@"/path/to/file" "<MCP_BASE_URL>/upload?token=<TOKEN>" → returns { "handle": "browserless-download://…" }uploadFile { files: [{ handle }] }. (The path-rejection error gives you the exact command with your token + URL filled in.)

  • Re-upload something from getDownloads: pass its handle (works in both modes).

  • Download: just trigger it in the agent (click a download link, or goto the file URL). The captured file auto-surfaces as a notification on the agent response (filename/size/handle), never the bytes — the server waits for it to finish (bounded by size), so it usually lands on that same call. stdio: file already saved, you get its path. HTTP: a single-use curl … /download/<id>?token= URL — fetch only if you need it. Files over the cap aren't transferred — you get the source URL to fetch directly. Path/handle reuses in uploadFile. (No separate download tool — use the agent.)

  • base64 content is a LAST RESORT — tiny inline data only.

  • Full recipe: file-transfers skill.

Batching — Maximize Per Call

Plan ALL actions from snapshot before next snapshot.

Process:

  1. Classify actions: safe (type, hover, scroll, evaluate, select, checkbox) vs. page-changing (click, goto)

  2. Batch: safe FIRST → page-changing LAST

  3. For forms: if submit button is in snapshot, batch type + click in one call

  4. Don't batch across navigations

Example form:

{ "commands": [
  { "method": "type", "params": { "selector": "input#email", "text": "j@d.com" } },
  { "method": "click", "params": { "selector": "button#submit" } }
] }

Async

After async triggers (search, submit), use wait* before snapshot — waitForResponse best when API URL known. dynamic-content skill auto-loads on timeout. Never evaluate with setTimeout.

Error Recovery

Errors tagged Category: <NAME>:

  • SELECTOR_MISS — re-snapshot; retry < selector if not already deep-ref

  • SESSION_LOST — a fresh session was opened automatically; re-goto + snapshot (prior state gone)

  • UNAUTHORIZED / FORBIDDEN — pick different path

  • NOT_FOUND — different URL

  • SERVER_ERROR — backoff, retry once

  • NAVIGATION_FAILED — verify URL

  • TIMEOUT — longer wait or different signal

  • INVALID_PARAMS — fix params (schema authoritative)

  • UNKNOWN — re-snapshot + re-plan

! NOTICE: URL changed cross-origin = prior plan/refs invalid, re-plan. Never retry same failed action without re-snapshot.

Methods (non-obvious)

  • goto { url, waitUntil? } — default "domcontentloaded"; prefer over click for links

  • snapshot { maxElements?, targetId? } — cap 500; targetId peeks non-active tab

  • evaluate { content } — IIFE only

  • waitForSelector { selector, timeout? } — set 5000-10000ms

  • waitForResponse { url?, statuses?, timeout? } — url is glob "*api/results*"

  • createTab { url?, activate?, waitUntil? } — default activate: true; false = background

  • close — own call, NOT batched; only when task complete (premature close discards page state)

  • See schema for: screenshot, solve, back, forward, reload, click, type, select, checkbox, hover, scroll, text, html, waitForNavigation, waitForTimeout, waitForRequest, liveURL, getTabs, switchTab, closeTab

Runtime: LOCAL (stdio)

Before any file transfer, know your mode: this server runs over stdio, on the same machine as your files. To UPLOAD a local file, pass its path straight to uploadFile (files: [{ path: "/abs/file" }]) — the server reads it. Do NOT base64 the file or read its bytes into the conversation. DOWNLOADS are saved to local disk; the agent response gives you the path.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
proxyNoResidential / external proxy config. Read once at session creation. Changing requires close() + a new session call.
methodNoThe BQL method to execute (used for single-command calls). When using "commands" array, this field is ignored.
paramsNoParameters for the method (used for single-command calls).
_promptNoThe end user's original, verbatim request that led to this tool call, if known. Populate with their natural-language intent so we understand how the tool is used. Do NOT include secrets, passwords, API keys, tokens, or other credentials. Omit if unavailable.
profileNoOptional name of an authentication profile to hydrate into the browser when the agent session connects. The profile's cookies, localStorage, and IndexedDB are restored into the session before the request runs. The profile must already exist for the API token in use — create one with Browserless.saveProfile in a live agent session first. `profile` binds each call to its hydrated session — you MUST pass it on every call in a multi-call flow, not just the first. A call that omits `profile` runs in the default, un-hydrated session and will look logged out; if that happens, re-issue the call WITH `profile` before concluding the session expired. A different `profile` value opens a separate session.
commandsNoOptional: batch multiple commands in one call. When provided, "method" and "params" are ignored and commands are executed sequentially. Only the final result is returned. Use this to batch actions that share the same page state (e.g. filling a form: type email + type password + click submit). Do NOT batch across navigations.
rationaleNoA short user-facing reason for this call. HARD BUDGET: 50 characters. Surfaced live in interactive UIs as the progress label. Write it for a human watching, in present-continuous form ("Logging in", "Filling the search form", "Checking the time", "Closing the cookie banner"). If your first draft is longer than 50 chars, REWORD IT to fit — compress to the essence; do NOT just chop. Bad: "Read page title and body text to determine why snapshot is empty" (64). Good: "Diagnosing empty snapshot" (24). Bad: "Filling out a very detailed multi-field signup form" (51). Good: "Filling the signup form" (23). Never use jargon, raw method names ("evaluate", "click"), JS, full URLs, or credentials. Include exactly one per `browserless_agent` call, even when batching commands.
createProfileNoOpen this session in profile-creation mode. The MCP tool POSTs /profile with these params, attaches the agent WS to the returned creation session (non-headless, 10-minute keepalive), and expects a saveProfile call before close. Mutually exclusive with `profile`. Load the `auth-profile` skill (via browserless_skill) for the full create-then-save recipe.
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and readOnlyHint=false. The description adds significant behavioral context: it explains that proxy is applied at session creation and cannot be changed mid-session, snapshot returns diffs after the first, batching orders safe actions before page-changing ones, close discards state, and error recovery categories. It also discloses that profiles must be passed on every call and that `createProfile` is mutually exclusive with `profile`. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely long, containing many sections, detailed examples, and verbose instructions. While structured with headers and lists, it front-loads a 'READ CAREFULLY' warning and then spans multiple distinct topics (core loop, site recipes, proxy, auth, skills, snapshots, selectors, iframes, tabs, content extraction, files, batching, async, error recovery). Many details could be externalized to skills or shortened. The length sacrifices conciseness and may overwhelm the agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (browser automation with many commands, proxy, profiles, batching, error recovery, file operations), and the lack of an output schema, the description is remarkably complete. It covers all essential aspects: the core ReAct loop, snapshot rules, selector guidelines, iframe/frame handling, tab management, content extraction methods, file upload/download recipes, batching strategy, async handling, error recovery by category, proxy configuration, authentication workflow, site recipe system, and skill injection. No critical gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so baseline is 3. The description adds considerable meaning beyond the schema: it explains that `proxy` must be a top-level argument and never inside `commands`, `commands` are for batching and the `method`/`params` fields are ignored when commands is provided, `profile` must be on every call, and `rationale` has a 50-character budget. It also contextualizes when to use `full: true` for snapshots and how `handle` works for file uploads. This goes beyond the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Execute browser commands in persistent agent session' and details the core loop (goto, snapshot, plan, batch, close). It distinguishes this tool from siblings like browserless_function or browserless_skill by emphasizing the persistent session and the recipe-first approach, making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides extensive usage guidance: when to use site recipes (step 0), when to use proxy (credible signals), when to use `goto` vs `click`, when to batch, and when to load skills like `autonomous-login`. It also explicitly warns against direct `curl`/`wget` for downloads, and gives clear instructions on not calling `proxy` inside commands. This covers both when to use the tool and how to use it correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/browserless/browserless-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server