browser_close
Close browser
Close the page
無需輸入參數。

io.github.microsoft由 GitHub 帳號 microsoft 發布v0.0.84更新於 Oct 31, 2026
Playwright Tools for MCP
Playwright MCP 讓助理透過結構化無障礙快照操作真實瀏覽器:導覽、點擊、填表、檢視網路與主控台、截圖。
Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。
參照 儲存庫 中的啟動說明。
A Model Context Protocol (MCP) server that provides browser automation capabilities using Playwright. This server enables LLMs to interact with web pages through structured accessibility snapshots, bypassing the need for screenshots or visually-tuned models.
This package provides MCP interface into Playwright. If you are using a coding agent, you might benefit from using the CLI+SKILLS instead.
CLI: Modern coding agents increasingly favor CLI–based workflows exposed as SKILLs over MCP because CLI invocations are more token-efficient: they avoid loading large tool schemas and verbose accessibility trees into the model context, allowing agents to act through concise, purpose-built commands. This makes CLI + SKILLs better suited for high-throughput coding agents that must balance browser automation with large codebases, tests, and reasoning within limited context windows.
Learn more about Playwright CLI with SKILLS.
MCP: MCP remains relevant for specialized agentic loops that benefit from persistent state, rich introspection, and iterative reasoning over page structure, such as exploratory automation, self-healing tests, or long-running autonomous workflows where maintaining continuous browser context outweighs token cost concerns.
First, install the Playwright MCP server with your client.
Standard config works in most of the tools:
[Install in VS Code] [Install in VS Code Insiders]
Add via the Amp VS Code extension settings screen or by updating your settings.json file:
Amp CLI Setup:
Add via the amp mcp add command below
Add via the Antigravity settings or by updating your configuration file:
Use the Claude Code CLI to add the Playwright MCP server:
Follow the MCP install guide, use the standard config above.
Follow the instruction in the section Configuring MCP Servers
Example: Local Setup
Add the following to your cline_mcp_settings.json file:
Use the Codex CLI to add the Playwright MCP server:
Alternatively, create or edit the configuration file ~/.codex/config.toml and add:
For more information, see the Codex MCP documentation.
Use the Copilot CLI to interactively add the Playwright MCP server:
Alternatively, create or edit the configuration file ~/.copilot/mcp-config.json and add:
For more information, see the Copilot CLI documentation.
Go to Cursor Settings -> MCP -> Add new MCP Server. Name to your liking, use command type with the command npx @playwright/mcp@latest. You can also verify config or add command like arguments via clicking Edit.
Use the Factory CLI to add the Playwright MCP server:
Alternatively, type /mcp within Factory droid to open an interactive UI for managing MCP servers.
For more information, see the Factory MCP documentation.
Follow the MCP install guide, use the standard config above.
Go to Advanced settings -> Extensions -> Add custom extension. Name to your liking, use type STDIO, and set the command to npx @playwright/mcp. Click "Add Extension".
Use the Grok CLI to add the Playwright MCP server:
Alternatively, create or edit the configuration file ~/.grok/config.toml and add:
For more information, see the Grok MCP documentation.
To add the Playwright MCP server in Junie CLI:
/mcpCtrl+A to add a new MCP serverAlternatively, add to .junie/mcp/mcp.json:
For more information, see the Junie MCP configuration documentation.
[Add MCP Server playwright to LM Studio]
Go to Program in the right sidebar -> Install -> Edit mcp.json. Use the standard config above.
Follow the MCP Servers documentation. For example in ~/.config/opencode/opencode.json:
Open Qodo Gen chat panel in VSCode or IntelliJ → Connect more tools → + Add new MCP → Paste the standard config above.
Click Save.
[Install in VS Code] [Install in VS Code Insiders]
Follow the MCP install guide, use the standard config above. You can also install the Playwright MCP server using the VS Code CLI:
After installation, the Playwright MCP server will be available for use with your GitHub Copilot agent in VS Code.
Go to Settings -> AI -> Manage MCP Servers -> + Add to add an MCP Server. Use the standard config above.
Alternatively, use the slash command /add-mcp in the Warp prompt and paste the standard config from above:
Follow Windsurf MCP documentation. Use the standard config above.
Playwright MCP server supports following arguments. They can be provided in the JSON configuration above, as a part of the "args" list:
You can run Playwright MCP with persistent profile like a regular browser (default), in isolated contexts for testing sessions, or connect to your existing browser using the browser extension.
Persistent profile
All the logged in information will be stored in the persistent profile, you can delete it between sessions if you'd like to clear the offline state.
Persistent profile is located at the following locations and you can override it with the --user-data-dir argument.
{workspace-hash} is derived from the MCP client's workspace root, so different projects get separate profiles automatically.
[!IMPORTANT] A persistent profile can only be used by one browser instance at a time, so concurrent MCP clients sharing the same workspace will conflict. To run several clients in parallel, start each additional client with
--isolatedor point it at a distinct--user-data-dir.
Isolated
In the isolated mode, each session is started in the isolated profile. Every time you ask MCP to close the browser,
the session is closed and all the storage state for this session is lost. You can provide initial storage state
to the browser via the config's contextOptions or via the --storage-state argument. Learn more about the storage
state here.
Browser Extension
The Playwright MCP Chrome Extension allows you to connect to existing browser tabs and leverage your logged-in sessions and browser state. See microsoft/playwright › packages/extension for installation and setup instructions.
There are multiple ways to provide the initial state to the browser context or a page.
For the storage state, you can either:
--user-data-dir argument. This will persist all browser data between the sessions.--storage-state argument. This will load cookies and local storage from the file into an isolated browser context.For the page state, you can use:
--init-page to point to a TypeScript file that will be evaluated on the Playwright page object. This allows you to run arbitrary code to set up the page.--init-script to point to a JavaScript file that will be added as an initialization script. The script will be evaluated in every page before any of the page's scripts.
This is useful for overriding browser APIs or setting up the environment.The Playwright MCP server can be configured using a JSON configuration file. You can specify the configuration file
using the --config command line option:
When running headed browser on system w/o display or from worker processes of the IDEs,
run the MCP server from environment with the DISPLAY and pass the --port flag to enable HTTP transport.
And then in MCP client config, set the url to the HTTP endpoint:
Playwright MCP is not a security boundary. See MCP Security Best Practices for guidance on securing your deployment.
NOTE: The Docker implementation only supports headless chromium at the moment.
Or If you prefer to run the container as a long-lived service instead of letting the MCP client spawn it, use:
The server will listen on host port 8931 and can be reached by any MCP client.
You can build the Docker image yourself.
element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectordoubleClick (boolean, optional): Whether to perform a double click instead of a single clickbutton (string, optional): Button to click, defaults to leftmodifiers (array, optional): Modifier keys to presslevel (string): Level of the console messages to return. Each level includes the messages of more severe levels. Defaults to "info".all (boolean, optional): Return all console messages since the beginning of the session, not just since the last navigation. Defaults to false.filename (string, optional): File name to save the console messages to. Relative file names are resolved against the workspace root. If not provided, messages are returned as text.startElement (string, optional): Human-readable source element description used to obtain the permission to interact with the elementstartTarget (string): Exact target element reference from the page snapshot, or a unique element selectorendElement (string, optional): Human-readable target element description used to obtain the permission to interact with the elementendTarget (string): Exact target element reference from the page snapshot, or a unique element selectorelement (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectorpaths (array, optional): Absolute paths to files to drop onto the element.data (object, optional): Data to drop, as a map of MIME type to string value (e.g. {"text/plain": "hello", "text/uri-list": "https://example.com"}).colorScheme (optional): Emulates the prefers-color-scheme media featurereducedMotion (optional): Emulates the prefers-reduced-motion media featureforcedColors (optional): Emulates the forced-colors media featurecontrast (optional): Emulates the prefers-contrast media featuremedia (optional): Changes the CSS media type of the pageelement (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string, optional): Exact target element reference from the page snapshot, or a unique element selectorfunction (string): () => { /* code / } or (element) => { / code */ } when element is providedfilename (string, optional): File name to save the result to. Relative file names are resolved against the workspace root. If not provided, result is returned as text.paths (array, optional): The absolute paths to the files to upload. Can be single file or multiple files. If omitted, file chooser is cancelled.fields (array): Fields to fill intext (string, optional): Plain text to search for in the page snapshot (case-insensitive substring match). Provide either text or regex, not both.regex (string, optional): Regular expression to search for in the page snapshot. Matching is case-sensitive by default; wrap the pattern in slashes to add flags, e.g. "/error/i" for case-insensitive. Provide either text or regex, not both.maxResults (number, optional): Maximum number of matching items to return. Defaults to returning all matches.filename (string, optional): Save results to a file instead of returning them in the response. Relative file names are resolved against the workspace root.accept (boolean): Whether to accept the dialog.promptText (string, optional): The text of the prompt in case of a prompt dialog.element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectorurl (string): The URL to navigate topart is set. Use the number from browser_network_requests.index (integer): 1-based index of the request, as printed by browser_network_requests.part (string, optional): Return only this part of the request. Omit to return full details.filename (string, optional): File name to save the result to. Relative file names are resolved against the workspace root. If not provided, output is returned as text.static (boolean): Whether to include successful static resources like images, fonts, scripts, etc. Defaults to false.filter (string, optional): Only return requests whose URL matches this regexp (e.g. "/api/.*user").all (boolean, optional): Return all network requests since the beginning of the session, not just since the last navigation. Defaults to false.filename (string, optional): File name to save the network requests to. Relative file names are resolved against the workspace root. If not provided, requests are returned as text.key (string): Name of the key to press or a character to generate, such as ArrowLeft or awidth (number): Width of the browser windowheight (number): Height of the browser windowcode (string, optional): A JavaScript function containing Playwright code to execute. It will be invoked with a single argument, page, which you can use for any page interaction. For example: async (page) => { await page.getByRole('button', { name: 'Submit' }).click(); return await page.title(); }filename (string, optional): Load code from the specified file. Relative file names are resolved against the workspace root. If both code and filename are provided, code will be ignored.element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectorvalues (array): Array of values to select in the dropdown. This can be a single value or multiple values.target (string, optional): Exact target element reference from the page snapshot, or a unique element selectorfilename (string, optional): Save snapshot to a file instead of returning it in the response. Relative file names are resolved against the workspace root.depth (number, optional): Limit the depth of the snapshot treeboxes (boolean, optional): Include each element's bounding box as [box=x,y,width,height] in the snapshot. Coordinates are viewport-relative, in CSS pixels (Element.getBoundingClientRect)element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string, optional): Exact target element reference from the page snapshot, or a unique element selectortype (string, optional): Image format for the screenshot. If unset, inferred from the filename extension, otherwise png.filename (string, optional): File name to save the screenshot to. Relative file names are resolved against the workspace root. If not specified, the screenshot is saved into the output directory as page-{timestamp}.{png|jpeg|webp}.fullPage (boolean, optional): When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Cannot be used with element screenshots.scale (string): Image resolution scale. "css" produces a screenshot sized in CSS pixels (smaller, consistent across devices). "device" produces a high-resolution screenshot using device pixels (larger, accounts for the device pixel ratio). Default is css.element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectortext (string): Text to type into the elementsubmit (boolean, optional): Whether to submit entered text (press Enter after)slowly (boolean, optional): Whether to type one character at a time. Useful for triggering key handlers in the page. By default entire text is filled in at once.time (number, optional): The time to wait in seconds, at most 30. When combined with text or textGone, serves as a timeout for them instead of the default action timeouttext (string, optional): The text to wait fortextGone (string, optional): The text to wait for to disappearaction (string): Operation to performindex (number, optional): Tab index, used for close/select. If omitted for close, current tab is closed.url (string, optional): URL to navigate to in the new tab, used for new.isolatedContext (string, optional): Name of an isolated browser context to create the new tab in, used for new. Tabs in the same isolated context share cookies and storage, tabs in different contexts are fully isolated. If omitted or "default", the tab is created in the default context.state (string): Set to "offline" to simulate offline mode, "online" to restore network connectivitypattern (string): URL pattern to match (e.g., "/api/users", "/*.{png,jpg}")status (number, optional): HTTP status code to return (default: 200)body (string, optional): Response body (text or JSON string)contentType (string, optional): Content-Type header (e.g., "application/json", "text/html")headers (array, optional): Headers to add in "Name: Value" formatremoveHeaders (string, optional): Comma-separated list of header names to remove from requestpattern (string, optional): URL pattern to unroute (omit to remove all routes)name (string): Cookie name to deletedomain (string, optional): Only delete the cookie on this domainpath (string, optional): Only delete the cookie on this pathname (string): Cookie name to getdomain (string, optional): Filter cookies by domainpath (string, optional): Filter cookies by pathname (string): Cookie namevalue (string): Cookie valuedomain (string, optional): Cookie domainpath (string, optional): Cookie pathexpires (number, optional): Cookie expiration as Unix timestamphttpOnly (boolean, optional): Whether the cookie is HTTP onlysecure (boolean, optional): Whether the cookie is securesameSite (string, optional): Cookie SameSite attributekey (string): Key to deletekey (string): Key to getkey (string): Key to setvalue (string): Value to setkey (string): Key to deletekey (string): Key to getkey (string): Key to setvalue (string): Value to setfilename (string): Path to the storage state file to restore from. Relative file names are resolved against the workspace root.filename (string, optional): File name to save the storage state to. Relative file names are resolved against the workspace root. If not specified, the storage state is saved into the output directory as storage-state-{timestamp}.json.element (string, optional): Human-readable element description used when adding the highlight; must match the value passed to browser_highlight.target (string, optional): Exact target element reference from the page snapshot, or a unique element selectorelement (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectorstyle (string, optional): Additional inline CSS applied to the highlight overlay, e.g. "outline: 2px dashed red".step (boolean, optional): When true, execution will pause again before the next action, allowing step-by-step debugging.location (string, optional): Pause execution at a specific :, e.g. "example.spec.ts:42".filename (string, optional): File name to save the video to. Relative file names are resolved against the workspace root. If not specified, the video is saved into the output directory as video-{timestamp}.webm.size (object, optional): Video sizefps (number, optional): Video frame rate in frames per second, defaults to 25cursor (boolean, optional): Render an animated mouse cursor that travels to each action point. Paces actions by 800ms so that the cursor has time to travel.title (string): Chapter titledescription (string, optional): Chapter descriptionduration (number, optional): Duration in milliseconds to show the chapter cardduration (number, optional): How long each action annotation stays on screen, in milliseconds. Defaults to 500.position (string, optional): Where to place the action title relative to the page. Defaults to top-right.cursor (string, optional): Cursor decoration for pointer actions. "pointer" (default) animates a mouse pointer from the previous action point to the next one; "none" disables the cursor decoration.style (object, optional): Styles of the action decorations.x (number): X coordinatey (number): Y coordinatebutton (string, optional): Button to click, defaults to leftclickCount (number, optional): Number of clicks, defaults to 1delay (number, optional): Time to wait between mouse down and mouse up in milliseconds, defaults to 0button (string, optional): Button to press, defaults to leftstartX (number): Start X coordinatestartY (number): Start Y coordinateendX (number): End X coordinateendY (number): End Y coordinatex (number): X coordinatey (number): Y coordinatebutton (string, optional): Button to press, defaults to leftdeltaX (number): X deltadeltaY (number): Y deltafilename (string, optional): File name to save the pdf to. Relative file names are resolved against the workspace root. If not specified, the pdf is saved into the output directory as page-{timestamp}.pdf.element (string, optional): Human-readable element description used to obtain permission to interact with the elementtarget (string): Exact target element reference from the page snapshot, or a unique element selectorrole (string): ROLE of the element. Can be found in the snapshot like this: - {ROLE} "Accessible Name":accessibleName (string): ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: - role "{ACCESSIBLE_NAME}"element (string): Human-readable list descriptiontarget (string): Exact target element reference that points to the listitems (array): Items to verifytext (string): TEXT to verify. Can be found in the snapshot like this: - role "Accessible Name": {TEXT} or like this: - text: {TEXT}type (string): Type of the elementelement (string): Human-readable element descriptiontarget (string): Exact target element reference from the page snapshotvalue (string): Value to verify. For checkbox, use "true" or "false".來源:README.md,提交 404be8e
Close browser
Close the page
無需輸入參數。
Resize browser window
Resize the browser window
width必填height必填Get console messages
Returns all console messages
alllevel必填filenameHandle a dialog
Handle a dialog
accept必填promptTextEmulate media features
Emulate CSS media features for the page, for example switch between the light and dark color scheme. Omitted parameters are left unchanged; null clears an override.
mediacontrastcolorSchemeforcedColorsreducedMotionEvaluate JavaScript
Evaluate JavaScript expression on page or element
targetelementfilenamefunction必填Upload files
Upload one or multiple files
pathsDrop files or data onto an element
Drop files or MIME-typed data onto an element, as if dragged from outside the page. At least one of "paths" or "data" must be provided.
datapathstarget必填elementFind in page snapshot
Search the accessibility snapshot of the current page for text or a regular expression. Returns matching snapshot nodes with a few lines of surrounding context (like search snippets), each shown under its path from the root of the tree, which is cheaper than capturing the whole snapshot when you only need to locate an element and its ref.
textregexfilenamemaxResultsFill form
Fill multiple form fields
fields必填Press a key
Press a key on the keyboard
key必填Type text
Type text into editable element
text必填slowlysubmittarget必填elementNavigate to a URL
Navigate to a URL
url必填Go back
Go back to the previous page in the history
無需輸入參數。
List network requests
Returns a numbered list of network requests since loading the page. Use browser_network_request with the number to get full details.
allfilterstatic必填filenameShow network request details
Returns full details (headers and body) of a single network request, or a single part if `part` is set. Use the number from browser_network_requests.
partindex必填filenameRun Playwright code (unsafe)
Run a Playwright code snippet. Unsafe: executes arbitrary JavaScript in the Playwright server process and is RCE-equivalent.
codefilenameTake a screenshot
Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.
typescale必填targetelementfilenamefullPagePage snapshot
Capture accessibility snapshot of the current page, this is better than screenshot
boxesdepthtargetfilenameClick
Perform click on a web page
buttontarget必填elementmodifiersdoubleClickDrag mouse
Perform drag and drop between two elements
endTarget必填endElementstartTarget必填startElementHover mouse
Hover over element on page
target必填elementSelect option
Select an option in a dropdown
target必填values必填elementManage tabs
List, create, close, or select a browser tab.
urlindexaction必填isolatedContextWait for
Wait for text to appear or disappear or a specified time to pass. When both text and textGone are provided, waits for the first one to happen
texttimetextGone已滿足適用檢查項的 90%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
{ "mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest" ] } }}"amp.mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest" ] }}amp mcp add playwright -- npx @playwright/mcp@latest{ "mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest" ] } }}claude mcp add playwright npx @playwright/mcp@latest{ "mcpServers": { "playwright": { "type": "stdio", "command": "npx", "timeout": 30, "args": [ "-y", "@playwright/mcp@latest" ], "disabled": false } }}codex mcp add playwright npx "@playwright/mcp@latest"[mcp_servers.playwright]command = "npx"args = ["@playwright/mcp@latest"]/mcp add{ "mcpServers": { "playwright": { "type": "local", "command": "npx", "tools": [ "*" ], "args": [ "@playwright/mcp@latest" ] } }}droid mcp add playwright "npx @playwright/mcp@latest"grok mcp add playwright -- npx @playwright/mcp@latest[mcp_servers.playwright]command = "npx"args = ["@playwright/mcp@latest"]{ "mcpServers": { "Playwright": { "command": "npx", "args": [ "-y", "@playwright/mcp@latest" ] } }}{ "mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest" ] } }}{ "$schema": "https://opencode.ai/config.json", "mcp": { "playwright": { "type": "local", "command": [ "npx", "@playwright/mcp@latest" ], "enabled": true } }}# For VS Codecode --add-mcp '{"name":"playwright","command":"npx","args":["@playwright/mcp@latest"]}'{ "mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest" ] } }}# Windows%USERPROFILE%\AppData\Local\ms-playwright\mcp-{channel}-{workspace-hash}
# macOS- ~/Library/Caches/ms-playwright/mcp-{channel}-{workspace-hash}
# Linux- ~/.cache/ms-playwright/mcp-{channel}-{workspace-hash}{ "mcpServers": { "playwright": { "command": "npx", "args": [ "@playwright/mcp@latest", "--isolated", "--storage-state={path/to/storage.json}" ] } }}// init-page.tsexport default async ({ page }) => { await page.context().grantPermissions(['geolocation']); await page.context().setGeolocation({ latitude: 37.7749, longitude: -122.4194 }); await page.setViewportSize({ width: 1280, height: 720 });};// init-script.jswindow.isPlaywrightMCP = true;npx @playwright/mcp@latest --config path/to/config.json{ /** * The browser to use. */ browser?: { /** * The type of browser to use. */ browserName?: 'chromium' | 'firefox' | 'webkit';
/** * Keep the browser profile in memory, do not save it to disk. */ isolated?: boolean;
/** * Path to a user data directory for browser profile persistence. * Temporary directory is created by default. */ userDataDir?: string;
/** * Launch options passed to * @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context * * This is useful for settings options like `channel`, `headless`, `executablePath`, etc. */ launchOptions?: playwright.LaunchOptions;
/** * Context options for the browser context. * * This is useful for settings options like `viewport`. */ contextOptions?: playwright.BrowserContextOptions;
/** * Chrome DevTools Protocol endpoint to connect to an existing browser instance in case of Chromium family browsers. */ cdpEndpoint?: string;
/** * CDP headers to send with the connect request. */ cdpHeaders?: Record<string, string>;
/** * Timeout in milliseconds for connecting to CDP endpoint. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. */ cdpTimeout?: number;
/** * Remote endpoint to connect to an existing Playwright server. May be a * WebSocket URL string, or a [ConnectOptions] object that mirrors the * `connectOptions` shape used by the test runner. When passed as an object, * `exposeNetwork`, `headers`, `slowMo`, and `timeout` are forwarded to the * underlying connect call. */ remoteEndpoint?: string | playwright.ConnectOptions & { endpoint: string };
/** * Paths to TypeScript files to add as initialization scripts for Playwright page. */ initPage?: string[];
/** * Paths to JavaScript files to add as initialization scripts. * The scripts will be evaluated in every page before any of the page's scripts. */ initScript?: string[]; },
/** * Connect to a running browser instance (Edge/Chrome only). If specified, `browser` * config is ignored. * Requires the "Playwright Extension" to be installed. */ extension?: boolean;
/** * Group controlled tabs when using the extension. Defaults to true. */ tabGroup?: boolean;
/** * Do not activate controlled tabs or focus the browser window when using the extension. * Defaults to false. */ background?: boolean;
server?: { /** * The port to listen on for SSE or MCP transport. */ port?: number;
/** * The host to bind the server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces. */ host?: string;
/** * The hosts this server is allowed to serve from. Defaults to localhost, loopback IPs and the host passed via --host; other hosts must be listed explicitly. * This is not for CORS, but rather for the DNS rebinding protection. */ allowedHosts?: string[]; },
/** * List of enabled tool capabilities. Possible values: * - 'core': Core browser automation features. * - 'pdf': PDF generation and manipulation. * - 'vision': Coordinate-based interactions. * - 'devtools': Developer tools features. */ capabilities?: ToolCapability[];
/** * Whether to save the Playwright session into the output directory. */ saveSession?: boolean;
/** * Whether to collect and expose the tools that a page registers through the * experimental WebMCP API. Enabled by default. */ webmcp?: boolean;
/** * Reuse the same browser context between all connected HTTP clients. */ sharedBrowserContext?: boolean;
/** * Secrets are used to replace matching plain text in the tool responses to prevent the LLM * from accidentally getting sensitive data. It is a convenience and not a security feature, * make sure to always examine information coming in and from the tool on the client. */ secrets?: Record<string, string>;
/** * Names of URL query and fragment parameters, for example `access_token` or `code`, whose values * are replaced with `<redacted>` in the tool responses. Use it for session and grant values that * are minted at runtime and cannot be listed in `secrets`. Like `secrets`, it is a convenience * and not a security feature. */ redactUrlParams?: string[];
/** * The directory for automatically named output files, for example a screenshot taken without an * explicit file name. Files with an explicit name are resolved against the workspace root instead * and are not affected by this option. */ outputDir?: string;
/** * Threshold for evicting old output files, in bytes. */ outputMaxSize?: number;
console?: { /** * The level of console messages to return. Each level includes the messages of more severe levels. Defaults to "info". */ level?: 'error' | 'warning' | 'info' | 'debug'; },
network?: { /** * 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 */ allowedOrigins?: string[];
/** * List of origins to block the browser to request. 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 */ blockedOrigins?: string[]; };
/** * Specify the attribute to use for test ids, defaults to "data-testid". */ testIdAttribute?: string;
timeouts?: { /* * Configures default action timeout: https://playwright.dev/docs/api/class-page#page-set-default-timeout. Defaults to 5000ms. */ action?: number;
/* * Configures default navigation timeout: https://playwright.dev/docs/api/class-page#page-set-default-navigation-timeout. Defaults to 60000ms. */ navigation?: number;
/** * Configures default expect timeout: https://playwright.dev/docs/test-timeouts#expect-timeout. Defaults to 5000ms. */ expect?: number;
/** * How long to wait after each action for triggered work (navigations, requests) to settle before responding. Defaults to 500ms. */ settle?: number;
/** * Close the browser after this many milliseconds without a tool call, and relaunch it on the next one. * Defaults to one hour for headless browsers Playwright launched, and to no timeout for headed or attached ones. Pass 0 to disable. * The CLI shuts the whole session down instead of relaunching. */ idle?: number; };
/** * Whether to send image responses to the client. Can be "allow", "omit", or "only". Defaults to "allow". * With "only", a response that carries an image consists of the image parts alone, without the text part. */ imageResponses?: 'allow' | 'omit' | 'only';
/** * How file paths are rendered in tool results. Can be "relative" to the workspace root or "absolute". Defaults to "relative". */ filePaths?: 'relative' | 'absolute';
snapshot?: { /** * When taking snapshots for responses, specifies the mode to use. */ mode?: 'full' | 'none';
/** * Whether to include each element's bounding box as [box=x,y,width,height] in snapshots. * Coordinates are viewport-relative, in CSS pixels (Element.getBoundingClientRect). */ boxes?: boolean; };
/** * allowUnrestrictedFileAccess acts as a guardrail to prevent the LLM from accidentally * wandering outside its intended workspace. It is a convenience defense to catch unintended * file access, not a secure boundary; a deliberate attempt to reach other directories can be * easily worked around, so always rely on client-level permissions for true security. */ allowUnrestrictedFileAccess?: boolean;
/** * Do not ask the client for its workspace roots, use the current working directory * as the workspace root instead. Use this with clients that advertise roots, but * can not answer the roots request. */ ignoreRoots?: boolean;
/** * Specify the language to use for code generation. */ codegen?: 'typescript' | 'python' | 'java' | 'csharp' | 'none';}npx @playwright/mcp@latest --port 8931{ "mcpServers": { "playwright": { "url": "http://localhost:8931/mcp" } }}{ "mcpServers": { "playwright": { "command": "docker", "args": ["run", "-i", "--rm", "--init", "--pull=always", "mcr.microsoft.com/playwright/mcp"] } }}docker run -d -i --rm --init --pull=always \ --entrypoint node \ --name playwright \ -p 8931:8931 \ mcr.microsoft.com/playwright/mcp \ /app/cli.js --headless --browser chromium --no-sandbox --port 8931 --host 0.0.0.0docker build -t mcr.microsoft.com/playwright/mcp .import http from 'http';
import { createConnection } from '@playwright/mcp';import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
http.createServer(async (req, res) => { // ...
// Creates a headless Playwright MCP server with SSE transport const connection = await createConnection({ browser: { launchOptions: { headless: true } } }); const transport = new SSEServerTransport('/messages', res); await connection.connect(transport);
// ...});