Custodia-Admin/pagebolt-mcp

• allowedDomainsstring[]

  Hosts the agent may navigate to (e.g. ["app.example.com"]). Defaults to the start URL host only; navigation elsewhere is rejected.

• credentialsobject

  Login credentials. The agent references them as {{username}}/{{password}} and they appear in the returned trace as <redacted>.

• goalstringобязательный

  Required. Plain-English description of the outcome you want (e.g. "Log in and go to the billing page").

• maxStepsinteger

  Cap on planning iterations (default 8). Clamped to your plan ceiling (Starter 10, Growth 15, Scale 20).

• session_idstring

  Run inside an existing persistent session (Starter+; create with create_session) to reuse cookies/login. Otherwise an ephemeral browser is used and discarded.

• urlstringобязательный

  Required. The page to start on.

Без параметров.

• accentColorstring

  Accent color as hex, e.g. "#6366f1"

• bgColorstring

  Background color as hex, e.g. "#0f172a"

• bgImagestring

  Background image URL

• formatenum

  Image format (default: png)

• heightinteger

  Image height in pixels (default: 630)

• htmlstring

  Custom HTML template (overrides template parameter, Growth plan+)

• logostring

  Logo image URL

• subtitlestring

  Subtitle text

• templateenum

  Built-in template name (default: "default")

• textColorstring

  Text color as hex, e.g. "#f8fafc"

• titlestring

  Main title text (default: "Your Title Here")

• widthinteger

  Image width in pixels (default: 1200)

• cookiesstring | object[]

  Cookies to pre-load into the session browser page

• stealthboolean

  Launch this session with stealth mode (bypasses bot detection). Note: stealth sessions use a dedicated browser and consume more memory.

• viewportobject

  Viewport dimensions for the session browser page

• session_idstringобязательный

  The session ID to destroy (returned by create_session)

• delayinteger

  Milliseconds to wait before rendering (default: 0)

• displayHeaderFooterboolean

  Show header and footer (default: false)

• footerTemplatestring

  HTML template for page footer

• formatstring

  Paper format: A4, Letter, Legal, Tabloid, A3, A5 (default: A4)

• headerTemplatestring

  HTML template for page header (uses Chromium templating)

• htmlstring

  Raw HTML to render as PDF (required if no url)

• landscapeboolean

  Landscape orientation (default: false)

• marginstring | object

  CSS margin — string for all sides (e.g. "1cm") or object { top, right, bottom, left }

• pageRangesstring

  Page ranges to include, e.g. "1-5, 8"

• printBackgroundboolean

  Include CSS backgrounds (default: true)

• saveTostring

  Output file path (default: ./output.pdf)

• scalenumber

  Rendering scale 0.1-2 (default: 1)

• urlstring

  URL to render as PDF (required if no html)

• widthstring

  Page width (overrides format) — CSS value like "8.5in"

• job_idstringобязательный

  The job id to look up (returned when a video is enqueued as an async job).

• namestring

  Optional name for the resulting sequence.

• saveboolean

  Whether to persist the sequence (default true). Set false for a dry run that returns the translated steps + step_count without saving.

• selectorsobject

  Optional index→CSS selector map (e.g. from observe_page format:"flatdomtree"). Used to resolve numeric element indices in the trace to concrete selectors.

• traceobject[]обязательный

  Required. Array of page-agent/browser-use action entries. Supports both {action, index|selector, value, ...} and {action_name: {...}} shapes.

• typeenum

  Optional target type for the imported steps: "sequence" (default) or "video".

• authorizationstring

  Authorization header value (e.g. "Bearer <token>")

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: false)

• blockChatsboolean

  Block live chat widgets

• blockRequestsstring[]

  URL patterns to block

• blockResourcesstring[]

  Resource types to block

• blockTrackersboolean

  Block tracking scripts

• bypassCSPboolean

  Bypass Content-Security-Policy on the page

• cookiesstring | object[]

  Cookies to set — array of "name=value" strings or { name, value, domain? } objects

• darkModeboolean

  Emulate dark color scheme (default: false)

• deviceScaleFactornumber

  Device pixel ratio (default: 1)

• geolocationobject

  Emulate geolocation

• headersobject

  Extra HTTP headers to send with the request

• heightinteger

  Viewport height in pixels (default: 720)

• hideSelectorsstring[]

  Array of CSS selectors to hide before inspecting

• htmlstring

  Raw HTML to inspect (required if no url)

• includeConsoleboolean

  Capture browser console output (console.log/info/warn/error/debug) and uncaught page errors emitted during page load. Adds a "Console" section to the result — lets you debug the page's runtime behavior, not just its static DOM. Default: false.

• injectCssstring

  Custom CSS to inject before inspecting

• injectJsstring

  Custom JavaScript to execute before inspecting

• mediaTypeenum

  Emulate CSS media type

• navigationTimeoutinteger

  Navigation timeout in ms (default: 25000)

• reducedMotionboolean

  Emulate prefers-reduced-motion

• session_idstring

  Inspect the LIVE state of a persistent session (Starter+; create with create_session) instead of a fresh page load. Omit url to inspect the page exactly as the last run_sequence/take_screenshot left it; pass url to navigate within the session first. Ideal for re-perceiving between agent actions.

• timeZonestring

  Override browser timezone

• urlstring

  URL to inspect (required if no html)

• userAgentstring

  Override the browser User-Agent string

• viewportDevicestring

  Device preset for viewport emulation (e.g. "iphone_14_pro"). Use list_devices to see all presets.

• viewportHasTouchboolean

  Enable touch event emulation

• viewportLandscapeboolean

  Landscape orientation

• viewportMobileboolean

  Enable mobile meta viewport emulation

• waitForSelectorstring

  Wait for this CSS selector to appear before inspecting

• waitUntilenum

  When to consider navigation finished (default: networkidle2)

• widthinteger

  Viewport width in pixels (default: 1280)

Без параметров.

Без параметров.

Без параметров.

• authorizationstring

  Authorization header value (e.g. "Bearer <token>")

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: false)

• blockChatsboolean

  Block live chat widgets

• blockTrackersboolean

  Block tracking scripts

• bypassCSPboolean

  Bypass Content-Security-Policy on the page

• cookiesstring | object[]

  Cookies to set — array of "name=value" strings or { name, value, domain? } objects

• darkModeboolean

  Emulate dark color scheme (default: false)

• deviceScaleFactornumber

  Device pixel ratio (default: 1)

• formatenum

  Observation representation. "json" (default) returns the id-indexed "elements" array. "flatdomtree" returns "dom_text" — the indexed plain-text DOM used by browser-use / Alibaba page-agent (e.g. [1]<button>Sign in</button>) — plus a "selectors" map ({"1":"#signin"}) INSTEAD of the elements array. Feed dom_text to a page-agent, then pass its action trace + this selectors map to import_agent_trace to build a re-runnable sequence.

• headersobject

  Extra HTTP headers to send with the request

• heightinteger

  Viewport height in pixels (default: 720)

• htmlstring

  Raw HTML to observe (required if no url)

• includeAriaTreeboolean

  Also include the interesting-only ARIA accessibility tree (default false)

• includeConsoleboolean

  Also capture browser console output (console.log/info/warn/error/debug) and uncaught page errors emitted during load (default false). Adds a "Console" section — useful for debugging the page's runtime behavior alongside its structure.

• includeContentboolean

  Also extract the main readable content as Markdown (default false)

• includeRectsboolean

  Include bounding boxes {x,y,w,h} per element (default false — omit to save tokens)

• includeScreenshotboolean

  Also capture a screenshot in the same page load (default false)

• maxElementsinteger

  Cap on interactive elements returned (default 40, max 150). Lower = fewer tokens.

• navigationTimeoutinteger

  Navigation timeout in ms (default: 25000)

• screenshotFormatenum

  Screenshot format when includeScreenshot is true (default jpeg)

• screenshotFullPageboolean

  Capture the full scrollable page for the screenshot (default false)

• session_idstring

  Observe the LIVE state of a persistent session (Starter+; create with create_session) instead of a fresh page load. Omit url to observe the page exactly as the last run_sequence/take_screenshot left it; pass url to navigate within the session first. This is the recommended way to re-perceive between agent actions and recover from popovers/redirects.

• timeZonestring

  Override browser timezone

• urlstring

  URL to observe (required if no html)

• userAgentstring

  Override the browser User-Agent string

• viewportDevicestring

  Device preset for viewport emulation (e.g. "iphone_14_pro"). Use list_devices to see all presets.

• waitForSelectorstring

  Wait for this CSS selector to appear before observing

• waitUntilenum

  When to consider navigation finished (default: networkidle2)

• widthinteger

  Viewport width in pixels (default: 1280)

• asyncboolean

  Render via an async job for reliability. The video is enqueued (202 + job_id) and this tool polls until it finishes, so long recordings do not hit the API's per-request timeout. The finished video is delivered as a private hosted URL (its bytes cannot be pulled back via the API key). Set false to force a single blocking synchronous request that returns the video INLINE (base64 embedded + saved to saveTo). DEFAULT: true, except when you pass saveTo (then sync is used so the file is actually produced on disk). If async is unavailable on your plan, it automatically falls back to sync. Quota is charged only on success; max 5 pending jobs per account.

• audioGuideobject

  Audio Guide TTS settings. Two modes: (1) Per-step — add "narration" to individual steps. (2) Script — provide "script" with {{N}} markers for continuous narration synchronized to steps.

• autoZoomboolean

  Enable auto-zoom on all clicks (default: false). Only use when user explicitly requests zoom.

• backgroundobject

  Styled background behind the video. Adds gradient/solid background with padding and rounded corners — creates a "floating window" effect.

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: true for videos)

• blockChatsboolean

  Block live chat widgets

• blockTrackersboolean

  Block tracking scripts

• clickEffectobject

  Visual click effect settings

• cursorobject

  Cursor appearance settings

• darkModeboolean

  Emulate dark color scheme (default: false)

• deviceScaleFactornumber

  Device pixel ratio (default: 1)

• formatenum

  Video format (default: mp4). webm/gif require Starter+ plan.

• frameobject

  Browser chrome frame around the video. Adds a macOS/Windows-style title bar.

• framerateinteger

  Frames per second: 24, 30, or 60 (default: 30)

• pacenumber | enum

  Controls how deliberate the video feels. Number (0.25–6.0, higher = slower) or preset: "fast" (0.5×), "normal" (1×), "slow" (2×), "dramatic" (3×), "cinematic" (4.5×). Default: "normal".

• pollTimeoutMsinteger

  Max time to wait for an async video job to finish, in milliseconds (default: 240000 = 4 min). If the job is still running when this elapses, the job_id is returned so you can check it later with get_job.

• saveTostring

  Output file path (default: ./recording.mp4)

• stepsobject[]обязательный

  Array of action steps to record. Keep concise: 5-15 steps is ideal. Do NOT pad with wait steps — pace handles timing.

• variablesobject

  Key-value map for variable substitution in step URLs/values. E.g. { "base_url": "https://example.com" } replaces {{base_url}} in steps.

• viewportobject

  Browser viewport size

• zoomobject

  Global zoom settings. Only use when the user explicitly requests zoom. Do NOT enable by default.

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: false)

• blockChatsboolean

  Block live chat widgets

• blockTrackersboolean

  Block tracking scripts

• darkModeboolean

  Emulate dark color scheme (default: false)

• deviceScaleFactornumber

  Device pixel ratio (default: 1)

• observeAfterEachStepboolean

  FREE (no extra request charged). After every step, attach a compact, token-budgeted state snapshot — page type + the top interactive elements (id/role/name/selector) + suggested actions, NO screenshot. Use this when a step might open a dropdown/popover/modal or navigate: read the trace to confirm what is now on screen and pick the right selector for the NEXT call, instead of blind-batching. Hidden/off-screen elements are filtered out.

• session_idstring

  Persistent session ID (Starter+ only). Reuse a live browser page created with create_session — browser state (cookies, localStorage, auth) carries over from previous requests in this session.

• stepsobject[]обязательный

  Array of steps to execute in order. Must include at least one output step (screenshot, pdf, or diff). Max 20 steps, max 5 outputs.

• viewportobject

  Browser viewport size

• authorizationstring

  Authorization header value (e.g. "Bearer <token>")

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: false)

• blockChatsboolean

  Block live chat widgets on the page

• blockRequestsstring[]

  URL patterns to block (array of strings)

• blockResourcesstring[]

  Resource types to block (e.g. ["image", "font"])

• blockTrackersboolean

  Block tracking scripts on the page

• bypassCSPboolean

  Bypass Content-Security-Policy on the page

• clickstring

  CSS selector to click before capturing the screenshot

• clipobject

  Crop region { x, y, width, height } in pixels

• cookiesstring | object[]

  Cookies to set — array of "name=value" strings or { name, value, domain? } objects

• darkModeboolean

  Emulate dark color scheme (default: false)

• delayinteger

  Milliseconds to wait before capture (default: 0)

• deviceScaleFactornumber

  Device pixel ratio, use 2 for retina (default: 1)

• extractMetadataboolean

  Extract page metadata (title, description, OG tags) alongside the screenshot

• formatenum

  Image format (default: png)

• fullPageboolean

  Capture the full scrollable page (default: false)

• fullPageMaxHeightinteger

  Maximum pixel height cap for full-page captures

• fullPageScrollboolean

  Auto-scroll page before capture to trigger lazy-loaded images

• fullPageScrollByinteger

  Pixels to scroll per step (default: viewport height)

• fullPageScrollDelayinteger

  Delay between scroll steps in ms (default: 400)

• geolocationobject

  Emulate geolocation { latitude, longitude, accuracy? }

• headersobject

  Extra HTTP headers to send with the request

• heightinteger

  Viewport height in pixels (default: 720)

• hideSelectorsstring[]

  Array of CSS selectors to hide before capture

• htmlstring

  Raw HTML to render (required if no url/markdown)

• injectCssstring

  Custom CSS to inject before capturing (max 50KB)

• injectJsstring

  Custom JavaScript to execute before capturing (max 50KB)

• markdownstring

  Render Markdown content as a screenshot

• mediaTypeenum

  Emulate CSS media type

• navigationTimeoutinteger

  Navigation timeout in ms (default: 25000)

• omitBackgroundboolean

  Transparent background (PNG/WebP only)

• qualityinteger

  JPEG/WebP quality 1-100 (default: 80)

• reducedMotionboolean

  Emulate prefers-reduced-motion to disable animations

• selectorstring

  CSS selector to capture a specific element

• session_idstring

  Persistent session ID (Starter+ only). Reuse a live browser page created with create_session — browser state (cookies, localStorage, auth) carries over from previous requests in this session.

• styleobject

  Screenshot styling options — add a macOS/Windows frame, gradient/glass background, shadow, and rounded corners. Use the "theme" shortcut for one-click presets, or customize individual properties.

• timeZonestring

  Override browser timezone (e.g. "America/New_York")

• urlstring

  URL to capture (required if no html/markdown)

• userAgentstring

  Override the browser User-Agent string

• viewportDevicestring

  Device preset for viewport emulation (e.g. "iphone_14_pro", "macbook_pro_14"). Use list_devices to see all presets.

• viewportHasTouchboolean

  Enable touch event emulation

• viewportLandscapeboolean

  Landscape orientation

• viewportMobileboolean

  Enable mobile meta viewport emulation

• waitForSelectorstring

  Wait for this CSS selector to appear before capturing

• waitUntilenum

  When to consider navigation finished (default: networkidle2)

• widthinteger

  Viewport width in pixels (default: 1280)

• authorizationstring

  Authorization header value (e.g. "Bearer <token>")

• blockAdsboolean

  Block advertisements on the page

• blockBannersboolean

  Hide cookie consent banners (default: false)

• blockChatsboolean

  Block live chat widgets on the page

• blockRequestsstring[]

  URL patterns to block (array of strings)

• blockResourcesstring[]

  Resource types to block (e.g. ["image", "font"])

• blockTrackersboolean

  Block tracking scripts on the page

• bypassCSPboolean

  Bypass Content-Security-Policy on the page

• clickstring

  CSS selector to click before capturing on both pages

• clipobject

  Crop region { x, y, width, height } in pixels

• cookiesstring | object[]

  Cookies to set — array of "name=value" strings or { name, value, domain? } objects

• darkModeboolean

  Emulate dark color scheme (default: false)

• delayinteger

  Milliseconds to wait before capture on both pages (default: 0)

• deviceScaleFactornumber

  Device pixel ratio (default: 1)

• fullPageboolean

  Capture the full scrollable page for both sides (default: false)

• fullPageMaxHeightinteger

  Maximum pixel height cap for full-page captures

• fullPageScrollboolean

  Auto-scroll pages before capture to trigger lazy-loaded images

• fullPageScrollByinteger

  Pixels to scroll per step (default: viewport height)

• fullPageScrollDelayinteger

  Delay between scroll steps in ms (default: 400)

• geolocationobject

  Emulate geolocation { latitude, longitude, accuracy? }

• headersobject

  Extra HTTP headers to send with the request

• heightinteger

  Viewport height in pixels (default: 720)

• hideSelectorsstring[]

  Array of CSS selectors to hide before capture

• html_astring

  Raw HTML for the first page (required if no url_a)

• html_bstring

  Raw HTML for the second page (required if no url_b)

• injectCssstring

  Custom CSS to inject before capturing (max 50KB)

• injectJsstring

  Custom JavaScript to execute before capturing (max 50KB)

• mediaTypeenum

  Emulate CSS media type

• navigationTimeoutinteger

  Navigation timeout in ms (default: 25000)

• reducedMotionboolean

  Emulate prefers-reduced-motion to disable animations

• selectorstring

  CSS selector — capture only this element on both pages

• thresholdnumber

  Pixelmatch sensitivity 0–1 (default: 0.1). Lower = more sensitive to subtle differences.

• timeZonestring

  Override browser timezone (e.g. "America/New_York")

• url_astring

  URL of the first page (required if no html_a)

• url_bstring

  URL of the second page (required if no html_b)

• userAgentstring

  Override the browser User-Agent string

• viewportDevicestring

  Device preset for viewport emulation (e.g. "iphone_14_pro"). Use list_devices to see all presets.

• viewportHasTouchboolean

  Enable touch event emulation

• viewportLandscapeboolean

  Landscape orientation

• viewportMobileboolean

  Enable mobile meta viewport emulation

• waitForSelectorstring

  Wait for this CSS selector to appear before capturing

• waitUntilenum

  When to consider navigation finished (default: networkidle2)

• widthinteger

  Viewport width in pixels (default: 1280)