playwright-mcp README

The project's README from github.com/microsoft/playwright-mcp. As one markdown file: README.md.

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.

Key Features

Requirements

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"
      ]
    }
  }
}

Install in VS Code Install in VS Code Insiders

Amp

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
Antigravity

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

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

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

claude mcp add playwright npx @playwright/mcp@latest
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.json file:

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

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.

Copilot

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.

Cursor

Click the button to install:

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.

Factory

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.

Gemini CLI

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

Goose

Click the button to install:

Install in Goose

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

Grok

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.

Junie

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.

Kiro

Add to Kiro

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

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

Click the button to install:

Add MCP Server playwright to LM Studio

Or install manually:

Go to Program in 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:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "playwright": {
      "type": "local",
      "command": [
        "npx",
        "@playwright/mcp@latest"
      ],
      "enabled": true
    }
  }
}
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:

Install in VS Code Install in VS Code Insiders

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.

Warp

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"
      ]
    }
  }
}
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:

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.
env PLAYWRIGHT_MCP_ALLOWED_HOSTS
--allowed-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.
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.
env PLAYWRIGHT_MCP_ALLOW_UNRESTRICTED_FILE_ACCESS
--blocked-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.
env PLAYWRIGHT_MCP_BLOCKED_ORIGINS
--block-service-workers block service workers
env PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERS
--browser browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.
env PLAYWRIGHT_MCP_BROWSER
--caps comma-separated list of additional capabilities to enable, possible values: vision, pdf, devtools.
env PLAYWRIGHT_MCP_CAPS
--cdp-endpoint CDP endpoint to connect to.
env PLAYWRIGHT_MCP_CDP_ENDPOINT
--cdp-header <headers...> CDP headers to send with the connect request, multiple can be specified.
env PLAYWRIGHT_MCP_CDP_HEADERS
--cdp-timeout timeout in milliseconds for connecting to CDP endpoint, defaults to 30000ms
env PLAYWRIGHT_MCP_CDP_TIMEOUT
--codegen specify the language to use for code generation, possible values: "typescript", "python", "java", "csharp", "none". Default is "typescript".
env PLAYWRIGHT_MCP_CODEGEN
--config path to the configuration file.
env PLAYWRIGHT_MCP_CONFIG
--console-level level of console messages to return: "error", "warning", "info", "debug". Each level includes the messages of more severe levels.
env PLAYWRIGHT_MCP_CONSOLE_LEVEL
--device device to emulate, for example: "iPhone 15"
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.
env PLAYWRIGHT_MCP_MOBILE
--executable-path path to the browser executable.
env PLAYWRIGHT_MCP_EXECUTABLE_PATH
--extension Connect to a running browser instance (Edge/Chrome only). Requires the "Playwright Extension" to be installed.
env PLAYWRIGHT_MCP_EXTENSION
--endpoint Bound browser endpoint to connect to.
env PLAYWRIGHT_MCP_ENDPOINT
--grant-permissions <permissions...> List of permissions to grant to the browser context, for example "geolocation", "clipboard-read", "clipboard-write".
env PLAYWRIGHT_MCP_GRANT_PERMISSIONS
--headless run browser in headless mode, headed by default
env PLAYWRIGHT_MCP_HEADLESS
--host host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
env PLAYWRIGHT_MCP_HOST
--ignore-https-errors ignore https errors
env PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORS
--init-page <path...> path to TypeScript file to evaluate on Playwright page object
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.
env PLAYWRIGHT_MCP_INIT_SCRIPT
--isolated keep the browser profile in memory, do not save it to disk.
env PLAYWRIGHT_MCP_ISOLATED
--image-responses whether to send image responses to the client. Can be "allow" or "omit", Defaults to "allow".
env PLAYWRIGHT_MCP_IMAGE_RESPONSES
--no-sandbox disable the sandbox for all process types that are normally sandboxed.
env PLAYWRIGHT_MCP_NO_SANDBOX
--output-dir path to the directory for output files.
env PLAYWRIGHT_MCP_OUTPUT_DIR
--output-max-size Threshold for evicting old output files, in bytes.
env PLAYWRIGHT_MCP_OUTPUT_MAX_SIZE
--port port to listen on for SSE transport.
env PLAYWRIGHT_MCP_PORT
--proxy-bypass comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"
env PLAYWRIGHT_MCP_PROXY_BYPASS
--proxy-server specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"
env PLAYWRIGHT_MCP_PROXY_SERVER
--sandbox enable the sandbox for all process types that are normally not sandboxed.
env PLAYWRIGHT_MCP_SANDBOX
--save-session Whether to save the Playwright MCP session into the output directory.
env PLAYWRIGHT_MCP_SAVE_SESSION
--secrets path to a file containing secrets in the dotenv format
env PLAYWRIGHT_MCP_SECRETS_FILE
--shared-browser-context reuse the same browser context between all connected HTTP clients.
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.
env PLAYWRIGHT_MCP_SNAPSHOT_BOXES
--snapshot-mode when taking snapshots for responses, specifies the mode to use. Can be "full" or "none". Default is "full".
env PLAYWRIGHT_MCP_SNAPSHOT_MODE
--storage-state path to the storage state file for isolated sessions.
env PLAYWRIGHT_MCP_STORAGE_STATE
--test-id-attribute specify the attribute to use for test ids, defaults to "data-testid"
env PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTE
--timeout-action specify action timeout in milliseconds, defaults to 5000ms
env PLAYWRIGHT_MCP_TIMEOUT_ACTION
--timeout-navigation specify navigation timeout in milliseconds, defaults to 60000ms
env PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION
--timeout-settle how long to wait after each action for triggered work to settle, in milliseconds, defaults to 500ms
env PLAYWRIGHT_MCP_TIMEOUT_SETTLE
--user-agent specify user agent string
env PLAYWRIGHT_MCP_USER_AGENT
--user-data-dir path to the user data directory. If not specified, a temporary directory will be created.
env PLAYWRIGHT_MCP_USER_DATA_DIR
--viewport-size specify browser viewport size in pixels, for example "1280x720"
env PLAYWRIGHT_MCP_VIEWPORT_SIZE

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}-{worksp

playwright-mcp (microsoft/playwright-mcp)

Searching Database…

What is this?A Model Context Protocol (MCP) server that gives LLMs browser automation through Playwright: your AI assistant can open pages, click around and read web content via structured accessibility snapshots instead of screenshots.
So it's a server, not a library I code against?Right — your MCP client (VS Code, Cursor, Claude Desktop and the like) launches it and exposes Playwright browser tools to the model, so the AI drives the browser for you rather than you writing Playwright code.
How do I hook it up to my AI assistant?Add an MCP server that runs 'npx @playwright/mcp@latest'. Cursor and VS Code have one-click install buttons; Claude Code, Codex, Copilot and Grok add it through their CLI; most other clients take the same standard config.
What do I need installed first?Node.js 18 or newer, plus any MCP client — VS Code, Cursor, Windsurf, Claude Desktop, Goose, Grok, Junie and many others are supported out of the box.
The README also mentions a Playwright CLI — when would I pick the MCP server over it?CLI + skills is more token-efficient for high-throughput coding agents. The MCP server fits loops that need persistent browser state and iterative reasoning, like exploratory automation, self-healing tests or long-running workflows.
Will the AI be browsing with my real logins?By default it keeps a persistent profile on disk where logged-in sessions survive. Run with --isolated to hold the profile in memory, or use --user-data-dir and delete it between sessions to clear that state.
Why accessibility snapshots instead of screenshots?Snapshots are structured data taken from Playwright's accessibility tree, so no vision model is needed, responses stay fast and lightweight, and tool actions are deterministic rather than an ambiguous reading of pixels.
Can it emulate a phone or tablet?Yes — --device emulates a specific model like 'iPhone 15', and --mobile emulates a generic Pixel 10 on Chromium or iPhone 17 on WebKit. Mobile pages are usually lighter, which also saves tokens.
Can it generate Playwright code for me?Yes, the --codegen option writes the agent's actions out as code — TypeScript by default, with Python, Java and C# also available.
Which extra capabilities can be switched on?The --caps flag enables additional capabilities: vision, pdf and devtools. Plenty of other behavior — headless mode, proxy, viewport size, timeouts, device emulation — is tuned through command-line args in the config.
Creator
microsoft
Size
2.1 MB
Stars
38.3K
Age
1y
Commits · 90 Days