Playwright

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.<br>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

• Fast and lightweight. Uses Playwright's accessibility tree, not pixel-based input.
• LLM-friendly. No vision models needed, operates purely on structured data.
• Deterministic tool application. Avoids ambiguity common with screenshot-based approaches.

Requirements

• Node.js 18 or newer
• VS Code, Cursor, Windsurf, Claude Desktop, Goose, Grok, Junie or any other MCP client

<!-- // Generate using: node utils/generate-links.js -->

Getting started

First, install the Playwright MCP server with your client.

Standard config works in most of the tools:

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": [
        "@playwright/mcp@latest"
      ]
    }
  }
}

<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code"> <img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">

<details> <summary>Amp</summary>

Add via the Amp VS Code extension settings screen or by updating your settings.json file:

"amp.mcpServers": {
  "playwright": {
    "command": "npx",
    "args": [
      "@playwright/mcp@latest"
    ]
  }
}

Amp CLI Setup:

Add via the amp mcp add command below

amp mcp add playwright -- npx @playwright/mcp@latest

</details> <details> <summary>Antigravity</summary>

Add via the Antigravity settings or by updating your configuration file:

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": [
        "@playwright/mcp@latest"
      ]
    }
  }
}

</details> <details> <summary>Claude Code</summary>

Use the Claude Code CLI to add the Playwright MCP server:

claude mcp add playwright npx @playwright/mcp@latest

</details> <details> <summary>Claude Desktop</summary>

Follow the MCP install guide, use the standard config above.

</details> <details> <summary>Cline</summary>

Follow the instruction in the section Configuring MCP Servers

Example: Local Setup

Add the following to your cline_mcp_settings.json file:

{
  "mcpServers": {
    "playwright": {
      "type": "stdio",
      "command": "npx",
      "timeout": 30,
      "args": [
        "-y",
        "@playwright/mcp@latest"
      ],
      "disabled": false
    }
  }
}

</details> <details> <summary>Codex</summary>

Use the Codex CLI to add the Playwright MCP server:

codex mcp add playwright npx "@playwright/mcp@latest"

Alternatively, create or edit the configuration file ~/.codex/config.toml and add:

[mcp_servers.playwright]
command = "npx"
args = ["@playwright/mcp@latest"]

For more information, see the Codex MCP documentation.

</details> <details> <summary>Copilot</summary>

Use the Copilot CLI to interactively add the Playwright MCP server:

/mcp add

Alternatively, create or edit the configuration file ~/.copilot/mcp-config.json and add:

{
  "mcpServers": {
    "playwright": {
      "type": "local",
      "command": "npx",
      "tools": [
        "*"
      ],
      "args": [
        "@playwright/mcp@latest"
      ]
    }
  }
}

For more information, see the Copilot CLI documentation.

</details> <details> <summary>Cursor</summary>

Click the button to install:

<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">

Or install manually:

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.

</details> <details> <summary>Factory</summary>

Use the Factory CLI to add the Playwright MCP server:

droid mcp add playwright "npx @playwright/mcp@latest"

Alternatively, type /mcp within Factory droid to open an interactive UI for managing MCP servers.

For more information, see the Factory MCP documentation.

</details> <details> <summary>Gemini CLI</summary>

Follow the MCP install guide, use the standard config above.

</details> <details> <summary>Goose</summary>

Click the button to install:

Or install manually:

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".

</details> <details> <summary>Grok</summary>

Use the Grok CLI to add the Playwright MCP server:

grok mcp add playwright -- npx @playwright/mcp@latest

Alternatively, create or edit the configuration file ~/.grok/config.toml and add:

[mcp_servers.playwright]
command = "npx"
args = ["@playwright/mcp@latest"]

For more information, see the Grok MCP documentation.

</details> <details> <summary>Junie</summary>

To add the Playwright MCP server in Junie CLI:

1. Type /mcp
2. Press Ctrl+A to add a new MCP server
3. Select Playwright from the list

Alternatively, add to .junie/mcp/mcp.json:

{
  "mcpServers": {
    "Playwright": {
      "command": "npx",
      "args": [
        "-y",
        "@playwright/mcp@latest"
      ]
    }
  }
}

For more information, see the Junie MCP configuration documentation.

</details> <details> <summary>Kiro</summary>

Follow the MCP Servers documentation. For example in .kiro/settings/mcp.json:

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": [
        "@playwright/mcp@latest"
      ]
    }
  }
}

</details> <details> <summary>LM Studio</summary>

Click the button to install:

Or install manually:

Go to Program in the right sidebar -> Install -> Edit mcp.json. Use the standard config above.

</details> <details> <summary>opencode</summary>

Follow the MCP Servers documentation. For example in ~/.config/opencode/opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "playwright": {
      "type": "local",
      "command": [
        "npx",
        "@playwright/mcp@latest"
      ],
      "enabled": true
    }
  }
}

</details> <details> <summary>Qodo Gen</summary>

Open Qodo Gen chat panel in VSCode or IntelliJ → Connect more tools → + Add new MCP → Paste the standard config above.

Click <code>Save</code>.

</details> <details> <summary>VS Code</summary>

Click the button to install:

<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code"> <img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">

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:

# For VS Code
code --add-mcp '{"name":"playwright","command":"npx","args":["@playwright/mcp@latest"]}'

After installation, the Playwright MCP server will be available for use with your GitHub Copilot agent in VS Code.

</details> <details> <summary>Warp</summary>

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:

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": [
        "@playwright/mcp@latest"
      ]
    }
  }
}

</details> <details> <summary>Windsurf</summary>

Follow Windsurf MCP documentation. Use the standard config above.

</details>

Configuration

Playwright MCP server supports following arguments. They can be provided in the JSON configuration above, as a part of the "args" list:

<!--- Options generated by update-readme.js -->

Option	Description
--allowed-hosts <hosts...>	comma-separated list of hosts this server is allowed to serve from. Defaults to the host the server is bound to. Pass '' to disable the host check.<br>env* PLAYWRIGHT_MCP_ALLOWED_HOSTS
--allowed-origins <origins>	semicolon-separated list of TRUSTED origins to allow the browser to request. Default is to allow all. Important: does not serve as a security boundary and does not affect redirects.<br>env PLAYWRIGHT_MCP_ALLOWED_ORIGINS
--allow-unrestricted-file-access	allow access to files outside of the workspace roots. Also allows unrestricted access to file:// URLs. By default access to file system is restricted to workspace root directories (or cwd if no roots are configured) only, and navigation to file:// URLs is blocked.<br>env PLAYWRIGHT_MCP_ALLOW_UNRESTRICTED_FILE_ACCESS
--blocked-origins <origins>	semicolon-separated list of origins to block the browser from requesting. Blocklist is evaluated before allowlist. If used without the allowlist, requests not matching the blocklist are still allowed. Important: does not serve as a security boundary and does not affect redirects.<br>env PLAYWRIGHT_MCP_BLOCKED_ORIGINS
--block-service-workers	block service workers<br>env PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERS
--browser <browser>	browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.<br>env PLAYWRIGHT_MCP_BROWSER
--caps <caps>	comma-separated list of additional capabilities to enable, possible values: vision, pdf, devtools.<br>env PLAYWRIGHT_MCP_CAPS
--cdp-endpoint <endpoint>	CDP endpoint to connect to.<br>env PLAYWRIGHT_MCP_CDP_ENDPOINT
--cdp-header <headers...>	CDP headers to send with the connect request, multiple can be specified.<br>env PLAYWRIGHT_MCP_CDP_HEADERS
--cdp-timeout <timeout>	timeout in milliseconds for connecting to CDP endpoint, defaults to 30000ms<br>env PLAYWRIGHT_MCP_CDP_TIMEOUT
--codegen <lang>	specify the language to use for code generation, possible values: "typescript", "python", "java", "csharp", "none". Default is "typescript".<br>env PLAYWRIGHT_MCP_CODEGEN
--config <path>	path to the configuration file.<br>env PLAYWRIGHT_MCP_CONFIG
--console-level <level>	level of console messages to return: "error", "warning", "info", "debug". Each level includes the messages of more severe levels.<br>env PLAYWRIGHT_MCP_CONSOLE_LEVEL
--device <device>	device to emulate, for example: "iPhone 15"<br>env PLAYWRIGHT_MCP_DEVICE
--mobile	emulate a generic mobile device (Pixel 10 for Chromium, iPhone 17 for WebKit). Mobile pages are usually lighter, which saves tokens. Cannot be combined with --device.<br>env PLAYWRIGHT_MCP_MOBILE
--executable-path <path>	path to the browser executable.<br>env PLAYWRIGHT_MCP_EXECUTABLE_PATH
--extension	Connect to a running browser instance (Edge/Chrome only). Requires the "Playwright Extension" to be installed.<br>env PLAYWRIGHT_MCP_EXTENSION
--endpoint <endpoint>	Bound browser endpoint to connect to.<br>env PLAYWRIGHT_MCP_ENDPOINT
--grant-permissions <permissions...>	List of permissions to grant to the browser context, for example "geolocation", "clipboard-read", "clipboard-write".<br>env PLAYWRIGHT_MCP_GRANT_PERMISSIONS
--headless	run browser in headless mode, headed by default<br>env PLAYWRIGHT_MCP_HEADLESS
--host <host>	host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.<br>env PLAYWRIGHT_MCP_HOST
--ignore-https-errors	ignore https errors<br>env PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORS
--init-page <path...>	path to TypeScript file to evaluate on Playwright page object<br>env PLAYWRIGHT_MCP_INIT_PAGE
--init-script <path...>	path to JavaScript file to add as an initialization script. The script will be evaluated in every page before any of the page's scripts. Can be specified multiple times.<br>env PLAYWRIGHT_MCP_INIT_SCRIPT
--isolated	keep the browser profile in memory, do not save it to disk.<br>env PLAYWRIGHT_MCP_ISOLATED
--image-responses <mode>	whether to send image responses to the client. Can be "allow" or "omit", Defaults to "allow".<br>env PLAYWRIGHT_MCP_IMAGE_RESPONSES
--no-sandbox	disable the sandbox for all process types that are normally sandboxed.<br>env PLAYWRIGHT_MCP_NO_SANDBOX
--output-dir <path>	path to the directory for output files.<br>env PLAYWRIGHT_MCP_OUTPUT_DIR
--output-max-size <bytes>	Threshold for evicting old output files, in bytes.<br>env PLAYWRIGHT_MCP_OUTPUT_MAX_SIZE
--port <port>	port to listen on for SSE transport.<br>env PLAYWRIGHT_MCP_PORT
--proxy-bypass <bypass>	comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"<br>env PLAYWRIGHT_MCP_PROXY_BYPASS
--proxy-server <proxy>	specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"<br>env PLAYWRIGHT_MCP_PROXY_SERVER
--sandbox	enable the sandbox for all process types that are normally not sandboxed.<br>env PLAYWRIGHT_MCP_SANDBOX
--save-session	Whether to save the Playwright MCP session into the output directory.<br>env PLAYWRIGHT_MCP_SAVE_SESSION
--secrets <path>	path to a file containing secrets in the dotenv format<br>env PLAYWRIGHT_MCP_SECRETS_FILE
--shared-browser-context	reuse the same browser context between all connected HTTP clients.<br>env PLAYWRIGHT_MCP_SHARED_BROWSER_CONTEXT
--snapshot-boxes	include each element's bounding box as [box=x,y,width,height] in snapshots. Coordinates are viewport-relative, in CSS pixels.<br>env PLAYWRIGHT_MCP_SNAPSHOT_BOXES
--snapshot-mode <mode>	when taking snapshots for responses, specifies the mode to use. Can be "full" or "none". Default is "full".<br>env PLAYWRIGHT_MCP_SNAPSHOT_MODE
--storage-state <path>	path to the storage state file for isolated sessions.<br>env PLAYWRIGHT_MCP_STORAGE_STATE
--test-id-attribute <attribute>	specify the attribute to use for test ids, defaults to "data-testid"<br>env PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTE
--timeout-action <timeout>	specify action timeout in milliseconds, defaults to 5000ms<br>env PLAYWRIGHT_MCP_TIMEOUT_ACTION
--timeout-navigation <timeout>	specify navigation timeout in milliseconds, defaults to 60000ms<br>env PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION
--timeout-settle <timeout>	how long to wait after each action for triggered work to settle, in milliseconds, defaults to 500ms<br>env PLAYWRIGHT_MCP_TIMEOUT_SETTLE
--user-agent <ua string>	specify user agent string<br>env PLAYWRIGHT_MCP_USER_AGENT
--user-data-dir <path>	path to the user data directory. If not specified, a temporary directory will be created.<br>env PLAYWRIGHT_MCP_USER_DATA_DIR
--viewport-size <size>	specify browser viewport size in pixels, for example "1280x720"<br>env PLAYWRIGHT_MCP_VIEWPORT_SIZE

<!--- End of options generated section -->

User 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-dir argument.

# Windows
%USERPROFILE%\AppData\Local\ms-playwright\mcp-{channel}-{workspace-hash}

# macOS
- ~/Library/Caches/ms-playwright/mcp-{channel}-{workspace-hash