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.
All tools
Section titled “All tools”| Tool | What it does |
|---|---|
vibium_run | Accomplish a goal in the current local browser session using configured AI provider and constrained browser tools |
vibium_check | Independently verify an explicit claim against the current local Chrome/Firefox session, or a read-only recording zip |
vibium_say | Speak text into the target |
vibium_listen | Listen to the target and return what was said |
browser_start | Start a browser session |
browser_navigate | Navigate to a URL in the browser |
browser_click | Click an element by CSS selector |
browser_type | Type text into an element by CSS selector, or, with no selector, into whatever has focus |
browser_screenshot | Capture a screenshot of the current page |
browser_find | Find one element and register it as an @eN ref for later tools |
browser_find_all | Find every element matching a description, reference image, or locator, each registered as an @eN ref |
browser_evaluate | Execute JavaScript in the browser to extract data, query the DOM, or inspect page state |
browser_stop | Stop the browser session |
browser_get_html | Get the HTML content of the page or a specific element |
browser_wait | Wait for an element to reach a specified state (attached, visible, or hidden) |
browser_new_page | Open a new browser page, optionally navigating to a URL |
browser_list_pages | List all open browser pages with their URLs |
browser_switch_page | Switch to a browser page by index or URL substring |
browser_close_page | Close a browser page by id or index (default: current page) |
browser_hover | Hover over an element by CSS selector |
browser_select | Select an option in a |
browser_scroll | Scroll the page or a specific element |
browser_keys | Press a key or key combination (e.g., “Enter”, “Control+a”, “Shift+Tab”) |
browser_get_text | Get the text content of the page or a specific element |
browser_get_url | Get the current page URL |
browser_get_title | Get the current page title |
browser_a11y_tree | Get the accessibility tree of the current page |
page_clock_install | Install a fake clock on the page, overriding Date, setTimeout, setInterval, requestAnimationFrame, and performance.now |
page_clock_fast_forward | Jump the fake clock forward by N milliseconds, firing each due timer at most once |
page_clock_run_for | Advance the fake clock by N milliseconds, firing all time-related callbacks systematically |
page_clock_pause_at | Jump the fake clock to a specific time and pause — no timers fire until resumed or advanced |
page_clock_resume | Resume real-time progression from the current fake clock time |
page_clock_set_fixed_time | Freeze Date.now() at a specific value permanently |
page_clock_set_system_time | Set Date.now() to a specific value without triggering any timers |
page_clock_set_timezone | Override the browser timezone |
browser_fill | Clear an input field and type new text |
browser_press | Press a key or key combination on a specific element or the focused element |
browser_back | Navigate back in browser history (like clicking the back button) |
browser_forward | Navigate forward in browser history (like clicking the forward button) |
browser_reload | Reload the current page |
browser_get_value | Get the current value of an input, textarea, or select element |
browser_get_attribute | Get the value of an HTML attribute on an element |
browser_is_visible | Check if an element is visible on the page |
browser_set | Set checkbox/radio selection |
browser_unset | Uncheck a checkbox |
browser_scroll_into_view | Scroll an element into view, centering it on screen |
browser_wait_for_url | Wait until the page URL contains a given substring |
browser_wait_for_load | Wait until the page reaches the “complete” ready state (all resources loaded) |
browser_sleep | Pause execution for a specified number of milliseconds |
browser_map | Map interactive page elements with @refs for targeting |
browser_diff_map | Compare current page state vs last map |
browser_pdf | Save the current page as a PDF file |
browser_highlight | Highlight an element with a red outline for 3 seconds |
browser_dblclick | Double-click an element by CSS selector or @ref |
browser_focus | Focus an element by CSS selector or @ref |
browser_count | Count the number of elements matching a CSS selector |
browser_is_enabled | Check if an element is enabled (not disabled) |
browser_is_set | Check if a checkbox or radio button is checked |
browser_wait_for_text | Wait until specific text appears on the page |
browser_wait_for_fn | Wait until a JavaScript expression returns a truthy value |
browser_dialog_accept | Accept a dialog (alert, confirm, prompt) |
browser_dialog_dismiss | Dismiss a dialog (cancel/close) |
browser_get_cookies | List all cookies for the current page |
browser_set_cookie | Set a cookie |
browser_delete_cookies | Delete cookies |
browser_mouse_move | Move the mouse to specific coordinates |
browser_mouse_down | Press a mouse button down at the current position |
browser_mouse_up | Release a mouse button at the current position |
browser_mouse_click | Click at coordinates or at the current mouse position |
browser_tap | Tap a touch pointer at coordinates, or on an element given as a selector or @ref (for touchscreen devices and phones) |
browser_swipe | Swipe a touch pointer, finger held down for the move (for touchscreen devices and phones) |
browser_long_press | Press and hold a touch pointer at coordinates (for touchscreen devices and phones) |
browser_drag | Drag from one element to another |
browser_set_viewport | Set the browser viewport size |
browser_get_viewport | Get the current viewport dimensions |
browser_get_window | Get the OS browser window dimensions and state |
browser_set_window | Set the OS browser window size, position, or state |
browser_emulate_media | Override CSS media features (color scheme, reduced motion, etc.) |
browser_set_geolocation | Override the browser geolocation |
browser_set_content | Replace the page HTML content |
browser_frames | List all child frames (iframes) on the current page |
browser_frame | Find a frame by name (exact match) or URL (substring match) |
browser_upload | Set files on an input[type=file] element |
browser_record_start | Start a browser recording (screenshots and/or HTML snapshots) |
browser_record_stop | Stop recording and save to a Playwright-compatible trace ZIP file (with the video track when one was recorded) |
browser_record_start_group | Start a named group in the recording (groups nest actions in the trace viewer) |
browser_record_stop_group | End the current recording group |
browser_record_start_chunk | Start a new chunk within the current recording (for splitting long recordings) |
browser_record_stop_chunk | Package the current recording chunk into a ZIP file (recording remains active) |
browser_storage_state | Export cookies, localStorage, and sessionStorage as JSON |
browser_restore_storage | Restore cookies and storage from a JSON state file |
browser_download_set_dir | Set the download directory for the browser |
Parameters
Section titled “Parameters”vibium_run
Section titled “vibium_run”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
aiBaseURL | string | no | Per-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. |
baseURL | string | no | Site 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. |
goal | string | yes | |
model | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
page | string | no | Page 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. |
provider | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
reasoningEffort | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
vibium_check
Section titled “vibium_check”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
aiBaseURL | string | no | Per-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. |
baseURL | string | no | Site 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. |
claim | string | yes | |
model | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
page | string | no | Page 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. |
provider | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
reasoningEffort | string | no | Per-call model setting override. Changing provider clears inherited model, endpoint, and reasoning effort. Credentials come from the runtime environment. |
record | string | no | Optional path to an existing version 8 Vibium record.zip or Playwright trace.zip on this host; selects archive mode instead of the live browser. |
vibium_say
Section titled “vibium_say”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
cache | boolean | no | false renders again instead of replaying cached audio |
cacheDir | string | no | Where rendered audio is kept |
file | string | no | A WAV file to play as it is, in place of text |
language | string | no | |
model | string | no | |
page | string | no | Page 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. |
provider | string | no | Text-to-speech provider or preset; the default comes from the server environment |
speed | number | no | |
target | string | no | session, local, or a path ending in .wav |
text | string | no | What to say. Give text or file |
voice | string | no |
vibium_listen
Section titled “vibium_listen”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
allowSilence | boolean | no | Return an empty transcript instead of an error when nothing is heard |
duration | number | no | Maximum capture length from this call, in ms (default 30000) |
language | string | no | |
model | string | no | |
page | string | no | Page 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. |
path | string | no | Also save the captured audio as a WAV file |
provider | string | no | Speech-to-text provider or preset; the default comes from the server environment |
silence | number | no | Trailing silence that ends the reply, in ms (default 1000). 0 turns endpointing off |
target | string | no | session, local, or a path ending in .wav |
timeout | number | no | How long to wait for speech to start, from this call, in ms (default 10000) |
transcribe | boolean | no | false captures without a transcript; speech onset and reply latency are still measured |
browser_start
Section titled “browser_start”Start a browser session
| Parameter | Type | Required | Description |
|---|---|---|---|
channel | string: beta, canary, dev, release, stable | no | Release channel of the selected engine; chrome: stable (default), beta, dev, canary; firefox: release (default), beta |
engine | string: chrome, firefox | no | Browser engine to launch |
headless | boolean | no | Run browser in headless mode (no visible window) |
userDataDir | string | no | Persistent browser profile directory, created if missing and reused across sessions (cookies, logins survive); omit for a temporary profile wiped on close |
browser_navigate
Section titled “browser_navigate”Navigate to a URL in the browser
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
url | string | yes | The URL to navigate to |
browser_click
Section titled “browser_click”Click an element by CSS selector. Waits for element to be visible, stable, and enabled.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element to click |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_type
Section titled “browser_type”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | no | CSS selector for the element to type into. Omit it to type into the focused element, or on a device with no DOM. |
text | string | yes | The text to type |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_screenshot
Section titled “browser_screenshot”Capture a screenshot of the current page
| Parameter | Type | Required | Description |
|---|---|---|---|
annotate | boolean | no | Annotate interactive elements with numbered labels (default: false) |
filename | string | no | Optional filename to save the screenshot (e.g., screenshot.png) |
fullPage | boolean | no | Capture the full page (entire document) instead of just the viewport (default: false) |
page | string | no | Page 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. |
browser_find
Section titled “browser_find”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
aiBaseURL | string | no | AI provider base URL override for this call |
alt | string | no | Find element by alt attribute |
css | string | no | CSS selector; exact, never sent to a model. Next to a semantic locator it restricts the candidates |
description | string | no | Natural-language description of the element, e.g. “the Add to Cart button”. Stands alone. |
details | boolean | no | Include diagnostics: method, whether a model was called, provider and model, raw scores |
image | string | no | Reference image as base64 PNG or JPEG (a data: URL is accepted), up to 4 MB. Stands alone. Matched locally; see strategy. |
label | string | no | Find input by associated label text or aria-label |
model | string | no | Model override for this call; a vision-capable model |
name | string | no | Accessible name filter: the text, label, alt, or aria-label a person would read the element by |
page | string | no | Page 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. |
placeholder | string | no | Find element by placeholder attribute |
provider | string | no | AI provider override for this call (same as vibium_check) |
reasoningEffort | string | no | Reasoning effort override for this call |
role | string | no | ARIA role to match (e.g., “button”, “link”, “textbox”, “heading”, “checkbox”) |
selector | string | no | Same as css |
strategy | string: auto, cv, vlm, tree | no | auto (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 |
tag | string | no | HTML tag name, e.g. “h1” |
testid | string | no | Find element by data-testid attribute |
text | string | no | Find element containing this text |
timeout | number | no | Timeout in milliseconds (default: 30000) |
title | string | no | Find element by title attribute |
xpath | string | no | Find element by XPath expression |
browser_find_all
Section titled “browser_find_all”Find every element matching a description, reference image, or locator, each registered as an @eN ref. Returns an empty list when nothing matches.
| Parameter | Type | Required | Description |
|---|---|---|---|
aiBaseURL | string | no | AI provider base URL override for this call |
alt | string | no | Find element by alt attribute |
css | string | no | CSS selector; exact, never sent to a model. Next to a semantic locator it restricts the candidates |
description | string | no | Natural-language description of the element, e.g. “the Add to Cart button”. Stands alone. |
details | boolean | no | Include diagnostics: method, whether a model was called, provider and model, raw scores |
image | string | no | Reference image as base64 PNG or JPEG (a data: URL is accepted), up to 4 MB. Stands alone. Matched locally; see strategy. |
label | string | no | Find input by associated label text or aria-label |
limit | number | no | Maximum number of elements to return (default: 10) |
model | string | no | Model override for this call; a vision-capable model |
name | string | no | Accessible name filter: the text, label, alt, or aria-label a person would read the element by |
page | string | no | Page 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. |
placeholder | string | no | Find element by placeholder attribute |
provider | string | no | AI provider override for this call (same as vibium_check) |
reasoningEffort | string | no | Reasoning effort override for this call |
role | string | no | ARIA role to match (e.g., “button”, “link”, “textbox”, “heading”, “checkbox”) |
selector | string | no | Same as css |
strategy | string: auto, cv, vlm, tree | no | auto (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 |
tag | string | no | HTML tag name, e.g. “h1” |
testid | string | no | Find element by data-testid attribute |
text | string | no | Find element containing this text |
timeout | number | no | Timeout in milliseconds (default: 30000) |
title | string | no | Find element by title attribute |
xpath | string | no | Find element by XPath expression |
browser_evaluate
Section titled “browser_evaluate”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
expression | string | yes | JavaScript expression to evaluate |
page | string | no | Page 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. |
browser_stop
Section titled “browser_stop”Stop the browser session
No parameters.
browser_get_html
Section titled “browser_get_html”Get the HTML content of the page or a specific element
| Parameter | Type | Required | Description |
|---|---|---|---|
outer | boolean | no | Return outerHTML instead of innerHTML (default: false) |
page | string | no | Page 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. |
selector | string | no | CSS selector for a specific element (optional, defaults to full page HTML) |
browser_wait
Section titled “browser_wait”Wait for an element to reach a specified state (attached, visible, or hidden)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element to wait for |
state | string: attached, visible, hidden | no | State to wait for: “attached” (exists in DOM), “visible” (visible on page), or “hidden” (not found or not visible) |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_new_page
Section titled “browser_new_page”Open a new browser page, optionally navigating to a URL
| Parameter | Type | Required | Description |
|---|---|---|---|
isolated | boolean | no | Open 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. |
url | string | no | URL to navigate to in the new page (optional) |
browser_list_pages
Section titled “browser_list_pages”List all open browser pages with their URLs
No parameters.
browser_switch_page
Section titled “browser_switch_page”Switch to a browser page by index or URL substring
| Parameter | Type | Required | Description |
|---|---|---|---|
index | number | no | Page index (0-based) from browser_list_pages |
url | string | no | URL substring to match (alternative to index) |
browser_close_page
Section titled “browser_close_page”Close a browser page by id or index (default: current page)
| Parameter | Type | Required | Description |
|---|---|---|---|
index | number | no | Page index to close (default: 0, the current page); ignored when a page id is given |
page | string | no | Page 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. |
browser_hover
Section titled “browser_hover”Hover over an element by CSS selector
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element to hover over |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_select
Section titled “browser_select”Select an option in a element
timeout
number
no
Timeout in milliseconds (default: 30000)
value
string
yes
The value to select
browser_scroll
Section titled “browser_scroll”Scroll the page or a specific element
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number | no | Number of scroll increments (default: 3) |
direction | string: up, down, left, right | no | Scroll direction: up, down, left, right (default: down) |
page | string | no | Page 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. |
selector | string | no | CSS selector for the element to scroll within (optional; without it the page scrolls at the viewport center) |
browser_keys
Section titled “browser_keys”Press a key or key combination (e.g., “Enter”, “Control+a”, “Shift+Tab”)
| Parameter | Type | Required | Description |
|---|---|---|---|
keys | string | yes | Key or key combination to press (e.g., “Enter”, “Control+a”, “Shift+ArrowDown”) |
page | string | no | Page 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. |
browser_get_text
Section titled “browser_get_text”Get the text content of the page or a specific element
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | no | CSS selector for a specific element (optional, defaults to full page text) |
browser_get_url
Section titled “browser_get_url”Get the current page URL
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_get_title
Section titled “browser_get_title”Get the current page title
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_a11y_tree
Section titled “browser_a11y_tree”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
everything | boolean | no | Show all nodes including generic containers. Default: false |
page | string | no | Page 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. |
page_clock_install
Section titled “page_clock_install”Install a fake clock on the page, overriding Date, setTimeout, setInterval, requestAnimationFrame, and performance.now
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
time | number | no | Initial time as epoch milliseconds (optional) |
timezone | string | no | IANA timezone ID to override (e.g. ‘America/New_York’, ‘Europe/London’) |
page_clock_fast_forward
Section titled “page_clock_fast_forward”Jump the fake clock forward by N milliseconds, firing each due timer at most once
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
ticks | number | yes | Number of milliseconds to fast-forward |
page_clock_run_for
Section titled “page_clock_run_for”Advance the fake clock by N milliseconds, firing all time-related callbacks systematically
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
ticks | number | yes | Number of milliseconds to advance |
page_clock_pause_at
Section titled “page_clock_pause_at”Jump the fake clock to a specific time and pause — no timers fire until resumed or advanced
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
time | number | yes | Time as epoch milliseconds to pause at |
page_clock_resume
Section titled “page_clock_resume”Resume real-time progression from the current fake clock time
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
page_clock_set_fixed_time
Section titled “page_clock_set_fixed_time”Freeze Date.now() at a specific value permanently. Timers still run.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
time | number | yes | Time as epoch milliseconds to freeze at |
page_clock_set_system_time
Section titled “page_clock_set_system_time”Set Date.now() to a specific value without triggering any timers
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
time | number | yes | Time as epoch milliseconds to set |
page_clock_set_timezone
Section titled “page_clock_set_timezone”Override the browser timezone. Pass an IANA timezone ID (e.g. ‘America/New_York’), or empty string to reset to system default
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
timezone | string | yes | IANA timezone ID (e.g. ‘America/New_York’, ‘Europe/London’, ‘Asia/Tokyo’). Empty string resets to system default. |
browser_fill
Section titled “browser_fill”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the input element |
text | string | yes | The text to fill in |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_press
Section titled “browser_press”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | yes | Key or key combination to press (e.g., “Enter”, “Control+a”, “Escape”) |
page | string | no | Page 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. |
selector | string | no | CSS selector for the element to focus before pressing (optional, defaults to currently focused element) |
browser_back
Section titled “browser_back”Navigate back in browser history (like clicking the back button)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_forward
Section titled “browser_forward”Navigate forward in browser history (like clicking the forward button)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_reload
Section titled “browser_reload”Reload the current page. Waits for the page to fully load.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_get_value
Section titled “browser_get_value”Get the current value of an input, textarea, or select element
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the form element |
browser_get_attribute
Section titled “browser_get_attribute”Get the value of an HTML attribute on an element
| Parameter | Type | Required | Description |
|---|---|---|---|
attribute | string | yes | Attribute name to retrieve (e.g., “href”, “src”, “class”, “data-id”) |
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element |
browser_is_visible
Section titled “browser_is_visible”Check if an element is visible on the page. Returns true/false without throwing errors.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element |
browser_set
Section titled “browser_set”Set checkbox/radio selection. Defaults to true; false clears a checkbox. Idempotent.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the checkbox or radio button |
timeout | number | no | Timeout in milliseconds (default: 30000) |
value | boolean | no | Desired selection state; false clears a checkbox |
browser_unset
Section titled “browser_unset”Uncheck a checkbox. Idempotent — does nothing if already unchecked.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the checkbox |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_scroll_into_view
Section titled “browser_scroll_into_view”Scroll an element into view, centering it on screen
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector for the element to scroll into view |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_wait_for_url
Section titled “browser_wait_for_url”Wait until the page URL contains a given substring
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
pattern | string | yes | Substring to match in the URL |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_wait_for_load
Section titled “browser_wait_for_load”Wait until the page reaches the “complete” ready state (all resources loaded)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_sleep
Section titled “browser_sleep”Pause execution for a specified number of milliseconds. Use sparingly — prefer browser_wait or browser_wait_for_url when possible.
| Parameter | Type | Required | Description |
|---|---|---|---|
ms | number | yes | Number of milliseconds to sleep (max 30000) |
browser_map
Section titled “browser_map”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.).
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | no | CSS selector to scope element discovery to a subtree (e.g. “nav”, “#sidebar”) |
browser_diff_map
Section titled “browser_diff_map”Compare current page state vs last map. Shows additions (+) and removals (-) since the last browser_map call.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_pdf
Section titled “browser_pdf”Save the current page as a PDF file
| Parameter | Type | Required | Description |
|---|---|---|---|
background | boolean | no | Print background graphics (default: false) |
filename | string | no | Output filename for the PDF (e.g., page.pdf) |
landscape | boolean | no | Landscape orientation (default: portrait) |
marginBottom | number | no | Bottom margin in cm (default: 1) |
marginLeft | number | no | Left margin in cm (default: 1) |
marginRight | number | no | Right margin in cm (default: 1) |
marginTop | number | no | Top margin in cm (default: 1) |
page | string | no | Page 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. |
pageHeight | number | no | Page height in cm (default: 27.94) |
pageRanges | array of string or integer | no | Pages to print, e.g. [1, “3-5”] (default: all) |
pageWidth | number | no | Page width in cm (default: 21.59) |
scale | number | no | Print scale, 0.1-2 (default: 1) |
shrinkToFit | boolean | no | Shrink content to fit the page width (default: true) |
browser_highlight
Section titled “browser_highlight”Highlight an element with a red outline for 3 seconds. Useful for visual debugging.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector or @ref for the element to highlight |
browser_dblclick
Section titled “browser_dblclick”Double-click an element by CSS selector or @ref
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector or @ref for the element to double-click |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_focus
Section titled “browser_focus”Focus an element by CSS selector or @ref
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector or @ref for the element to focus |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_count
Section titled “browser_count”Count the number of elements matching a CSS selector
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector to count matches for |
browser_is_enabled
Section titled “browser_is_enabled”Check if an element is enabled (not disabled). Returns true/false.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector or @ref for the element |
browser_is_set
Section titled “browser_is_set”Check if a checkbox or radio button is checked. Returns true/false.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | yes | CSS selector or @ref for the checkbox/radio element |
browser_wait_for_text
Section titled “browser_wait_for_text”Wait until specific text appears on the page
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
text | string | yes | Text to wait for on the page |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_wait_for_fn
Section titled “browser_wait_for_fn”Wait until a JavaScript expression returns a truthy value
| Parameter | Type | Required | Description |
|---|---|---|---|
expression | string | yes | JavaScript expression to evaluate (e.g., “window.ready === true”) |
page | string | no | Page 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. |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_dialog_accept
Section titled “browser_dialog_accept”Accept a dialog (alert, confirm, prompt). Optionally provide text for prompt dialogs.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
text | string | no | Text to enter in the prompt dialog (optional) |
browser_dialog_dismiss
Section titled “browser_dialog_dismiss”Dismiss a dialog (cancel/close)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_get_cookies
Section titled “browser_get_cookies”List all cookies for the current page
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_set_cookie
Section titled “browser_set_cookie”Set a cookie
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | no | Cookie domain (optional, defaults to current page domain) |
name | string | yes | Cookie name |
page | string | no | Page 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. |
path | string | no | Cookie path (optional, defaults to /) |
value | string | yes | Cookie value |
browser_delete_cookies
Section titled “browser_delete_cookies”Delete cookies. If name is given, deletes that cookie. Otherwise deletes all cookies.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | no | Cookie name to delete (optional, omit to delete all) |
page | string | no | Page 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. |
browser_mouse_move
Section titled “browser_mouse_move”Move the mouse to specific coordinates
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
x | number | yes | X coordinate |
y | number | yes | Y coordinate |
browser_mouse_down
Section titled “browser_mouse_down”Press a mouse button down at the current position
| Parameter | Type | Required | Description |
|---|---|---|---|
button | number | no | Mouse button (0=left, 1=middle, 2=right). Default: 0 |
page | string | no | Page 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. |
browser_mouse_up
Section titled “browser_mouse_up”Release a mouse button at the current position
| Parameter | Type | Required | Description |
|---|---|---|---|
button | number | no | Mouse button (0=left, 1=middle, 2=right). Default: 0 |
page | string | no | Page 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. |
browser_mouse_click
Section titled “browser_mouse_click”Click at coordinates or at the current mouse position. If x and y are provided, moves the mouse there first.
| Parameter | Type | Required | Description |
|---|---|---|---|
button | number | no | Mouse button (0=left, 1=middle, 2=right). Default: 0 |
page | string | no | Page 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. |
x | number | no | X coordinate to click at |
y | number | no | Y coordinate to click at |
browser_tap
Section titled “browser_tap”Tap a touch pointer at coordinates, or on an element given as a selector or @ref (for touchscreen devices and phones)
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
selector | string | no | CSS selector or @ref to tap at its center, instead of x and y |
x | number | no | X coordinate to tap at |
y | number | no | Y coordinate to tap at |
browser_swipe
Section titled “browser_swipe”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
| Parameter | Type | Required | Description |
|---|---|---|---|
direction | string: up, down, left, right | no | Which way the finger moves. Instead of x1, y1, x2, y2 |
distance | number | no | How far a direction swipe moves, in pixels (default: half the viewport) |
duration | number | no | How long the move takes in milliseconds (default: 300) |
from | string: top, bottom, left, right, top-left, top-right, bottom-left, bottom-right, center | no | Where a direction swipe starts: an edge or corner of the viewport, or its center (default) |
fromX | number | no | X coordinate a direction swipe starts at, with fromY. Instead of from |
fromY | number | no | Y coordinate a direction swipe starts at, with fromX |
hold | number | no | Milliseconds the finger rests at the end before lifting (a slow swipe up from the bottom with a hold opens the app switcher) |
page | string | no | Page 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. |
speed | string or number | no | slow, normal, fast, or pixels per second. Instead of duration |
x1 | number | no | X coordinate to start from |
x2 | number | no | X coordinate to end at |
y1 | number | no | Y coordinate to start from |
y2 | number | no | Y coordinate to end at |
browser_long_press
Section titled “browser_long_press”Press and hold a touch pointer at coordinates (for touchscreen devices and phones)
| Parameter | Type | Required | Description |
|---|---|---|---|
duration | number | no | How long to hold the press in milliseconds (default: 500) |
page | string | no | Page 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. |
x | number | yes | X coordinate to press at |
y | number | yes | Y coordinate to press at |
browser_drag
Section titled “browser_drag”Drag from one element to another
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
source | string | yes | CSS selector or @ref for the source element |
target | string | yes | CSS selector or @ref for the target element |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_set_viewport
Section titled “browser_set_viewport”Set the browser viewport size
| Parameter | Type | Required | Description |
|---|---|---|---|
devicePixelRatio | number | no | Device pixel ratio (optional, e.g., 2 for Retina) |
height | number | yes | Viewport height in pixels |
page | string | no | Page 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. |
width | number | yes | Viewport width in pixels |
browser_get_viewport
Section titled “browser_get_viewport”Get the current viewport dimensions
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_get_window
Section titled “browser_get_window”Get the OS browser window dimensions and state
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_set_window
Section titled “browser_set_window”Set the OS browser window size, position, or state
| Parameter | Type | Required | Description |
|---|---|---|---|
height | number | no | Window height in pixels |
page | string | no | Page 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. |
state | string: normal, maximized, minimized, fullscreen | no | Window state: normal, maximized, minimized, or fullscreen |
width | number | no | Window width in pixels |
x | number | no | Window x position in pixels |
y | number | no | Window y position in pixels |
browser_emulate_media
Section titled “browser_emulate_media”Override CSS media features (color scheme, reduced motion, etc.)
| Parameter | Type | Required | Description |
|---|---|---|---|
colorScheme | string: light, dark, no-preference | no | Color scheme: “light”, “dark”, or “no-preference” |
contrast | string: more, less, no-preference | no | Contrast preference: “more”, “less”, or “no-preference” |
forcedColors | string: active, none | no | Forced colors: “active” or “none” |
media | string: screen, print | no | Media type: “screen” or “print” |
page | string | no | Page 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. |
reducedMotion | string: reduce, no-preference | no | Reduced motion: “reduce” or “no-preference” |
browser_set_geolocation
Section titled “browser_set_geolocation”Override the browser geolocation
| Parameter | Type | Required | Description |
|---|---|---|---|
accuracy | number | no | Accuracy in meters (default: 1) |
latitude | number | yes | Latitude (-90 to 90) |
longitude | number | yes | Longitude (-180 to 180) |
page | string | no | Page 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. |
browser_set_content
Section titled “browser_set_content”Replace the page HTML content
| Parameter | Type | Required | Description |
|---|---|---|---|
html | string | yes | HTML content to set |
page | string | no | Page 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. |
browser_frames
Section titled “browser_frames”List all child frames (iframes) on the current page
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_frame
Section titled “browser_frame”Find a frame by name (exact match) or URL (substring match)
| Parameter | Type | Required | Description |
|---|---|---|---|
nameOrUrl | string | yes | Frame name (exact match) or URL substring to find |
page | string | no | Page 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. |
browser_upload
Section titled “browser_upload”Set files on an input[type=file] element
| Parameter | Type | Required | Description |
|---|---|---|---|
files | array of string | yes | Array of absolute file paths to upload |
page | string | no | Page 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. |
selector | string | yes | CSS selector for the file input element |
timeout | number | no | Timeout in milliseconds (default: 30000) |
browser_record_start
Section titled “browser_record_start”Start a browser recording (screenshots and/or HTML snapshots). Output is Playwright trace viewer compatible.
| Parameter | Type | Required | Description |
|---|---|---|---|
bidi | boolean | no | Record raw BiDi commands in the recording (default: false) |
format | string: jpeg, png | no | Screenshot format: “jpeg” or “png” (default: “jpeg”) |
name | string | no | Name for the recording (default: “record”; also seeds the default filename stem) |
path | string | no | Where the recording ZIP lands at stop (default: a timestamped record- |
quality | number | no | JPEG quality 0.0-1.0 (default: 0.5, ignored for png) |
screenshots | boolean | no | Capture screenshots after each action (default: true) |
snapshots | boolean | no | Capture HTML snapshots (default: false) |
sources | boolean | no | Include source information (default: false) |
title | string | no | Title shown in trace viewer (defaults to name) |
video | boolean | no | Omit 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_rate | number | no | Video frame rate (engine default if omitted) |
video_height | number | no | Video height in pixels (defaults to the viewport) |
video_remote | string: keep | no | On 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_width | number | no | Video width in pixels (defaults to the viewport) |
browser_record_stop
Section titled “browser_record_stop”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.
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | no | Output file path (overrides the path declared at start; default: record.zip) |
upload | boolean | no | Also 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. |
browser_record_start_group
Section titled “browser_record_start_group”Start a named group in the recording (groups nest actions in the trace viewer)
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Name for the group |
browser_record_stop_group
Section titled “browser_record_stop_group”End the current recording group
No parameters.
browser_record_start_chunk
Section titled “browser_record_start_chunk”Start a new chunk within the current recording (for splitting long recordings)
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | no | Name for the chunk |
title | string | no | Title shown in trace viewer (defaults to name) |
browser_record_stop_chunk
Section titled “browser_record_stop_chunk”Package the current recording chunk into a ZIP file (recording remains active)
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | no | Output file path (default: chunk.zip) |
browser_storage_state
Section titled “browser_storage_state”Export cookies, localStorage, and sessionStorage as JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
browser_restore_storage
Section titled “browser_restore_storage”Restore cookies and storage from a JSON state file
| Parameter | Type | Required | Description |
|---|---|---|---|
page | string | no | Page 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. |
path | string | yes | Path to the JSON state file |
browser_download_set_dir
Section titled “browser_download_set_dir”Set the download directory for the browser
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Directory path for downloads |