The Config type defines all configuration options for customizing the Playwright MCP server behavior. All fields are optional.
Browser Configuration Browser-related configuration options. browserName
'chromium' | 'firefox' | 'webkit'
The type of browser to use. Defaults to 'chromium'.
Keep the browser profile in memory, do not save it to disk. When enabled, each session starts fresh.
Path to a user data directory for browser profile persistence. Temporary directory is created by default.
Launch options passed to Playwright’s launchPersistentContext. See Playwright LaunchOptions . Useful for settings like channel, headless, executablePath, etc. contextOptions
playwright.BrowserContextOptions
Context options for the browser context. Useful for settings like viewport, userAgent, locale, etc.
Chrome DevTools Protocol endpoint to connect to an existing browser instance (Chromium family browsers only).
CDP headers to send with the connect request.
Timeout in milliseconds for connecting to CDP endpoint. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
Remote endpoint to connect to an existing Playwright server.
Paths to TypeScript files to add as initialization scripts for Playwright page object. These scripts run with access to the page object.
Paths to JavaScript files to add as initialization scripts. The scripts will be evaluated in every page before any of the page’s scripts.
Extension Mode Connect to a running browser instance (Edge/Chrome only). If specified, browser config is ignored. Requires the “Playwright MCP Bridge” browser extension to be installed.
Server Configuration HTTP server configuration for SSE or MCP transport. The port to listen on for SSE or MCP transport.
The host to bind the server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
The hosts this server is allowed to serve from. Defaults to the host server is bound to. This is not for CORS, but rather for DNS rebinding protection.
Capabilities List of enabled tool capabilities. See Tool Capabilities for details. Possible values:
'config' - Configuration tools'core' - Core browser automation features'core-navigation' - Navigation tools'core-tabs' - Tab management'core-input' - Input and interaction tools'core-install' - Browser installation'network' - Network request inspection'pdf' - PDF generation'storage' - Storage management'testing' - Test assertions and verification'vision' - Coordinate-based interactions'devtools' - Developer tools features Session Recording Whether to save the Playwright session into the output directory.
Whether to save the Playwright trace of the session into the output directory.
If specified, saves the Playwright video of the session into the output directory. Browser Context Sharing Reuse the same browser context between all connected HTTP clients.
Secrets Management Secrets are used to prevent LLM from getting sensitive data while automating scenarios such as authentication. Note: Prefer browser.contextOptions.storageState over secrets file as a more secure alternative.
Output Configuration The directory to save output files (screenshots, PDFs, traces, etc.).
Whether to save snapshots, console messages, network logs and other session logs to a file or to the standard output. Defaults to 'stdout'.
Console Messages Console message configuration. level
'error' | 'warning' | 'info' | 'debug'
The level of console messages to return. Each level includes the messages of more severe levels. Defaults to 'info'.
Network Configuration Network request filtering configuration. List of origins to allow the browser to request. Default is to allow all. Origins matching both allowedOrigins and blockedOrigins will be blocked. Supported formats:
Full origin: https://example.com:8080 - matches only that origin
Wildcard port: http://localhost:* - matches any port on localhost with http protocol
List of origins to block the browser from requesting. Origins matching both allowedOrigins and blockedOrigins will be blocked. Supported formats:
Full origin: https://example.com:8080 - matches only that origin
Wildcard port: http://localhost:* - matches any port on localhost with http protocol
Test ID Attribute Specify the attribute to use for test ids. Defaults to 'data-testid'.
Timeouts Timeout configuration for actions and navigation. Image Responses Whether to send image responses to the client. Defaults to 'allow'.
Snapshot Configuration Page snapshot configuration. mode
'incremental' | 'full' | 'none'
When taking snapshots for responses, specifies the mode to use. Defaults to 'incremental'.
File Access allowUnrestrictedFileAccess
Whether to allow file uploads from anywhere on the file system. By default (false), file uploads are restricted to paths within the MCP roots only.
Code Generation Specify the language to use for code generation. Defaults to 'typescript'.
Complete Example import { createConnection } from '@playwright/mcp' ; const server = await createConnection ({ browser: { browserName: 'chromium' , isolated: false , userDataDir: './browser-profile' , launchOptions: { headless: true , args: [ '--no-sandbox' ] }, contextOptions: { viewport: { width: 1920 , height: 1080 }, userAgent: 'Custom MCP Agent' } }, server: { port: 8931 , host: '0.0.0.0' }, capabilities: [ 'core' , 'pdf' , 'vision' , 'testing' ], saveTrace: true , saveVideo: { width: 1280 , height: 720 }, outputDir: './output' , outputMode: 'file' , console: { level: 'info' }, network: { blockedOrigins: [ 'https://ads.example.com:*' ] }, timeouts: { action: 10000 , navigation: 30000 }, imageResponses: 'allow' , snapshot: { mode: 'incremental' }, codegen: 'typescript' });
