devops(bots): publish the agent’s GitHub writes as typed calls (#1817)
Summary
- Switch
triage.ymlandrevision.ymlto thepublish-callsaction of microsoft/playwright. The agent lists its GitHub writes as typed calls incalls.json, and one job checks and makes them. The publish job adds the “could not finish” comment and hides the run link.- A fix in microsoft/playwright is a
pull-requestcall for that repo. The publish job checks out microsoft/playwright inplaywright/at the commit that the agent worked on, and the action opens the PR there.- Merge right after microsoft/playwright#43838: these workflows call its actions at
@main.
版权所有:中国计算机学会技术支持:开源发展技术委员会
京ICP备13000930号-9
京公网安备 11010802047560号
Playwright MCP
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.
Playwright MCP vs Playwright CLI
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.
Key Features
Requirements
Getting started
First, install the Playwright MCP server with your client.
Standard config works in most of the tools:
Amp
Add via the Amp VS Code extension settings screen or by updating your settings.json file:
Amp CLI Setup:
Add via the
amp mcp addcommand belowAntigravity
Add via the Antigravity settings or by updating your configuration file:
Claude Code
Use the Claude Code CLI to add the Playwright MCP server:
Claude Desktop
Follow the MCP install guide, use the standard config above.
Cline
Follow the instruction in the section Configuring MCP Servers
Example: Local Setup
Add the following to your
cline_mcp_settings.jsonfile:Codex
Use the Codex CLI to add the Playwright MCP server:
Alternatively, create or edit the configuration file
~/.codex/config.tomland add:For more information, see the Codex MCP documentation.
Copilot
Use the Copilot CLI to interactively add the Playwright MCP server:
Alternatively, create or edit the configuration file
~/.copilot/mcp-config.jsonand add:For more information, see the Copilot CLI documentation.
Cursor
Click the button to install:
Or install manually:
Go to
Cursor Settings->MCP->Add new MCP Server. Name to your liking, usecommandtype with the commandnpx @playwright/mcp@latest. You can also verify config or add command like arguments via clickingEdit.Factory
Use the Factory CLI to add the Playwright MCP server:
Alternatively, type
/mcpwithin Factory droid to open an interactive UI for managing MCP servers.For more information, see the Factory MCP documentation.
Gemini CLI
Follow the MCP install guide, use the standard config above.
Goose
Click the button to install:
Or install manually:
Go to
Advanced settings->Extensions->Add custom extension. Name to your liking, use typeSTDIO, and set thecommandtonpx @playwright/mcp. Click “Add Extension”.Grok
Use the Grok CLI to add the Playwright MCP server:
Alternatively, create or edit the configuration file
~/.grok/config.tomland add:For more information, see the Grok MCP documentation.
Junie
To add the Playwright MCP server in Junie CLI:
/mcpCtrl+Ato add a new MCP serverAlternatively, add to
.junie/mcp/mcp.json:For more information, see the Junie MCP configuration documentation.
Kiro
Follow the MCP Servers documentation. For example in
.kiro/settings/mcp.json:LM Studio
Click the button to install:
Or install manually:
Go to
Programin the right sidebar ->Install->Edit mcp.json. Use the standard config above.opencode
Follow the MCP Servers documentation. For example in
~/.config/opencode/opencode.json:Qodo Gen
Open Qodo Gen chat panel in VSCode or IntelliJ → Connect more tools → + Add new MCP → Paste the standard config above.
Click
Save.VS Code
Click the button to install:
Or install manually:
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.
Warp
Go to
Settings->AI->Manage MCP Servers->+ Addto add an MCP Server. Use the standard config above.Alternatively, use the slash command
/add-mcpin the Warp prompt and paste the standard config from above:Windsurf
Follow Windsurf MCP documentation. Use the standard config above.
Configuration
Playwright MCP server supports following arguments. They can be provided in the JSON configuration above, as a part of the
"args"list:env
PLAYWRIGHT_MCP_ALLOWED_HOSTSenv
PLAYWRIGHT_MCP_ALLOWED_ORIGINSenv
PLAYWRIGHT_MCP_ALLOW_UNRESTRICTED_FILE_ACCESSenv
PLAYWRIGHT_MCP_BLOCKED_ORIGINSenv
PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERSenv
PLAYWRIGHT_MCP_BROWSERenv
PLAYWRIGHT_MCP_CAPSenv
PLAYWRIGHT_MCP_CDP_ENDPOINTenv
PLAYWRIGHT_MCP_CDP_HEADERSenv
PLAYWRIGHT_MCP_CDP_TIMEOUTenv
PLAYWRIGHT_MCP_CODEGENenv
PLAYWRIGHT_MCP_CONFIGenv
PLAYWRIGHT_MCP_CONSOLE_LEVELenv
PLAYWRIGHT_MCP_DEVICEenv
PLAYWRIGHT_MCP_MOBILEenv
PLAYWRIGHT_MCP_EXECUTABLE_PATHenv
PLAYWRIGHT_MCP_EXTENSIONenv
PLAYWRIGHT_MCP_ENDPOINTenv
PLAYWRIGHT_MCP_FILE_PATHSenv
PLAYWRIGHT_MCP_GRANT_PERMISSIONSenv
PLAYWRIGHT_MCP_HEADLESSenv
PLAYWRIGHT_MCP_HOSTenv
PLAYWRIGHT_MCP_IDLE_TIMEOUTenv
PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORSenv
PLAYWRIGHT_MCP_IGNORE_ROOTSenv
PLAYWRIGHT_MCP_INIT_PAGEenv
PLAYWRIGHT_MCP_INIT_SCRIPTenv
PLAYWRIGHT_MCP_ISOLATEDenv
PLAYWRIGHT_MCP_IMAGE_RESPONSESenv
PLAYWRIGHT_MCP_NO_SANDBOXenv
PLAYWRIGHT_MCP_WEBMCP=falseenv
PLAYWRIGHT_MCP_OUTPUT_DIRenv
PLAYWRIGHT_MCP_OUTPUT_MAX_SIZEenv
PLAYWRIGHT_MCP_PORTenv
PLAYWRIGHT_MCP_PROFILE_DIR_NAMEenv
PLAYWRIGHT_MCP_PROXY_BYPASSenv
PLAYWRIGHT_MCP_PROXY_SERVERenv
PLAYWRIGHT_MCP_REDACT_URL_PARAMSenv
PLAYWRIGHT_MCP_SANDBOXenv
PLAYWRIGHT_MCP_SAVE_SESSIONenv
PLAYWRIGHT_MCP_SECRETS_FILEenv
PLAYWRIGHT_MCP_SHARED_BROWSER_CONTEXTenv
PLAYWRIGHT_MCP_SNAPSHOT_BOXESenv
PLAYWRIGHT_MCP_SNAPSHOT_MODEenv
PLAYWRIGHT_MCP_STORAGE_STATEenv
PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTEenv
PLAYWRIGHT_MCP_TIMEOUT_ACTIONenv
PLAYWRIGHT_MCP_TIMEOUT_NAVIGATIONenv
PLAYWRIGHT_MCP_TIMEOUT_SETTLEenv
PLAYWRIGHT_MCP_USER_AGENTenv
PLAYWRIGHT_MCP_USER_DATA_DIRenv
PLAYWRIGHT_MCP_VIEWPORT_SIZEUser profile
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-dirargument.{workspace-hash}is derived from the MCP client’s workspace root, so different projects get separate profiles automatically.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
contextOptionsor via the--storage-stateargument. 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.
Initial state
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-dirargument. This will persist all browser data between the sessions.--storage-stateargument. This will load cookies and local storage from the file into an isolated browser context.For the page state, you can use:
--init-pageto 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-scriptto 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.Configuration file
The Playwright MCP server can be configured using a JSON configuration file. You can specify the configuration file using the
--configcommand line option:Configuration file schema
Standalone MCP server
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
--portflag to enable HTTP transport.And then in MCP client config, set the
urlto the HTTP endpoint:Security
Playwright MCP is not a security boundary. See MCP Security Best Practices for guidance on securing your deployment.
Docker
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.
Programmatic usage
Tools
Core automation
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 topartis 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 asArrowLeftorawidth(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 aspage-{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 disappearTab management
action(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.Browser installation
Configuration (opt-in via --caps=config)
Network (opt-in via --caps=network)
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)Storage (opt-in via --caps=storage)
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 asstorage-state-{timestamp}.json.DevTools (opt-in via --caps=devtools)
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 :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 asvideo-{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.Coordinate-based (opt-in via --caps=vision)
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 deltaPDF generation (opt-in via --caps=pdf)
filename(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 aspage-{timestamp}.pdf.Test assertions (opt-in via --caps=testing)
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”.