Skip to content

MCP Tool Reference

The Vibium MCP server exposes 92 tools. This page lists each one with its parameters, as reported by the server’s own tools/list. The raw schemas are published as /mcp-tools.json.

Tools marked (nightly) are not in the latest release (26.11.16); see What’s in Nightly. To register the server, see Client Setup.

ToolWhat it does
vibium_runAccomplish a goal in the current local browser session using configured AI provider and constrained browser tools
vibium_checkIndependently verify an explicit claim against the current local Chrome/Firefox session, or a read-only recording zip
vibium_saySpeak text into the target
vibium_listenListen to the target and return what was said
browser_startStart a browser session
browser_navigateNavigate to a URL in the browser
browser_clickClick an element by CSS selector
browser_typeType text into an element by CSS selector, or, with no selector, into whatever has focus
browser_screenshotCapture a screenshot of the current page
browser_findFind one element and register it as an @eN ref for later tools
browser_find_allFind every element matching a description, reference image, or locator, each registered as an @eN ref
browser_evaluateExecute JavaScript in the browser to extract data, query the DOM, or inspect page state
browser_stopStop the browser session
browser_get_htmlGet the HTML content of the page or a specific element
browser_waitWait for an element to reach a specified state (attached, visible, or hidden)
browser_new_pageOpen a new browser page, optionally navigating to a URL
browser_list_pagesList all open browser pages with their URLs
browser_switch_pageSwitch to a browser page by index or URL substring
browser_close_pageClose a browser page by id or index (default: current page)
browser_hoverHover over an element by CSS selector
browser_selectSelect an option in a
browser_scrollScroll the page or a specific element
browser_keysPress a key or key combination (e.g., “Enter”, “Control+a”, “Shift+Tab”)
browser_get_textGet the text content of the page or a specific element
browser_get_urlGet the current page URL
browser_get_titleGet the current page title
browser_a11y_treeGet the accessibility tree of the current page
page_clock_installInstall a fake clock on the page, overriding Date, setTimeout, setInterval, requestAnimationFrame, and performance.now
page_clock_fast_forwardJump the fake clock forward by N milliseconds, firing each due timer at most once
page_clock_run_forAdvance the fake clock by N milliseconds, firing all time-related callbacks systematically
page_clock_pause_atJump the fake clock to a specific time and pause — no timers fire until resumed or advanced
page_clock_resumeResume real-time progression from the current fake clock time
page_clock_set_fixed_timeFreeze Date.now() at a specific value permanently
page_clock_set_system_timeSet Date.now() to a specific value without triggering any timers
page_clock_set_timezoneOverride the browser timezone
browser_fillClear an input field and type new text
browser_pressPress a key or key combination on a specific element or the focused element
browser_backNavigate back in browser history (like clicking the back button)
browser_forwardNavigate forward in browser history (like clicking the forward button)
browser_reloadReload the current page
browser_get_valueGet the current value of an input, textarea, or select element
browser_get_attributeGet the value of an HTML attribute on an element
browser_is_visibleCheck if an element is visible on the page
browser_setSet checkbox/radio selection
browser_unsetUncheck a checkbox
browser_scroll_into_viewScroll an element into view, centering it on screen
browser_wait_for_urlWait until the page URL contains a given substring
browser_wait_for_loadWait until the page reaches the “complete” ready state (all resources loaded)
browser_sleepPause execution for a specified number of milliseconds
browser_mapMap interactive page elements with @refs for targeting
browser_diff_mapCompare current page state vs last map
browser_pdfSave the current page as a PDF file
browser_highlightHighlight an element with a red outline for 3 seconds
browser_dblclickDouble-click an element by CSS selector or @ref
browser_focusFocus an element by CSS selector or @ref
browser_countCount the number of elements matching a CSS selector
browser_is_enabledCheck if an element is enabled (not disabled)
browser_is_setCheck if a checkbox or radio button is checked
browser_wait_for_textWait until specific text appears on the page
browser_wait_for_fnWait until a JavaScript expression returns a truthy value
browser_dialog_acceptAccept a dialog (alert, confirm, prompt)
browser_dialog_dismissDismiss a dialog (cancel/close)
browser_get_cookiesList all cookies for the current page
browser_set_cookieSet a cookie
browser_delete_cookiesDelete cookies
browser_mouse_moveMove the mouse to specific coordinates
browser_mouse_downPress a mouse button down at the current position
browser_mouse_upRelease a mouse button at the current position
browser_mouse_clickClick at coordinates or at the current mouse position
browser_tapTap a touch pointer at coordinates, or on an element given as a selector or @ref (for touchscreen devices and phones)
browser_swipeSwipe a touch pointer, finger held down for the move (for touchscreen devices and phones)
browser_long_pressPress and hold a touch pointer at coordinates (for touchscreen devices and phones)
browser_dragDrag from one element to another
browser_set_viewportSet the browser viewport size
browser_get_viewportGet the current viewport dimensions
browser_get_windowGet the OS browser window dimensions and state
browser_set_windowSet the OS browser window size, position, or state
browser_emulate_mediaOverride CSS media features (color scheme, reduced motion, etc.)
browser_set_geolocationOverride the browser geolocation
browser_set_contentReplace the page HTML content
browser_framesList all child frames (iframes) on the current page
browser_frameFind a frame by name (exact match) or URL (substring match)
browser_uploadSet files on an input[type=file] element
browser_record_startStart a browser recording (screenshots and/or HTML snapshots)
browser_record_stopStop recording and save to a Playwright-compatible trace ZIP file (with the video track when one was recorded)
browser_record_start_groupStart a named group in the recording (groups nest actions in the trace viewer)
browser_record_stop_groupEnd the current recording group
browser_record_start_chunkStart a new chunk within the current recording (for splitting long recordings)
browser_record_stop_chunkPackage the current recording chunk into a ZIP file (recording remains active)
browser_storage_stateExport cookies, localStorage, and sessionStorage as JSON
browser_restore_storageRestore cookies and storage from a JSON state file
browser_download_set_dirSet the download directory for the browser

Accomplish a goal in the current local browser session using configured AI provider and constrained browser tools. Returns completed or not_completed with evidence. Live only; uses VIBIUM_AI_* configuration.

ParameterTypeRequiredDescription
aiBaseURLstringnoPer-call override for the AI provider’s API base URL (the model endpoint, not the site under test). Changing provider clears it. Credentials come from the runtime environment.
baseURLstringnoSite under test: opened first unless the current page already shares its origin, and relative browser_navigate paths resolve against it. Not the AI provider endpoint; that is aiBaseURL.
goalstringyes
modelstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
providerstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.
reasoningEffortstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.

Independently verify an explicit claim against the current local Chrome/Firefox session, or a read-only recording zip. Returns passed, failed, or inconclusive with evidence. Recorded mode never launches a browser. Uses shared AI configuration from the server environment.

ParameterTypeRequiredDescription
aiBaseURLstringnoPer-call override for the AI provider’s API base URL (the model endpoint, not the site under test). Changing provider clears it. Credentials come from the runtime environment.
baseURLstringnoSite under test: opened first unless the current page already shares its origin, and relative browser_navigate paths resolve against it. Not the AI provider endpoint; that is aiBaseURL.
claimstringyes
modelstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
providerstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.
reasoningEffortstringnoPer-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment.
recordstringnoOptional path to an existing version 8 Vibium record.zip or Playwright trace.zip on this host; selects archive mode instead of the live browser.

Speak text into the target. The default is the current session: the phone on a Roadie, or the page’s microphone in a browser. With no session open it is this machine’s speakers. Returns when playback ends.

ParameterTypeRequiredDescription
cachebooleannofalse renders again instead of replaying cached audio
cacheDirstringnoWhere rendered audio is kept
filestringnoA WAV file to play as it is, in place of text
languagestringno
modelstringno
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
providerstringnoText-to-speech provider or preset; the default comes from the server environment
speednumberno
targetstringnosession, local, or a path ending in .wav
textstringnoWhat to say. Give text or file
voicestringno

Listen to the target and return what was said. The default is the current session: what the phone or the page plays. With no session open it is this machine’s microphone. Hears from the end of the last vibium_say, so a reply that began before this call is not missed. Stops after trailing silence.

ParameterTypeRequiredDescription
allowSilencebooleannoReturn an empty transcript instead of an error when nothing is heard
durationnumbernoMaximum capture length from this call, in ms (default 30000)
languagestringno
modelstringno
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
pathstringnoAlso save the captured audio as a WAV file
providerstringnoSpeech-to-text provider or preset; the default comes from the server environment
silencenumbernoTrailing silence that ends the reply, in ms (default 1000). 0 turns endpointing off
targetstringnosession, local, or a path ending in .wav
timeoutnumbernoHow long to wait for speech to start, from this call, in ms (default 10000)
transcribebooleannofalse captures without a transcript; speech onset and reply latency are still measured

Start a browser session

ParameterTypeRequiredDescription
channelstring: beta, canary, dev, release, stablenoRelease channel of the selected engine; chrome: stable (default), beta, dev, canary; firefox: release (default), beta
enginestring: chrome, firefoxnoBrowser engine to launch
headlessbooleannoRun browser in headless mode (no visible window)
userDataDirstringnoPersistent browser profile directory, created if missing and reused across sessions (cookies, logins survive); omit for a temporary profile wiped on close

Navigate to a URL in the browser

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
urlstringyesThe URL to navigate to

Click an element by CSS selector. Waits for element to be visible, stable, and enabled.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element to click
timeoutnumbernoTimeout in milliseconds (default: 30000)

Type text into an element by CSS selector, or, with no selector, into whatever has focus. With a selector, waits for the element to be visible, stable, enabled, and editable.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector for the element to type into. Omit it to type into the focused element, or on a device with no DOM.
textstringyesThe text to type
timeoutnumbernoTimeout in milliseconds (default: 30000)

Capture a screenshot of the current page

ParameterTypeRequiredDescription
annotatebooleannoAnnotate interactive elements with numbered labels (default: false)
filenamestringnoOptional filename to save the screenshot (e.g., screenshot.png)
fullPagebooleannoCapture the full page (entire document) instead of just the viewport (default: false)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Find one element and register it as an @eN ref for later tools. Give a natural-language description, a reference image, or an exact locator: css (a CSS selector), tag, or a semantic locator (role, text, label, placeholder, testid, xpath, alt, title); role combines with text and the others. A description is matched against the page’s names and roles first; when that is not enough and an AI provider is configured, the screenshot goes to a vision model. An image is matched locally first and only then, if a provider is configured, sent to the model with the screenshot. Explicit locators never call a model.

ParameterTypeRequiredDescription
aiBaseURLstringnoAI provider base URL override for this call
altstringnoFind element by alt attribute
cssstringnoCSS selector; exact, never sent to a model. Next to a semantic locator it restricts the candidates
descriptionstringnoNatural-language description of the element, e.g. “the Add to Cart button”. Stands alone.
detailsbooleannoInclude diagnostics: method, whether a model was called, provider and model, raw scores
imagestringnoReference image as base64 PNG or JPEG (a data: URL is accepted), up to 4 MB. Stands alone. Matched locally; see strategy.
labelstringnoFind input by associated label text or aria-label
modelstringnoModel override for this call; a vision-capable model
namestringnoAccessible name filter: the text, label, alt, or aria-label a person would read the element by
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
placeholderstringnoFind element by placeholder attribute
providerstringnoAI provider override for this call (same as vibium_check)
reasoningEffortstringnoReasoning effort override for this call
rolestringnoARIA role to match (e.g., “button”, “link”, “textbox”, “heading”, “checkbox”)
selectorstringnoSame as css
strategystring: auto, cv, vlm, treenoauto (default): local evidence first, a vision model only when needed and configured. cv: local image matching only, nothing leaves the machine. vlm: vision model only; needs a configured provider. tree: the page’s DOM/accessibility tree only
tagstringnoHTML tag name, e.g. “h1”
testidstringnoFind element by data-testid attribute
textstringnoFind element containing this text
timeoutnumbernoTimeout in milliseconds (default: 30000)
titlestringnoFind element by title attribute
xpathstringnoFind element by XPath expression

Find every element matching a description, reference image, or locator, each registered as an @eN ref. Returns an empty list when nothing matches.

ParameterTypeRequiredDescription
aiBaseURLstringnoAI provider base URL override for this call
altstringnoFind element by alt attribute
cssstringnoCSS selector; exact, never sent to a model. Next to a semantic locator it restricts the candidates
descriptionstringnoNatural-language description of the element, e.g. “the Add to Cart button”. Stands alone.
detailsbooleannoInclude diagnostics: method, whether a model was called, provider and model, raw scores
imagestringnoReference image as base64 PNG or JPEG (a data: URL is accepted), up to 4 MB. Stands alone. Matched locally; see strategy.
labelstringnoFind input by associated label text or aria-label
limitnumbernoMaximum number of elements to return (default: 10)
modelstringnoModel override for this call; a vision-capable model
namestringnoAccessible name filter: the text, label, alt, or aria-label a person would read the element by
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
placeholderstringnoFind element by placeholder attribute
providerstringnoAI provider override for this call (same as vibium_check)
reasoningEffortstringnoReasoning effort override for this call
rolestringnoARIA role to match (e.g., “button”, “link”, “textbox”, “heading”, “checkbox”)
selectorstringnoSame as css
strategystring: auto, cv, vlm, treenoauto (default): local evidence first, a vision model only when needed and configured. cv: local image matching only, nothing leaves the machine. vlm: vision model only; needs a configured provider. tree: the page’s DOM/accessibility tree only
tagstringnoHTML tag name, e.g. “h1”
testidstringnoFind element by data-testid attribute
textstringnoFind element containing this text
timeoutnumbernoTimeout in milliseconds (default: 30000)
titlestringnoFind element by title attribute
xpathstringnoFind element by XPath expression

Execute JavaScript in the browser to extract data, query the DOM, or inspect page state. Returns the evaluated result. Use this to get text content, attributes, element data, or any information from the page.

ParameterTypeRequiredDescription
expressionstringyesJavaScript expression to evaluate
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Stop the browser session

No parameters.

Get the HTML content of the page or a specific element

ParameterTypeRequiredDescription
outerbooleannoReturn outerHTML instead of innerHTML (default: false)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector for a specific element (optional, defaults to full page HTML)

Wait for an element to reach a specified state (attached, visible, or hidden)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element to wait for
statestring: attached, visible, hiddennoState to wait for: “attached” (exists in DOM), “visible” (visible on page), or “hidden” (not found or not visible)
timeoutnumbernoTimeout in milliseconds (default: 30000)

Open a new browser page, optionally navigating to a URL

ParameterTypeRequiredDescription
isolatedbooleannoOpen the page in its own isolated context with separate cookies and storage (default: false). Concurrent callers sharing this server should open an isolated page and pass its id as the page argument on every call.
urlstringnoURL to navigate to in the new page (optional)

List all open browser pages with their URLs

No parameters.

Switch to a browser page by index or URL substring

ParameterTypeRequiredDescription
indexnumbernoPage index (0-based) from browser_list_pages
urlstringnoURL substring to match (alternative to index)

Close a browser page by id or index (default: current page)

ParameterTypeRequiredDescription
indexnumbernoPage index to close (default: 0, the current page); ignored when a page id is given
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Hover over an element by CSS selector

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element to hover over
timeoutnumbernoTimeout in milliseconds (default: 30000)

Select an option in a element timeout number no Timeout in milliseconds (default: 30000) value string yes The value to select

Scroll the page or a specific element

ParameterTypeRequiredDescription
amountnumbernoNumber of scroll increments (default: 3)
directionstring: up, down, left, rightnoScroll direction: up, down, left, right (default: down)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector for the element to scroll within (optional; without it the page scrolls at the viewport center)

Press a key or key combination (e.g., “Enter”, “Control+a”, “Shift+Tab”)

ParameterTypeRequiredDescription
keysstringyesKey or key combination to press (e.g., “Enter”, “Control+a”, “Shift+ArrowDown”)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Get the text content of the page or a specific element

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector for a specific element (optional, defaults to full page text)

Get the current page URL

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Get the current page title

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Get the accessibility tree of the current page. Returns a tree of ARIA roles, names, and states — useful for understanding page structure without visual rendering.

ParameterTypeRequiredDescription
everythingbooleannoShow all nodes including generic containers. Default: false
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Install a fake clock on the page, overriding Date, setTimeout, setInterval, requestAnimationFrame, and performance.now

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timenumbernoInitial time as epoch milliseconds (optional)
timezonestringnoIANA timezone ID to override (e.g. ‘America/New_York’, ‘Europe/London’)

Jump the fake clock forward by N milliseconds, firing each due timer at most once

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
ticksnumberyesNumber of milliseconds to fast-forward

Advance the fake clock by N milliseconds, firing all time-related callbacks systematically

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
ticksnumberyesNumber of milliseconds to advance

Jump the fake clock to a specific time and pause — no timers fire until resumed or advanced

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timenumberyesTime as epoch milliseconds to pause at

Resume real-time progression from the current fake clock time

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Freeze Date.now() at a specific value permanently. Timers still run.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timenumberyesTime as epoch milliseconds to freeze at

Set Date.now() to a specific value without triggering any timers

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timenumberyesTime as epoch milliseconds to set

Override the browser timezone. Pass an IANA timezone ID (e.g. ‘America/New_York’), or empty string to reset to system default

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timezonestringyesIANA timezone ID (e.g. ‘America/New_York’, ‘Europe/London’, ‘Asia/Tokyo’). Empty string resets to system default.

Clear an input field and type new text. Waits for element to be editable, clears existing value, then types. Use this instead of browser_type when you want to replace the field contents.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the input element
textstringyesThe text to fill in
timeoutnumbernoTimeout in milliseconds (default: 30000)

Press a key or key combination on a specific element or the focused element. If selector is given, clicks the element first to focus it, then presses the key.

ParameterTypeRequiredDescription
keystringyesKey or key combination to press (e.g., “Enter”, “Control+a”, “Escape”)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector for the element to focus before pressing (optional, defaults to currently focused element)

Navigate back in browser history (like clicking the back button)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Navigate forward in browser history (like clicking the forward button)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Reload the current page. Waits for the page to fully load.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Get the current value of an input, textarea, or select element

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the form element

Get the value of an HTML attribute on an element

ParameterTypeRequiredDescription
attributestringyesAttribute name to retrieve (e.g., “href”, “src”, “class”, “data-id”)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element

Check if an element is visible on the page. Returns true/false without throwing errors.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element

Set checkbox/radio selection. Defaults to true; false clears a checkbox. Idempotent.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the checkbox or radio button
timeoutnumbernoTimeout in milliseconds (default: 30000)
valuebooleannoDesired selection state; false clears a checkbox

Uncheck a checkbox. Idempotent — does nothing if already unchecked.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the checkbox
timeoutnumbernoTimeout in milliseconds (default: 30000)

Scroll an element into view, centering it on screen

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the element to scroll into view
timeoutnumbernoTimeout in milliseconds (default: 30000)

Wait until the page URL contains a given substring

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
patternstringyesSubstring to match in the URL
timeoutnumbernoTimeout in milliseconds (default: 30000)

Wait until the page reaches the “complete” ready state (all resources loaded)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timeoutnumbernoTimeout in milliseconds (default: 30000)

Pause execution for a specified number of milliseconds. Use sparingly — prefer browser_wait or browser_wait_for_url when possible.

ParameterTypeRequiredDescription
msnumberyesNumber of milliseconds to sleep (max 30000)

Map interactive page elements with @refs for targeting. Returns a list of interactive elements (buttons, links, inputs, etc.) each with a short @ref like @e1, @e2. Use these refs as selectors in other commands (click, fill, etc.).

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector to scope element discovery to a subtree (e.g. “nav”, “#sidebar”)

Compare current page state vs last map. Shows additions (+) and removals (-) since the last browser_map call.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Save the current page as a PDF file

ParameterTypeRequiredDescription
backgroundbooleannoPrint background graphics (default: false)
filenamestringnoOutput filename for the PDF (e.g., page.pdf)
landscapebooleannoLandscape orientation (default: portrait)
marginBottomnumbernoBottom margin in cm (default: 1)
marginLeftnumbernoLeft margin in cm (default: 1)
marginRightnumbernoRight margin in cm (default: 1)
marginTopnumbernoTop margin in cm (default: 1)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
pageHeightnumbernoPage height in cm (default: 27.94)
pageRangesarray of string or integernoPages to print, e.g. [1, “3-5”] (default: all)
pageWidthnumbernoPage width in cm (default: 21.59)
scalenumbernoPrint scale, 0.1-2 (default: 1)
shrinkToFitbooleannoShrink content to fit the page width (default: true)

Highlight an element with a red outline for 3 seconds. Useful for visual debugging.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector or @ref for the element to highlight

Double-click an element by CSS selector or @ref

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector or @ref for the element to double-click
timeoutnumbernoTimeout in milliseconds (default: 30000)

Focus an element by CSS selector or @ref

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector or @ref for the element to focus
timeoutnumbernoTimeout in milliseconds (default: 30000)

Count the number of elements matching a CSS selector

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector to count matches for

Check if an element is enabled (not disabled). Returns true/false.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector or @ref for the element

Check if a checkbox or radio button is checked. Returns true/false.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector or @ref for the checkbox/radio element

Wait until specific text appears on the page

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
textstringyesText to wait for on the page
timeoutnumbernoTimeout in milliseconds (default: 30000)

Wait until a JavaScript expression returns a truthy value

ParameterTypeRequiredDescription
expressionstringyesJavaScript expression to evaluate (e.g., “window.ready === true”)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
timeoutnumbernoTimeout in milliseconds (default: 30000)

Accept a dialog (alert, confirm, prompt). Optionally provide text for prompt dialogs.

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
textstringnoText to enter in the prompt dialog (optional)

Dismiss a dialog (cancel/close)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

List all cookies for the current page

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Set a cookie

ParameterTypeRequiredDescription
domainstringnoCookie domain (optional, defaults to current page domain)
namestringyesCookie name
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
pathstringnoCookie path (optional, defaults to /)
valuestringyesCookie value

Delete cookies. If name is given, deletes that cookie. Otherwise deletes all cookies.

ParameterTypeRequiredDescription
namestringnoCookie name to delete (optional, omit to delete all)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Move the mouse to specific coordinates

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
xnumberyesX coordinate
ynumberyesY coordinate

Press a mouse button down at the current position

ParameterTypeRequiredDescription
buttonnumbernoMouse button (0=left, 1=middle, 2=right). Default: 0
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Release a mouse button at the current position

ParameterTypeRequiredDescription
buttonnumbernoMouse button (0=left, 1=middle, 2=right). Default: 0
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Click at coordinates or at the current mouse position. If x and y are provided, moves the mouse there first.

ParameterTypeRequiredDescription
buttonnumbernoMouse button (0=left, 1=middle, 2=right). Default: 0
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
xnumbernoX coordinate to click at
ynumbernoY coordinate to click at

Tap a touch pointer at coordinates, or on an element given as a selector or @ref (for touchscreen devices and phones)

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringnoCSS selector or @ref to tap at its center, instead of x and y
xnumbernoX coordinate to tap at
ynumbernoY coordinate to tap at

Swipe a touch pointer, finger held down for the move (for touchscreen devices and phones). Give a direction, or x1, y1, x2, y2. A direction swipe starts at the viewport center, or at an edge with from, and moves half the viewport unless distance says otherwise. On a phone through Roadie, from: bottom with direction: up goes home, from: top with direction: down opens Notification Center or the notification shade, and from: top-right with direction: down opens Control Center on an iPhone

ParameterTypeRequiredDescription
directionstring: up, down, left, rightnoWhich way the finger moves. Instead of x1, y1, x2, y2
distancenumbernoHow far a direction swipe moves, in pixels (default: half the viewport)
durationnumbernoHow long the move takes in milliseconds (default: 300)
fromstring: top, bottom, left, right, top-left, top-right, bottom-left, bottom-right, centernoWhere a direction swipe starts: an edge or corner of the viewport, or its center (default)
fromXnumbernoX coordinate a direction swipe starts at, with fromY. Instead of from
fromYnumbernoY coordinate a direction swipe starts at, with fromX
holdnumbernoMilliseconds the finger rests at the end before lifting (a slow swipe up from the bottom with a hold opens the app switcher)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
speedstring or numbernoslow, normal, fast, or pixels per second. Instead of duration
x1numbernoX coordinate to start from
x2numbernoX coordinate to end at
y1numbernoY coordinate to start from
y2numbernoY coordinate to end at

Press and hold a touch pointer at coordinates (for touchscreen devices and phones)

ParameterTypeRequiredDescription
durationnumbernoHow long to hold the press in milliseconds (default: 500)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
xnumberyesX coordinate to press at
ynumberyesY coordinate to press at

Drag from one element to another

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
sourcestringyesCSS selector or @ref for the source element
targetstringyesCSS selector or @ref for the target element
timeoutnumbernoTimeout in milliseconds (default: 30000)

Set the browser viewport size

ParameterTypeRequiredDescription
devicePixelRationumbernoDevice pixel ratio (optional, e.g., 2 for Retina)
heightnumberyesViewport height in pixels
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
widthnumberyesViewport width in pixels

Get the current viewport dimensions

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Get the OS browser window dimensions and state

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Set the OS browser window size, position, or state

ParameterTypeRequiredDescription
heightnumbernoWindow height in pixels
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
statestring: normal, maximized, minimized, fullscreennoWindow state: normal, maximized, minimized, or fullscreen
widthnumbernoWindow width in pixels
xnumbernoWindow x position in pixels
ynumbernoWindow y position in pixels

Override CSS media features (color scheme, reduced motion, etc.)

ParameterTypeRequiredDescription
colorSchemestring: light, dark, no-preferencenoColor scheme: “light”, “dark”, or “no-preference”
contraststring: more, less, no-preferencenoContrast preference: “more”, “less”, or “no-preference”
forcedColorsstring: active, nonenoForced colors: “active” or “none”
mediastring: screen, printnoMedia type: “screen” or “print”
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
reducedMotionstring: reduce, no-preferencenoReduced motion: “reduce” or “no-preference”

Override the browser geolocation

ParameterTypeRequiredDescription
accuracynumbernoAccuracy in meters (default: 1)
latitudenumberyesLatitude (-90 to 90)
longitudenumberyesLongitude (-180 to 180)
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Replace the page HTML content

ParameterTypeRequiredDescription
htmlstringyesHTML content to set
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

List all child frames (iframes) on the current page

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Find a frame by name (exact match) or URL (substring match)

ParameterTypeRequiredDescription
nameOrUrlstringyesFrame name (exact match) or URL substring to find
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Set files on an input[type=file] element

ParameterTypeRequiredDescription
filesarray of stringyesArray of absolute file paths to upload
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
selectorstringyesCSS selector for the file input element
timeoutnumbernoTimeout in milliseconds (default: 30000)

Start a browser recording (screenshots and/or HTML snapshots). Output is Playwright trace viewer compatible.

ParameterTypeRequiredDescription
bidibooleannoRecord raw BiDi commands in the recording (default: false)
formatstring: jpeg, pngnoScreenshot format: “jpeg” or “png” (default: “jpeg”)
namestringnoName for the recording (default: “record”; also seeds the default filename stem)
pathstringnoWhere the recording ZIP lands at stop (default: a timestamped record-.zip in the server’s working directory, or ~/Documents/Vibium when that isn’t writable)
qualitynumbernoJPEG quality 0.0-1.0 (default: 0.5, ignored for png)
screenshotsbooleannoCapture screenshots after each action (default: true)
snapshotsbooleannoCapture HTML snapshots (default: false)
sourcesbooleannoInclude source information (default: false)
titlestringnoTitle shown in trace viewer (defaults to name)
videobooleannoOmit to record video when it can be had: the engine’s screencast (Firefox 154+), or the device’s screen stream on a station or Roadie session. Set true to require video — fails with an explanatory error on Chrome. Set false to disable.
video_frame_ratenumbernoVideo frame rate (engine default if omitted)
video_heightnumbernoVideo height in pixels (defaults to the viewport)
video_remotestring: keepnoOn a remote browser connection, “keep” records anyway and leaves the video on the remote host; the stop result reports its remote path. Retrieval and cleanup are the caller’s.
video_widthnumbernoVideo width in pixels (defaults to the viewport)

Stop recording and save to a Playwright-compatible trace ZIP file (with the video track when one was recorded). With upload, the ZIP also goes to the Record Store of the station the browser is connected through.

ParameterTypeRequiredDescription
pathstringnoOutput file path (overrides the path declared at start; default: record.zip)
uploadbooleannoAlso upload the ZIP to the station the browser is connected through (its Record Store) and report its URL. Needs a remote connection with an API key; the file is saved locally either way.

Start a named group in the recording (groups nest actions in the trace viewer)

ParameterTypeRequiredDescription
namestringyesName for the group

End the current recording group

No parameters.

Start a new chunk within the current recording (for splitting long recordings)

ParameterTypeRequiredDescription
namestringnoName for the chunk
titlestringnoTitle shown in trace viewer (defaults to name)

Package the current recording chunk into a ZIP file (recording remains active)

ParameterTypeRequiredDescription
pathstringnoOutput file path (default: chunk.zip)

Export cookies, localStorage, and sessionStorage as JSON

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.

Restore cookies and storage from a JSON state file

ParameterTypeRequiredDescription
pagestringnoPage id (from browser_new_page or browser_list_pages) that pins this call to that page instead of the globally current one. Concurrent callers sharing this server should create their own page and pass its id on every call.
pathstringyesPath to the JSON state file

Set the download directory for the browser

ParameterTypeRequiredDescription
pathstringyesDirectory path for downloads