Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CAPS | No | Comma-separated list of capabilities to enable, possible values: tabs, pdf, history, wait, files, install. Default is all. | |
| HOST | No | Host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces. | |
| PORT | No | Port to listen on for SSE transport. | |
| CONFIG | No | Path to the configuration file. | |
| DEVICE | No | Device to emulate, for example: "iPhone 15". | |
| VISION | No | Set to 'true' to run server that uses screenshots (Aria snapshots are used by default). | |
| BROWSER | No | Browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge. | |
| HEADLESS | No | Set to 'true' to run browser in headless mode. Headed by default. | |
| ISOLATED | No | Keep the browser profile in memory, do not save it to disk. | |
| NO_SANDBOX | No | Set to 'true' to disable the sandbox for all process types that are normally sandboxed. | |
| OUTPUT_DIR | No | Path to the directory for output files. | |
| SAVE_TRACE | No | Set to 'true' to save the Playwright Trace of the session into the output directory. | |
| USER_AGENT | No | Specify user agent string. | |
| CDP_ENDPOINT | No | CDP endpoint to connect to. | |
| PROXY_BYPASS | No | Comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com". | |
| PROXY_SERVER | No | Specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080". | |
| BROWSER_AGENT | No | Use browser agent (experimental). | |
| STORAGE_STATE | No | Path to the storage state file for isolated sessions. | |
| USER_DATA_DIR | No | Path to the user data directory. If not specified, a temporary directory will be created. | |
| VIEWPORT_SIZE | No | Specify browser viewport size in pixels, for example "1280, 720". | |
| ALLOWED_ORIGINS | No | Semicolon-separated list of origins to allow the browser to request. Default is to allow all. | |
| BLOCKED_ORIGINS | No | Semicolon-separated list of origins to block the browser from requesting. Blocklist is evaluated before allowlist. | |
| EXECUTABLE_PATH | No | Path to the browser executable. | |
| IMAGE_RESPONSES | No | Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto". | |
| IGNORE_HTTPS_ERRORS | No | Set to 'true' to ignore https errors. | |
| BLOCK_SERVICE_WORKERS | No | Set to 'true' to block service workers. |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| browser_close | Close the page |
| browser_resize | Resize the browser window |
| browser_console_messages | Returns all console messages |
| browser_handle_dialog | Handle a dialog |
| browser_file_upload | Upload one or multiple files |
| browser_install | Install the browser specified in the config. Call this if you get an error about the browser not being installed. |
| browser_press_key | Press a key on the keyboard |
| browser_navigate | Navigate to a URL |
| browser_navigate_back | Go back to the previous page |
| browser_navigate_forward | Go forward to the next page |
| browser_network_requests | Returns all network requests since loading the page |
| browser_pdf_save | Save page as PDF |
| browser_take_screenshot | Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions. |
| browser_snapshot | Capture accessibility snapshot of the current page, this is better than screenshot |
| browser_click | Perform click on a web page |
| browser_drag | Perform drag and drop between two elements |
| browser_hover | Hover over element on page |
| browser_type | Type text into editable element |
| browser_select_option | Select an option in a dropdown |
| browser_tab_list | List browser tabs |
| browser_tab_new | Open a new tab |
| browser_tab_select | Select a tab by index |
| browser_tab_close | Close a tab |
| browser_generate_playwright_test | Generate a Playwright test for given scenario |
| browser_wait_for | Wait for text to appear or disappear or a specified time to pass |