1.9 KiB
1.9 KiB
MCP Setup
Note: CLI is the recommended way to use Playwriter. See README.md for CLI usage.
Add to your MCP client settings:
{
"mcpServers": {
"playwriter": {
"command": "npx",
"args": ["-y", "playwriter@latest"]
}
}
}
Or auto-configure:
npx -y @playwriter/install-mcp playwriter@latest
Using the MCP
- Enable the extension on at least one tab (click icon → turns green)
- MCP automatically starts relay server and connects to enabled tabs
- Use the
executetool to run Playwright code
The MCP exposes:
executetool - run Playwright code snippetsresettool - reconnect if connection issues occur
Environment Variables
PLAYWRITER_AUTO_ENABLE
Auto-create a tab when Playwright connects (no manual extension click needed).
Note: CLI enables this by default. This is only needed for MCP server usage.
{
"mcpServers": {
"playwriter": {
"command": "npx",
"args": ["-y", "playwriter@latest"],
"env": {
"PLAYWRITER_AUTO_ENABLE": "1"
}
}
}
}
The auto-created tab starts at about:blank. Navigate it to any URL.
Remote Agents (Devcontainers, VMs, SSH)
Run agents in isolated environments while controlling Chrome on your host.
On host (where Chrome runs):
npx -y playwriter serve --token <secret>
In container/VM (where agent runs):
{
"mcpServers": {
"playwriter": {
"command": "npx",
"args": ["-y", "playwriter@latest", "--host", "host.docker.internal", "--token", "<secret>"]
}
}
}
Or with environment variables:
{
"mcpServers": {
"playwriter": {
"command": "npx",
"args": ["-y", "playwriter@latest"],
"env": {
"PLAYWRITER_HOST": "host.docker.internal",
"PLAYWRITER_TOKEN": "<secret>"
}
}
}
}
Use host.docker.internal for devcontainers, or your host's IP for VMs/SSH.