31 Commits

Author SHA1 Message Date
Pavel Feldman
64f950ae42 chore: mark v0.0.31 (#691) 2025-07-17 16:04:21 -07:00
Pavel Feldman
5bfff0a059 chore: include recent console logs in results (#689) 2025-07-17 14:58:44 -07:00
Pavel Feldman
c97bc6e2ae chore: allow right click (#687)
Fixes https://github.com/microsoft/playwright-mcp/issues/467
2025-07-17 13:24:05 -07:00
Pavel Feldman
fe0c0ffffe chore: mirror cli options w/ env vars (#685)
Fixes https://github.com/microsoft/playwright-mcp/issues/639
2025-07-17 10:19:18 -07:00
Pavel Feldman
9526910864 chore: sort install sections (#682) 2025-07-17 09:06:10 -07:00
Pavel Feldman
95454735bf chore: remove image reply special case in cursor (#680) 2025-07-16 18:32:07 -07:00
Pavel Feldman
e9f6433241 chore: remove server experiment (#681) 2025-07-16 18:05:47 -07:00
Pavel Feldman
d61aa16fee chore: turn vision into capability (#679)
Fixes https://github.com/microsoft/playwright-mcp/issues/420
2025-07-16 16:40:00 -07:00
Pavel Feldman
012c906500 chore: introduce browser_evaluate (#678)
Fixes https://github.com/microsoft/playwright-mcp/issues/424
2025-07-16 15:02:47 -07:00
Pavel Feldman
825a97d66e chore: remove generate_test tool for now - it adds no value (#675) 2025-07-16 13:33:05 -07:00
Pavel Feldman
3061d9aa56 chore: resolve dialog races (#673)
Fixes https://github.com/microsoft/playwright-mcp/issues/595
2025-07-16 13:32:54 -07:00
Pavel Feldman
da818d113a chore: make tab indexes 0-based (#674)
Fixes https://github.com/microsoft/playwright-mcp/issues/570
2025-07-16 09:55:08 -07:00
Pavel Feldman
a5a57df105 chore: include page errors in console messages (#671)
Fixes https://github.com/microsoft/playwright-mcp/issues/669
2025-07-15 15:46:09 -07:00
Pavel Feldman
be8adb1866 chore: migrate to locator._resolveSelector (#670) 2025-07-15 14:50:33 -07:00
Pavel Feldman
c5a2324aaf chore: mark v0.0.30 (#666) 2025-07-14 10:53:12 -07:00
Pavel Feldman
128474b4aa chore: remove extension code (#667) 2025-07-14 10:52:38 -07:00
Pavel Feldman
7fca8f50f8 chore: roll Playwright to 1.54.1 (#665) 2025-07-14 09:51:14 -07:00
Simon Knott
841bb417d1 chore: update to 1.54.0 (#653)
Closes https://github.com/microsoft/playwright-mcp/issues/535
2025-07-14 09:53:33 +02:00
Pavel Feldman
59f1d67a4e feat(dblclick): add double click (#654)
Fixes https://github.com/microsoft/playwright-mcp/issues/652
2025-07-11 16:45:39 -07:00
おがどら
1600ba6645 docs: Update README about imageResponses option. (#646) 2025-07-09 17:40:22 -07:00
Joah Gerstenberg
127c996e86 docs: add instructions to install in Goose (#580) 2025-07-09 17:39:41 -07:00
Sandor Major
4bd39c07e9 docs: adding installation steps for Gemini CLI (#625)
I just tried it out with Gemini CLI and it works like a charm, thanks
for creating this MCP server!
2025-07-09 17:37:29 -07:00
Max Schmitt
f5b68dc590 devops(docker): enhance Docker image publishing with ORAS end-of-life tagging (#641)
This tags the images we publish as EOL immediately in order to get
excluded from the image scanning. Like we do upstream in
microsoft/playwright.
2025-07-07 23:08:12 +02:00
Mehul Raheja
875bd3b6ec fix(docs): Fix typo of windsurf in readme (#620) 2025-07-02 09:54:36 +02:00
Yury Semikhatsky
137b74750c chore(extension): wrap CDP protocol (#604) 2025-06-26 16:21:59 -07:00
Yury Semikhatsky
ded00dc422 chore(extension): convert to typescript (#603) 2025-06-26 13:52:08 -07:00
Yury Semikhatsky
5df6c2431b chore(extension): support reconnect, implement relay-extension protocol (#602) 2025-06-26 11:12:23 -07:00
Simon Knott
9066988098 chore: improve "ref not found" error message (#561)
Helps the model better understand the error cause.
2025-06-17 14:09:29 +02:00
jito(지토)
1dc4977ff9 docs: add Claude Code installation instructions (#553)
Add installation instructions for Claude Code CLI to the README.
2025-06-16 13:35:46 +02:00
Yury Semikhatsky
96e234012d chore(extension): start relay before creating MCP server (#548)
* HTTPS server launched and the relay server is created before MCP
server. This way we can pass CDP endpoint to its constructor.
* MCP HTTP transport is added to precreated HTTP server.
* A bunch of renames to fix style issues.
2025-06-13 16:13:40 -07:00
Max Schmitt
6c3f3b6576 feat: add MCP Chrome extension (#325)
Instructions:

1. `git clone https://github.com/mxschmitt/playwright-mcp && git
checkout extension-drafft`
2. `npm ci && npm run build`
3. `chrome://extensions` in your normal Chrome, "load unpacked" and
select the extension folder.
4. `node cli.js --port=4242 --extension` - The URL it prints at the end
you can put into the extension popup.
5. 
Put either this into Claude Desktop (it does not support SSE yet hence
wrapping it or just put the URL into Cursor/VSCode)

```json
{
  "mcpServers": {
    "playwright": {
      "command": "bash",
      "args": [
        "-c",
        "source $HOME/.nvm/nvm.sh && nvm use --silent 22 && npx supergateway --streamableHttp http://127.0.0.1:4242/mcp"
      ]
    }
  }
}
```

Things like `Take a snapshot of my browser.` should now work in your
Prompt Chat.

----

- SSE only for now, since we already have a http server with a port
there
- Upstream "page tests" can be executed over this CDP relay via
https://github.com/microsoft/playwright/pull/36286
- Limitations for now are everything what happens outside of the tab its
session is shared with -> `window.open` / `target=_blank`.

---------

Co-authored-by: Yury Semikhatsky <yurys@chromium.org>
2025-06-13 13:15:17 -07:00
51 changed files with 1291 additions and 1377 deletions

View File

@@ -44,6 +44,7 @@ jobs:
- name: Login to ACR - name: Login to ACR
run: az acr login --name playwright run: az acr login --name playwright
- name: Build and push Docker image - name: Build and push Docker image
id: build-push
uses: docker/build-push-action@v6 uses: docker/build-push-action@v6
with: with:
context: . context: .
@@ -53,3 +54,17 @@ jobs:
tags: | tags: |
playwright.azurecr.io/public/playwright/mcp:${{ github.event.release.tag_name }} playwright.azurecr.io/public/playwright/mcp:${{ github.event.release.tag_name }}
playwright.azurecr.io/public/playwright/mcp:latest playwright.azurecr.io/public/playwright/mcp:latest
- uses: oras-project/setup-oras@v1
- name: Set oras tags
run: |
attach_eol_manifest() {
local image="$1"
local today=$(date -u +'%Y-%m-%d')
# oras is re-using Docker credentials, so we don't need to login.
# Following the advice in https://portal.microsofticm.com/imp/v3/incidents/incident/476783820/summary
oras attach --artifact-type application/vnd.microsoft.artifact.lifecycle --annotation "vnd.microsoft.artifact.lifecycle.end-of-life.date=$today" $image
}
# for each tag, attach the eol manifest
for tag in $(echo ${{ steps.build-push.outputs.metadata['image.name'] }} | tr ',' '\n'); do
attach_eol_manifest $tag
done

524
README.md
View File

@@ -10,7 +10,7 @@ A Model Context Protocol (MCP) server that provides browser automation capabilit
### Requirements ### Requirements
- Node.js 18 or newer - Node.js 18 or newer
- VS Code, Cursor, Windsurf, Claude Desktop or any other MCP client - VS Code, Cursor, Windsurf, Claude Desktop, Goose or any other MCP client
<!-- <!--
// Generate using: // Generate using:
@@ -19,7 +19,9 @@ node utils/generate-links.js
### Getting started ### Getting started
First, install the Playwright MCP server with your client. A typical configuration looks like this: First, install the Playwright MCP server with your client.
**Standard config** works in most of the tools:
```js ```js
{ {
@@ -37,7 +39,65 @@ First, install the Playwright MCP server with your client. A typical configurati
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D) [<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">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D) [<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D) [<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">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522playwright%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540playwright%252Fmcp%2540latest%2522%255D%257D)
<details><summary><b>Install in VS Code</b></summary> <details>
<summary>Claude Code</summary>
Use the Claude Code CLI to add the Playwright MCP server:
```bash
claude mcp add playwright npx @playwright/mcp@latest
```
</details>
<details>
<summary>Claude Desktop</summary>
Follow the MCP install [guide](https://modelcontextprotocol.io/quickstart/user), use the standard config above.
</details>
<details>
<summary>Cursor</summary>
#### Click the button to install:
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=playwright&config=eyJjb21tYW5kIjoibnB4IEBwbGF5d3JpZ2h0L21jcEBsYXRlc3QifQ%3D%3D)
#### 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`. You can also verify config or add command like arguments via clicking `Edit`.
</details>
<details>
<summary>Gemini CLI</summary>
Follow the MCP install [guide](https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md#configure-the-mcp-server-in-settingsjson), use the standard config above.
</details>
<details>
<summary>Goose</summary>
#### Click the button to install:
[![Install in Goose](https://block.github.io/goose/img/extension-install-dark.svg)](https://block.github.io/goose/extension?cmd=npx&arg=%40playwright%2Fmcp%40latest&id=playwright&name=Playwright&description=Interact%20with%20web%20pages%20through%20structured%20accessibility%20snapshots%20using%20Playwright)
#### 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>Qodo Gen</summary>
Open [Qodo Gen](https://docs.qodo.ai/qodo-documentation/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>
You can also install the Playwright MCP server using the VS Code CLI: You can also install the Playwright MCP server using the VS Code CLI:
@@ -50,87 +110,10 @@ After installation, the Playwright MCP server will be available for use with you
</details> </details>
<details> <details>
<summary><b>Install in Cursor</b></summary> <summary>Windsurf</summary>
#### Click the button to install: Follow Windsurf MCP [documentation](https://docs.windsurf.com/windsurf/cascade/mcp). Use the standard config above.
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=playwright&config=eyJjb21tYW5kIjoibnB4IEBwbGF5d3JpZ2h0L21jcEBsYXRlc3QifQ%3D%3D)
#### 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`. You can also verify config or add command like arguments via clicking `Edit`.
```js
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": [
"@playwright/mcp@latest"
]
}
}
}
```
</details>
<details>
<summary><b>Install in Windsurf</b></summary>
Follow Windsuff MCP [documentation](https://docs.windsurf.com/windsurf/cascade/mcp). Use following configuration:
```js
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": [
"@playwright/mcp@latest"
]
}
}
}
```
</details>
<details>
<summary><b>Install in Claude Desktop</b></summary>
Follow the MCP install [guide](https://modelcontextprotocol.io/quickstart/user), use following configuration:
```js
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": [
"@playwright/mcp@latest"
]
}
}
}
```
</details>
<details>
<summary><b>Install in Qodo Gen</b></summary>
Open [Qodo Gen](https://docs.qodo.ai/qodo-documentation/qodo-gen) chat panel in VSCode or IntelliJ → Connect more tools → + Add new MCP → Paste the following configuration:
```js
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": [
"@playwright/mcp@latest"
]
}
}
}
```
Click <code>Save</code>.
</details> </details>
### Configuration ### Configuration
@@ -151,10 +134,8 @@ Playwright MCP server supports following arguments. They can be provided in the
--block-service-workers block service workers --block-service-workers block service workers
--browser <browser> browser or chrome channel to use, possible --browser <browser> browser or chrome channel to use, possible
values: chrome, firefox, webkit, msedge. values: chrome, firefox, webkit, msedge.
--browser-agent <endpoint> Use browser agent (experimental). --caps <caps> comma-separated list of additional capabilities
--caps <caps> comma-separated list of capabilities to enable, to enable, possible values: vision, pdf.
possible values: tabs, pdf, history, wait, files,
install. Default is all.
--cdp-endpoint <endpoint> CDP endpoint to connect to. --cdp-endpoint <endpoint> CDP endpoint to connect to.
--config <path> path to the configuration file. --config <path> path to the configuration file.
--device <device> device to emulate, for example: "iPhone 15" --device <device> device to emulate, for example: "iPhone 15"
@@ -166,9 +147,7 @@ Playwright MCP server supports following arguments. They can be provided in the
--isolated keep the browser profile in memory, do not save --isolated keep the browser profile in memory, do not save
it to disk. it to disk.
--image-responses <mode> whether to send image responses to the client. --image-responses <mode> whether to send image responses to the client.
Can be "allow", "omit", or "auto". Defaults to Can be "allow" or "omit", Defaults to "allow".
"auto", which sends images if the client can
display them.
--no-sandbox disable the sandbox for all process types that --no-sandbox disable the sandbox for all process types that
are normally sandboxed. are normally sandboxed.
--output-dir <path> path to the directory for output files. --output-dir <path> path to the directory for output files.
@@ -186,8 +165,6 @@ Playwright MCP server supports following arguments. They can be provided in the
specified, a temporary directory will be created. specified, a temporary directory will be created.
--viewport-size <size> specify browser viewport size in pixels, for --viewport-size <size> specify browser viewport size in pixels, for
example "1280, 720" example "1280, 720"
--vision Run server that uses screenshots (Aria snapshots
are used by default)
``` ```
<!--- End of options generated section --> <!--- End of options generated section -->
@@ -288,21 +265,14 @@ npx @playwright/mcp@latest --config path/to/config.json
host?: string; // Host to bind to (default: localhost) host?: string; // Host to bind to (default: localhost)
}, },
// List of enabled capabilities // List of additional capabilities
capabilities?: Array< capabilities?: Array<
'core' | // Core browser automation
'tabs' | // Tab management 'tabs' | // Tab management
'pdf' | // PDF generation
'history' | // Browser history
'wait' | // Wait utilities
'files' | // File handling
'install' | // Browser installation 'install' | // Browser installation
'testing' // Testing 'pdf' | // PDF generation
'vision' | // Coordinate-based interactions
>; >;
// Enable vision mode (screenshots instead of accessibility snapshots)
vision?: boolean;
// Directory for output files // Directory for output files
outputDir?: string; outputDir?: string;
@@ -316,9 +286,10 @@ npx @playwright/mcp@latest --config path/to/config.json
}; };
/** /**
* Do not send image responses to the client. * Whether to send image responses to the client. Can be "allow" or "omit".
* Defaults to "allow".
*/ */
noImageResponses?: boolean; imageResponses?: 'allow' | 'omit';
} }
``` ```
</details> </details>
@@ -391,42 +362,10 @@ http.createServer(async (req, res) => {
### Tools ### Tools
The tools are available in two modes:
1. **Snapshot Mode** (default): Uses accessibility snapshots for better performance and reliability
2. **Vision Mode**: Uses screenshots for visual-based interactions
To use Vision Mode, add the `--vision` flag when starting the server:
```js
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": [
"@playwright/mcp@latest",
"--vision"
]
}
}
}
```
Vision Mode works best with the computer use models that are able to interact with elements using
X Y coordinate space, based on the provided screenshot.
<!--- Tools generated by update-readme.js --> <!--- Tools generated by update-readme.js -->
<details> <details>
<summary><b>Interactions</b></summary> <summary><b>Core automation</b></summary>
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_snapshot**
- Title: Page snapshot
- Description: Capture accessibility snapshot of the current page, this is better than screenshot
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
@@ -436,10 +375,28 @@ X Y coordinate space, based on the provided screenshot.
- Parameters: - Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element - `element` (string): Human-readable element description used to obtain permission to interact with the element
- `ref` (string): Exact target element reference from the page snapshot - `ref` (string): Exact target element reference from the page snapshot
- `doubleClick` (boolean, optional): Whether to perform a double click instead of a single click
- `button` (string, optional): Button to click, defaults to left
- Read-only: **false** - Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_close**
- Title: Close browser
- Description: Close the page
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_console_messages**
- Title: Get console messages
- Description: Returns all console messages
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_drag** - **browser_drag**
- Title: Drag mouse - Title: Drag mouse
- Description: Perform drag and drop between two elements - Description: Perform drag and drop between two elements
@@ -452,60 +409,17 @@ X Y coordinate space, based on the provided screenshot.
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_hover** - **browser_evaluate**
- Title: Hover mouse - Title: Evaluate JavaScript
- Description: Hover over element on page - Description: Evaluate JavaScript expression on page or element
- Parameters: - Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element - `function` (string): () => { /* code */ } or (element) => { /* code */ } when element is provided
- `ref` (string): Exact target element reference from the page snapshot - `element` (string, optional): Human-readable element description used to obtain permission to interact with the element
- Read-only: **true** - `ref` (string, optional): Exact target element reference from the page snapshot
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_type**
- Title: Type text
- Description: Type text into editable element
- Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element
- `ref` (string): Exact target element reference from the page snapshot
- `text` (string): Text to type into the element
- `submit` (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.
- Read-only: **false** - Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_select_option**
- Title: Select option
- Description: Select an option in a dropdown
- Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element
- `ref` (string): Exact target element reference from the page snapshot
- `values` (array): Array of values to select in the dropdown. This can be a single value or multiple values.
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_press_key**
- Title: Press a key
- Description: Press a key on the keyboard
- Parameters:
- `key` (string): Name of the key to press or a character to generate, such as `ArrowLeft` or `a`
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_wait_for**
- Title: Wait for
- Description: Wait for text to appear or disappear or a specified time to pass
- Parameters:
- `time` (number, optional): The time to wait in seconds
- `text` (string, optional): The text to wait for
- `textGone` (string, optional): The text to wait for to disappear
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_file_upload** - **browser_file_upload**
- Title: Upload files - Title: Upload files
- Description: Upload one or multiple files - Description: Upload one or multiple files
@@ -523,10 +437,15 @@ X Y coordinate space, based on the provided screenshot.
- `promptText` (string, optional): The text of the prompt in case of a prompt dialog. - `promptText` (string, optional): The text of the prompt in case of a prompt dialog.
- Read-only: **false** - Read-only: **false**
</details> <!-- NOTE: This has been generated via update-readme.js -->
<details> - **browser_hover**
<summary><b>Navigation</b></summary> - Title: Hover mouse
- Description: Hover over element on page
- Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element
- `ref` (string): Exact target element reference from the page snapshot
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
@@ -553,10 +472,51 @@ X Y coordinate space, based on the provided screenshot.
- Parameters: None - Parameters: None
- Read-only: **true** - Read-only: **true**
</details> <!-- NOTE: This has been generated via update-readme.js -->
<details> - **browser_network_requests**
<summary><b>Resources</b></summary> - Title: List network requests
- Description: Returns all network requests since loading the page
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_press_key**
- Title: Press a key
- Description: Press a key on the keyboard
- Parameters:
- `key` (string): Name of the key to press or a character to generate, such as `ArrowLeft` or `a`
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_resize**
- Title: Resize browser window
- Description: Resize the browser window
- Parameters:
- `width` (number): Width of the browser window
- `height` (number): Height of the browser window
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_select_option**
- Title: Select option
- Description: Select an option in a dropdown
- Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element
- `ref` (string): Exact target element reference from the page snapshot
- `values` (array): Array of values to select in the dropdown. This can be a single value or multiple values.
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_snapshot**
- Title: Page snapshot
- Description: Capture accessibility snapshot of the current page, this is better than screenshot
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
@@ -572,64 +532,41 @@ X Y coordinate space, based on the provided screenshot.
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_pdf_save** - **browser_type**
- Title: Save as PDF - Title: Type text
- Description: Save page as PDF - Description: Type text into editable element
- Parameters: - Parameters:
- `filename` (string, optional): File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified. - `element` (string): Human-readable element description used to obtain permission to interact with the element
- Read-only: **true** - `ref` (string): Exact target element reference from the page snapshot
- `text` (string): Text to type into the element
<!-- NOTE: This has been generated via update-readme.js --> - `submit` (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.
- **browser_network_requests**
- Title: List network requests
- Description: Returns all network requests since loading the page
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_console_messages**
- Title: Get console messages
- Description: Returns all console messages
- Parameters: None
- Read-only: **true**
</details>
<details>
<summary><b>Utilities</b></summary>
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_install**
- Title: Install the browser specified in the config
- Description: Install the browser specified in the config. Call this if you get an error about the browser not being installed.
- Parameters: None
- Read-only: **false** - Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_close** - **browser_wait_for**
- Title: Close browser - Title: Wait for
- Description: Close the page - Description: Wait for text to appear or disappear or a specified time to pass
- Parameters: None
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_resize**
- Title: Resize browser window
- Description: Resize the browser window
- Parameters: - Parameters:
- `width` (number): Width of the browser window - `time` (number, optional): The time to wait in seconds
- `height` (number): Height of the browser window - `text` (string, optional): The text to wait for
- `textGone` (string, optional): The text to wait for to disappear
- Read-only: **true** - Read-only: **true**
</details> </details>
<details> <details>
<summary><b>Tabs</b></summary> <summary><b>Tab management</b></summary>
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_tab_close**
- Title: Close a tab
- Description: Close a tab
- Parameters:
- `index` (number, optional): The index of the tab to close. Closes current tab if not provided.
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
@@ -657,60 +594,29 @@ X Y coordinate space, based on the provided screenshot.
- `index` (number): The index of the tab to select - `index` (number): The index of the tab to select
- Read-only: **true** - Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_tab_close**
- Title: Close a tab
- Description: Close a tab
- Parameters:
- `index` (number, optional): The index of the tab to close. Closes current tab if not provided.
- Read-only: **false**
</details> </details>
<details> <details>
<summary><b>Testing</b></summary> <summary><b>Browser installation</b></summary>
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_generate_playwright_test** - **browser_install**
- Title: Generate a Playwright test - Title: Install the browser specified in the config
- Description: Generate a Playwright test for given scenario - Description: Install the browser specified in the config. Call this if you get an error about the browser not being installed.
- Parameters:
- `name` (string): The name of the test
- `description` (string): The description of the test
- `steps` (array): The steps of the test
- Read-only: **true**
</details>
<details>
<summary><b>Vision mode</b></summary>
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_screen_capture**
- Title: Take a screenshot
- Description: Take a screenshot of the current page
- Parameters: None - Parameters: None
- Read-only: **true** - Read-only: **false**
</details>
<details>
<summary><b>Coordinate-based (opt-in via --caps=vision)</b></summary>
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_screen_move_mouse** - **browser_mouse_click_xy**
- Title: Move mouse
- Description: Move mouse to a given position
- Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element
- `x` (number): X coordinate
- `y` (number): Y coordinate
- Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_screen_click**
- Title: Click - Title: Click
- Description: Click left mouse button - Description: Click left mouse button at a given position
- Parameters: - Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element - `element` (string): Human-readable element description used to obtain permission to interact with the element
- `x` (number): X coordinate - `x` (number): X coordinate
@@ -719,9 +625,9 @@ X Y coordinate space, based on the provided screenshot.
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_screen_drag** - **browser_mouse_drag_xy**
- Title: Drag mouse - Title: Drag mouse
- Description: Drag left mouse button - Description: Drag left mouse button to a given position
- Parameters: - Parameters:
- `element` (string): Human-readable element description used to obtain permission to interact with the element - `element` (string): Human-readable element description used to obtain permission to interact with the element
- `startX` (number): Start X coordinate - `startX` (number): Start X coordinate
@@ -732,52 +638,28 @@ X Y coordinate space, based on the provided screenshot.
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_screen_type** - **browser_mouse_move_xy**
- Title: Type text - Title: Move mouse
- Description: Type text - Description: Move mouse to a given position
- Parameters: - Parameters:
- `text` (string): Text to type into the element - `element` (string): Human-readable element description used to obtain permission to interact with the element
- `submit` (boolean, optional): Whether to submit entered text (press Enter after) - `x` (number): X coordinate
- Read-only: **false** - `y` (number): Y coordinate
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_press_key**
- Title: Press a key
- Description: Press a key on the keyboard
- Parameters:
- `key` (string): Name of the key to press or a character to generate, such as `ArrowLeft` or `a`
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js -->
- **browser_wait_for**
- Title: Wait for
- Description: Wait for text to appear or disappear or a specified time to pass
- Parameters:
- `time` (number, optional): The time to wait in seconds
- `text` (string, optional): The text to wait for
- `textGone` (string, optional): The text to wait for to disappear
- Read-only: **true** - Read-only: **true**
<!-- NOTE: This has been generated via update-readme.js --> </details>
- **browser_file_upload** <details>
- Title: Upload files <summary><b>PDF generation (opt-in via --caps=pdf)</b></summary>
- Description: Upload one or multiple files
- Parameters:
- `paths` (array): The absolute paths to the files to upload. Can be a single file or multiple files.
- Read-only: **false**
<!-- NOTE: This has been generated via update-readme.js --> <!-- NOTE: This has been generated via update-readme.js -->
- **browser_handle_dialog** - **browser_pdf_save**
- Title: Handle a dialog - Title: Save as PDF
- Description: Handle a dialog - Description: Save page as PDF
- Parameters: - Parameters:
- `accept` (boolean): Whether to accept the dialog. - `filename` (string, optional): File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.
- `promptText` (string, optional): The text of the prompt in case of a prompt dialog. - Read-only: **true**
- Read-only: **false**
</details> </details>

20
config.d.ts vendored
View File

@@ -16,18 +16,13 @@
import type * as playwright from 'playwright'; import type * as playwright from 'playwright';
export type ToolCapability = 'core' | 'tabs' | 'pdf' | 'history' | 'wait' | 'files' | 'install' | 'testing'; export type ToolCapability = 'core' | 'core-tabs' | 'core-install' | 'vision' | 'pdf';
export type Config = { export type Config = {
/** /**
* The browser to use. * The browser to use.
*/ */
browser?: { browser?: {
/**
* Use browser agent (experimental).
*/
browserAgent?: string;
/** /**
* The type of browser to use. * The type of browser to use.
*/ */
@@ -85,20 +80,11 @@ export type Config = {
/** /**
* List of enabled tool capabilities. Possible values: * List of enabled tool capabilities. Possible values:
* - 'core': Core browser automation features. * - 'core': Core browser automation features.
* - 'tabs': Tab management features.
* - 'pdf': PDF generation and manipulation. * - 'pdf': PDF generation and manipulation.
* - 'history': Browser history access. * - 'vision': Coordinate-based interactions.
* - 'wait': Wait and timing utilities.
* - 'files': File upload/download support.
* - 'install': Browser installation utilities.
*/ */
capabilities?: ToolCapability[]; capabilities?: ToolCapability[];
/**
* Run server that uses screenshots (Aria snapshots are used by default).
*/
vision?: boolean;
/** /**
* Whether to save the Playwright trace of the session into the output directory. * Whether to save the Playwright trace of the session into the output directory.
*/ */
@@ -124,5 +110,5 @@ export type Config = {
/** /**
* Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them. * Whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.
*/ */
imageResponses?: 'allow' | 'omit' | 'auto'; imageResponses?: 'allow' | 'omit';
}; };

104
package-lock.json generated
View File

@@ -1,19 +1,21 @@
{ {
"name": "@playwright/mcp", "name": "@playwright/mcp",
"version": "0.0.29", "version": "0.0.31",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@playwright/mcp", "name": "@playwright/mcp",
"version": "0.0.29", "version": "0.0.31",
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
"@modelcontextprotocol/sdk": "^1.11.0", "@modelcontextprotocol/sdk": "^1.11.0",
"commander": "^13.1.0", "commander": "^13.1.0",
"debug": "^4.4.1", "debug": "^4.4.1",
"mime": "^4.0.7", "mime": "^4.0.7",
"playwright": "1.53.0", "playwright": "1.55.0-alpha-1752701791000",
"playwright-core": "1.55.0-alpha-1752701791000",
"ws": "^8.18.1",
"zod-to-json-schema": "^3.24.4" "zod-to-json-schema": "^3.24.4"
}, },
"bin": { "bin": {
@@ -22,10 +24,12 @@
"devDependencies": { "devDependencies": {
"@eslint/eslintrc": "^3.2.0", "@eslint/eslintrc": "^3.2.0",
"@eslint/js": "^9.19.0", "@eslint/js": "^9.19.0",
"@playwright/test": "1.53.0", "@playwright/test": "1.55.0-alpha-1752701791000",
"@stylistic/eslint-plugin": "^3.0.1", "@stylistic/eslint-plugin": "^3.0.1",
"@types/chrome": "^0.0.315",
"@types/debug": "^4.1.12", "@types/debug": "^4.1.12",
"@types/node": "^22.13.10", "@types/node": "^22.13.10",
"@types/ws": "^8.18.1",
"@typescript-eslint/eslint-plugin": "^8.26.1", "@typescript-eslint/eslint-plugin": "^8.26.1",
"@typescript-eslint/parser": "^8.26.1", "@typescript-eslint/parser": "^8.26.1",
"@typescript-eslint/utils": "^8.26.1", "@typescript-eslint/utils": "^8.26.1",
@@ -289,12 +293,13 @@
} }
}, },
"node_modules/@playwright/test": { "node_modules/@playwright/test": {
"version": "1.53.0", "version": "1.55.0-alpha-1752701791000",
"resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.53.0.tgz", "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.55.0-alpha-1752701791000.tgz",
"integrity": "sha512-15hjKreZDcp7t6TL/7jkAo6Df5STZN09jGiv5dbP9A6vMVncXRqE7/B2SncsyOwrkZRBH2i6/TPOL8BVmm3c7w==", "integrity": "sha512-mnitdsjXKPyKTjQQDJ78Or1xZSGcaoDzZVD/0BWFCvygn3nyNmGmiias/Mlfvzvgz9UWBbPeZYxU/bd2Lu+OrQ==",
"dev": true, "dev": true,
"license": "Apache-2.0",
"dependencies": { "dependencies": {
"playwright": "1.53.0" "playwright": "1.55.0-alpha-1752701791000"
}, },
"bin": { "bin": {
"playwright": "cli.js" "playwright": "cli.js"
@@ -356,6 +361,17 @@
"url": "https://github.com/sponsors/jonschlinkert" "url": "https://github.com/sponsors/jonschlinkert"
} }
}, },
"node_modules/@types/chrome": {
"version": "0.0.315",
"resolved": "https://registry.npmjs.org/@types/chrome/-/chrome-0.0.315.tgz",
"integrity": "sha512-Oy1dYWkr6BCmgwBtOngLByCHstQ3whltZg7/7lubgIZEYvKobDneqplgc6LKERNRBwckFviV4UU5AZZNUFrJ4A==",
"dev": true,
"license": "MIT",
"dependencies": {
"@types/filesystem": "*",
"@types/har-format": "*"
}
},
"node_modules/@types/debug": { "node_modules/@types/debug": {
"version": "4.1.12", "version": "4.1.12",
"resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz",
@@ -373,6 +389,30 @@
"dev": true, "dev": true,
"license": "MIT" "license": "MIT"
}, },
"node_modules/@types/filesystem": {
"version": "0.0.36",
"resolved": "https://registry.npmjs.org/@types/filesystem/-/filesystem-0.0.36.tgz",
"integrity": "sha512-vPDXOZuannb9FZdxgHnqSwAG/jvdGM8Wq+6N4D/d80z+D4HWH+bItqsZaVRQykAn6WEVeEkLm2oQigyHtgb0RA==",
"dev": true,
"license": "MIT",
"dependencies": {
"@types/filewriter": "*"
}
},
"node_modules/@types/filewriter": {
"version": "0.0.33",
"resolved": "https://registry.npmjs.org/@types/filewriter/-/filewriter-0.0.33.tgz",
"integrity": "sha512-xFU8ZXTw4gd358lb2jw25nxY9QAgqn2+bKKjKOYfNCzN4DKCFetK7sPtrlpg66Ywe3vWY9FNxprZawAh9wfJ3g==",
"dev": true,
"license": "MIT"
},
"node_modules/@types/har-format": {
"version": "1.2.16",
"resolved": "https://registry.npmjs.org/@types/har-format/-/har-format-1.2.16.tgz",
"integrity": "sha512-fluxdy7ryD3MV6h8pTfTYpy/xQzCFC7m89nOH9y94cNqJ1mDIDPut7MnRHI3F6qRmh/cT2fUjG1MLdCNb4hE9A==",
"dev": true,
"license": "MIT"
},
"node_modules/@types/json-schema": { "node_modules/@types/json-schema": {
"version": "7.0.15", "version": "7.0.15",
"resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
@@ -404,6 +444,16 @@
"undici-types": "~6.20.0" "undici-types": "~6.20.0"
} }
}, },
"node_modules/@types/ws": {
"version": "8.18.1",
"resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz",
"integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==",
"dev": true,
"license": "MIT",
"dependencies": {
"@types/node": "*"
}
},
"node_modules/@typescript-eslint/eslint-plugin": { "node_modules/@typescript-eslint/eslint-plugin": {
"version": "8.27.0", "version": "8.27.0",
"resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.27.0.tgz", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.27.0.tgz",
@@ -1984,6 +2034,7 @@
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
"integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
"hasInstallScript": true, "hasInstallScript": true,
"license": "MIT",
"optional": true, "optional": true,
"os": [ "os": [
"darwin" "darwin"
@@ -3250,11 +3301,12 @@
} }
}, },
"node_modules/playwright": { "node_modules/playwright": {
"version": "1.53.0", "version": "1.55.0-alpha-1752701791000",
"resolved": "https://registry.npmjs.org/playwright/-/playwright-1.53.0.tgz", "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.55.0-alpha-1752701791000.tgz",
"integrity": "sha512-ghGNnIEYZC4E+YtclRn4/p6oYbdPiASELBIYkBXfaTVKreQUYbMUYQDwS12a8F0/HtIjr/CkGjtwABeFPGcS4Q==", "integrity": "sha512-PA3TvDz7uQ+Pde0uaii5/WpU5vntRJsYFsaSPoBzywIqzYFO1ugk1ZZ0q6z4/xHq0ha1UClvsv3P77B+u1fi+w==",
"license": "Apache-2.0",
"dependencies": { "dependencies": {
"playwright-core": "1.53.0" "playwright-core": "1.55.0-alpha-1752701791000"
}, },
"bin": { "bin": {
"playwright": "cli.js" "playwright": "cli.js"
@@ -3267,9 +3319,10 @@
} }
}, },
"node_modules/playwright-core": { "node_modules/playwright-core": {
"version": "1.53.0", "version": "1.55.0-alpha-1752701791000",
"resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.53.0.tgz", "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.55.0-alpha-1752701791000.tgz",
"integrity": "sha512-mGLg8m0pm4+mmtB7M89Xw/GSqoNC+twivl8ITteqvAndachozYe2ZA7srU6uleV1vEdAHYqjq+SV8SNxRRFYBw==", "integrity": "sha512-mQhzhjJMiqnGNnYZv7M4yk1OcNTt1E72jrTLO7EqZuoeat4+qpcU0/mbK+RcTEass5a9YheoVFh6OIhruFMGVg==",
"license": "Apache-2.0",
"bin": { "bin": {
"playwright-core": "cli.js" "playwright-core": "cli.js"
}, },
@@ -4243,6 +4296,27 @@
"integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
"license": "ISC" "license": "ISC"
}, },
"node_modules/ws": {
"version": "8.18.1",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.18.1.tgz",
"integrity": "sha512-RKW2aJZMXeMxVpnZ6bck+RswznaxmzdULiBr6KY7XkTnW8uvt0iT9H5DkHUChXrc+uurzwa0rVI16n/Xzjdz1w==",
"license": "MIT",
"engines": {
"node": ">=10.0.0"
},
"peerDependencies": {
"bufferutil": "^4.0.1",
"utf-8-validate": ">=5.0.2"
},
"peerDependenciesMeta": {
"bufferutil": {
"optional": true
},
"utf-8-validate": {
"optional": true
}
}
},
"node_modules/yocto-queue": { "node_modules/yocto-queue": {
"version": "0.1.0", "version": "0.1.0",
"resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",

View File

@@ -1,6 +1,6 @@
{ {
"name": "@playwright/mcp", "name": "@playwright/mcp",
"version": "0.0.29", "version": "0.0.31",
"description": "Playwright Tools for MCP", "description": "Playwright Tools for MCP",
"type": "module", "type": "module",
"repository": { "repository": {
@@ -40,16 +40,20 @@
"commander": "^13.1.0", "commander": "^13.1.0",
"debug": "^4.4.1", "debug": "^4.4.1",
"mime": "^4.0.7", "mime": "^4.0.7",
"playwright": "1.53.0", "playwright": "1.55.0-alpha-1752701791000",
"playwright-core": "1.55.0-alpha-1752701791000",
"ws": "^8.18.1",
"zod-to-json-schema": "^3.24.4" "zod-to-json-schema": "^3.24.4"
}, },
"devDependencies": { "devDependencies": {
"@eslint/eslintrc": "^3.2.0", "@eslint/eslintrc": "^3.2.0",
"@eslint/js": "^9.19.0", "@eslint/js": "^9.19.0",
"@playwright/test": "1.53.0", "@playwright/test": "1.55.0-alpha-1752701791000",
"@stylistic/eslint-plugin": "^3.0.1", "@stylistic/eslint-plugin": "^3.0.1",
"@types/chrome": "^0.0.315",
"@types/debug": "^4.1.12", "@types/debug": "^4.1.12",
"@types/node": "^22.13.10", "@types/node": "^22.13.10",
"@types/ws": "^8.18.1",
"@typescript-eslint/eslint-plugin": "^8.26.1", "@typescript-eslint/eslint-plugin": "^8.26.1",
"@typescript-eslint/parser": "^8.26.1", "@typescript-eslint/parser": "^8.26.1",
"@typescript-eslint/utils": "^8.26.1", "@typescript-eslint/utils": "^8.26.1",

View File

@@ -19,14 +19,11 @@ import net from 'node:net';
import path from 'node:path'; import path from 'node:path';
import os from 'node:os'; import os from 'node:os';
import debug from 'debug';
import * as playwright from 'playwright'; import * as playwright from 'playwright';
import { userDataDir } from './fileUtils.js';
import { logUnhandledError, testDebug } from './log.js';
import type { FullConfig } from './config.js'; import type { FullConfig } from './config.js';
import type { BrowserInfo, LaunchBrowserRequest } from './browserServer.js';
const testDebug = debug('pw:mcp:test');
export function contextFactory(browserConfig: FullConfig['browser']): BrowserContextFactory { export function contextFactory(browserConfig: FullConfig['browser']): BrowserContextFactory {
if (browserConfig.remoteEndpoint) if (browserConfig.remoteEndpoint)
@@ -35,8 +32,6 @@ export function contextFactory(browserConfig: FullConfig['browser']): BrowserCon
return new CdpContextFactory(browserConfig); return new CdpContextFactory(browserConfig);
if (browserConfig.isolated) if (browserConfig.isolated)
return new IsolatedContextFactory(browserConfig); return new IsolatedContextFactory(browserConfig);
if (browserConfig.browserAgent)
return new BrowserServerContextFactory(browserConfig);
return new PersistentContextFactory(browserConfig); return new PersistentContextFactory(browserConfig);
} }
@@ -88,10 +83,10 @@ class BaseContextFactory implements BrowserContextFactory {
testDebug(`close browser context (${this.name})`); testDebug(`close browser context (${this.name})`);
if (browser.contexts().length === 1) if (browser.contexts().length === 1)
this._browserPromise = undefined; this._browserPromise = undefined;
await browserContext.close().catch(() => {}); await browserContext.close().catch(logUnhandledError);
if (browser.contexts().length === 0) { if (browser.contexts().length === 0) {
testDebug(`close browser (${this.name})`); testDebug(`close browser (${this.name})`);
await browser.close().catch(() => {}); await browser.close().catch(logUnhandledError);
} }
} }
} }
@@ -217,38 +212,6 @@ class PersistentContextFactory implements BrowserContextFactory {
} }
} }
export class BrowserServerContextFactory extends BaseContextFactory {
constructor(browserConfig: FullConfig['browser']) {
super('persistent', browserConfig);
}
protected override async _doObtainBrowser(): Promise<playwright.Browser> {
const response = await fetch(new URL(`/json/launch`, this.browserConfig.browserAgent), {
method: 'POST',
body: JSON.stringify({
browserType: this.browserConfig.browserName,
userDataDir: this.browserConfig.userDataDir ?? await this._createUserDataDir(),
launchOptions: this.browserConfig.launchOptions,
contextOptions: this.browserConfig.contextOptions,
} as LaunchBrowserRequest),
});
const info = await response.json() as BrowserInfo;
if (info.error)
throw new Error(info.error);
return await playwright.chromium.connectOverCDP(`http://localhost:${info.cdpPort}/`);
}
protected override async _doCreateContext(browser: playwright.Browser): Promise<playwright.BrowserContext> {
return this.browserConfig.isolated ? await browser.newContext() : browser.contexts()[0];
}
private async _createUserDataDir() {
const dir = await userDataDir(this.browserConfig);
await fs.promises.mkdir(dir, { recursive: true });
return dir;
}
}
async function injectCdpPort(browserConfig: FullConfig['browser']) { async function injectCdpPort(browserConfig: FullConfig['browser']) {
if (browserConfig.browserName === 'chromium') if (browserConfig.browserName === 'chromium')
(browserConfig.launchOptions as any).cdpPort = await findFreePort(); (browserConfig.launchOptions as any).cdpPort = await findFreePort();

View File

@@ -1,197 +0,0 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable no-console */
import net from 'net';
import { program } from 'commander';
import playwright from 'playwright';
import { HttpServer } from './httpServer.js';
import { packageJSON } from './package.js';
import type http from 'http';
export type LaunchBrowserRequest = {
browserType: string;
userDataDir: string;
launchOptions: playwright.LaunchOptions;
contextOptions: playwright.BrowserContextOptions;
};
export type BrowserInfo = {
browserType: string;
userDataDir: string;
cdpPort: number;
launchOptions: playwright.LaunchOptions;
contextOptions: playwright.BrowserContextOptions;
error?: string;
};
type BrowserEntry = {
browser?: playwright.Browser;
info: BrowserInfo;
};
class BrowserServer {
private _server = new HttpServer();
private _entries: BrowserEntry[] = [];
constructor() {
this._setupExitHandler();
}
async start(port: number) {
await this._server.start({ port });
this._server.routePath('/json/list', (req, res) => {
this._handleJsonList(res);
});
this._server.routePath('/json/launch', async (req, res) => {
void this._handleLaunchBrowser(req, res).catch(e => console.error(e));
});
this._setEntries([]);
}
private _handleJsonList(res: http.ServerResponse) {
const list = this._entries.map(browser => browser.info);
res.end(JSON.stringify(list));
}
private async _handleLaunchBrowser(req: http.IncomingMessage, res: http.ServerResponse) {
const request = await readBody<LaunchBrowserRequest>(req);
let info = this._entries.map(entry => entry.info).find(info => info.userDataDir === request.userDataDir);
if (!info || info.error)
info = await this._newBrowser(request);
res.end(JSON.stringify(info));
}
private async _newBrowser(request: LaunchBrowserRequest): Promise<BrowserInfo> {
const cdpPort = await findFreePort();
(request.launchOptions as any).cdpPort = cdpPort;
const info: BrowserInfo = {
browserType: request.browserType,
userDataDir: request.userDataDir,
cdpPort,
launchOptions: request.launchOptions,
contextOptions: request.contextOptions,
};
const browserType = playwright[request.browserType as 'chromium' | 'firefox' | 'webkit'];
const { browser, error } = await browserType.launchPersistentContext(request.userDataDir, {
...request.launchOptions,
...request.contextOptions,
handleSIGINT: false,
handleSIGTERM: false,
}).then(context => {
return { browser: context.browser()!, error: undefined };
}).catch(error => {
return { browser: undefined, error: error.message };
});
this._setEntries([...this._entries, {
browser,
info: {
browserType: request.browserType,
userDataDir: request.userDataDir,
cdpPort,
launchOptions: request.launchOptions,
contextOptions: request.contextOptions,
error,
},
}]);
browser?.on('disconnected', () => {
this._setEntries(this._entries.filter(entry => entry.browser !== browser));
});
return info;
}
private _updateReport() {
// Clear the current line and move cursor to top of screen
process.stdout.write('\x1b[2J\x1b[H');
process.stdout.write(`Playwright Browser Server v${packageJSON.version}\n`);
process.stdout.write(`Listening on ${this._server.urlPrefix('human-readable')}\n\n`);
if (this._entries.length === 0) {
process.stdout.write('No browsers currently running\n');
return;
}
process.stdout.write('Running browsers:\n');
for (const entry of this._entries) {
const status = entry.browser ? 'running' : 'error';
const statusColor = entry.browser ? '\x1b[32m' : '\x1b[31m'; // green for running, red for error
process.stdout.write(`${statusColor}${entry.info.browserType}\x1b[0m (${entry.info.userDataDir}) - ${statusColor}${status}\x1b[0m\n`);
if (entry.info.error)
process.stdout.write(` Error: ${entry.info.error}\n`);
}
}
private _setEntries(entries: BrowserEntry[]) {
this._entries = entries;
this._updateReport();
}
private _setupExitHandler() {
let isExiting = false;
const handleExit = async () => {
if (isExiting)
return;
isExiting = true;
setTimeout(() => process.exit(0), 15000);
for (const entry of this._entries)
await entry.browser?.close().catch(() => {});
process.exit(0);
};
process.stdin.on('close', handleExit);
process.on('SIGINT', handleExit);
process.on('SIGTERM', handleExit);
}
}
program
.name('browser-agent')
.option('-p, --port <port>', 'Port to listen on', '9224')
.action(async options => {
await main(options);
});
void program.parseAsync(process.argv);
async function main(options: { port: string }) {
const server = new BrowserServer();
await server.start(+options.port);
}
function readBody<T>(req: http.IncomingMessage): Promise<T> {
return new Promise((resolve, reject) => {
const chunks: Buffer[] = [];
req.on('data', (chunk: Buffer) => chunks.push(chunk));
req.on('end', () => resolve(JSON.parse(Buffer.concat(chunks).toString())));
});
}
async function findFreePort(): Promise<number> {
return new Promise((resolve, reject) => {
const server = net.createServer();
server.listen(0, () => {
const { port } = server.address() as net.AddressInfo;
server.close(() => resolve(port));
});
server.on('error', reject);
});
}

View File

@@ -28,8 +28,7 @@ export type CLIOptions = {
blockedOrigins?: string[]; blockedOrigins?: string[];
blockServiceWorkers?: boolean; blockServiceWorkers?: boolean;
browser?: string; browser?: string;
browserAgent?: string; caps?: string[];
caps?: string;
cdpEndpoint?: string; cdpEndpoint?: string;
config?: string; config?: string;
device?: string; device?: string;
@@ -38,8 +37,8 @@ export type CLIOptions = {
host?: string; host?: string;
ignoreHttpsErrors?: boolean; ignoreHttpsErrors?: boolean;
isolated?: boolean; isolated?: boolean;
imageResponses?: 'allow' | 'omit' | 'auto'; imageResponses?: 'allow' | 'omit';
sandbox: boolean; sandbox?: boolean;
outputDir?: string; outputDir?: string;
port?: number; port?: number;
proxyBypass?: string; proxyBypass?: string;
@@ -49,7 +48,6 @@ export type CLIOptions = {
userAgent?: string; userAgent?: string;
userDataDir?: string; userDataDir?: string;
viewportSize?: string; viewportSize?: string;
vision?: boolean;
}; };
const defaultConfig: FullConfig = { const defaultConfig: FullConfig = {
@@ -91,15 +89,19 @@ export async function resolveConfig(config: Config): Promise<FullConfig> {
export async function resolveCLIConfig(cliOptions: CLIOptions): Promise<FullConfig> { export async function resolveCLIConfig(cliOptions: CLIOptions): Promise<FullConfig> {
const configInFile = await loadConfig(cliOptions.config); const configInFile = await loadConfig(cliOptions.config);
const cliOverrides = await configFromCLIOptions(cliOptions); const envOverrides = configFromEnv();
const result = mergeConfig(mergeConfig(defaultConfig, configInFile), cliOverrides); const cliOverrides = configFromCLIOptions(cliOptions);
let result = defaultConfig;
result = mergeConfig(result, configInFile);
result = mergeConfig(result, envOverrides);
result = mergeConfig(result, cliOverrides);
// Derive artifact output directory from config.outputDir // Derive artifact output directory from config.outputDir
if (result.saveTrace) if (result.saveTrace)
result.browser.launchOptions.tracesDir = path.join(result.outputDir, 'traces'); result.browser.launchOptions.tracesDir = path.join(result.outputDir, 'traces');
return result; return result;
} }
export async function configFromCLIOptions(cliOptions: CLIOptions): Promise<Config> { export function configFromCLIOptions(cliOptions: CLIOptions): Config {
let browserName: 'chromium' | 'firefox' | 'webkit' | undefined; let browserName: 'chromium' | 'firefox' | 'webkit' | undefined;
let channel: string | undefined; let channel: string | undefined;
switch (cliOptions.browser) { switch (cliOptions.browser) {
@@ -142,6 +144,9 @@ export async function configFromCLIOptions(cliOptions: CLIOptions): Promise<Conf
launchOptions.proxy.bypass = cliOptions.proxyBypass; launchOptions.proxy.bypass = cliOptions.proxyBypass;
} }
if (cliOptions.device && cliOptions.cdpEndpoint)
throw new Error('Device emulation is not supported with cdpEndpoint.');
// Context options // Context options
const contextOptions: BrowserContextOptions = cliOptions.device ? devices[cliOptions.device] : {}; const contextOptions: BrowserContextOptions = cliOptions.device ? devices[cliOptions.device] : {};
if (cliOptions.storageState) if (cliOptions.storageState)
@@ -169,7 +174,6 @@ export async function configFromCLIOptions(cliOptions: CLIOptions): Promise<Conf
const result: Config = { const result: Config = {
browser: { browser: {
browserAgent: cliOptions.browserAgent ?? process.env.PW_BROWSER_AGENT,
browserName, browserName,
isolated: cliOptions.isolated, isolated: cliOptions.isolated,
userDataDir: cliOptions.userDataDir, userDataDir: cliOptions.userDataDir,
@@ -181,8 +185,7 @@ export async function configFromCLIOptions(cliOptions: CLIOptions): Promise<Conf
port: cliOptions.port, port: cliOptions.port,
host: cliOptions.host, host: cliOptions.host,
}, },
capabilities: cliOptions.caps?.split(',').map((c: string) => c.trim() as ToolCapability), capabilities: cliOptions.caps as ToolCapability[],
vision: !!cliOptions.vision,
network: { network: {
allowedOrigins: cliOptions.allowedOrigins, allowedOrigins: cliOptions.allowedOrigins,
blockedOrigins: cliOptions.blockedOrigins, blockedOrigins: cliOptions.blockedOrigins,
@@ -195,6 +198,36 @@ export async function configFromCLIOptions(cliOptions: CLIOptions): Promise<Conf
return result; return result;
} }
function configFromEnv(): Config {
const options: CLIOptions = {};
options.allowedOrigins = semicolonSeparatedList(process.env.PLAYWRIGHT_MCP_ALLOWED_ORIGINS);
options.blockedOrigins = semicolonSeparatedList(process.env.PLAYWRIGHT_MCP_BLOCKED_ORIGINS);
options.blockServiceWorkers = envToBoolean(process.env.PLAYWRIGHT_MCP_BLOCK_SERVICE_WORKERS);
options.browser = envToString(process.env.PLAYWRIGHT_MCP_BROWSER);
options.caps = commaSeparatedList(process.env.PLAYWRIGHT_MCP_CAPS);
options.cdpEndpoint = envToString(process.env.PLAYWRIGHT_MCP_CDP_ENDPOINT);
options.config = envToString(process.env.PLAYWRIGHT_MCP_CONFIG);
options.device = envToString(process.env.PLAYWRIGHT_MCP_DEVICE);
options.executablePath = envToString(process.env.PLAYWRIGHT_MCP_EXECUTABLE_PATH);
options.headless = envToBoolean(process.env.PLAYWRIGHT_MCP_HEADLESS);
options.host = envToString(process.env.PLAYWRIGHT_MCP_HOST);
options.ignoreHttpsErrors = envToBoolean(process.env.PLAYWRIGHT_MCP_IGNORE_HTTPS_ERRORS);
options.isolated = envToBoolean(process.env.PLAYWRIGHT_MCP_ISOLATED);
if (process.env.PLAYWRIGHT_MCP_IMAGE_RESPONSES === 'omit')
options.imageResponses = 'omit';
options.sandbox = envToBoolean(process.env.PLAYWRIGHT_MCP_SANDBOX);
options.outputDir = envToString(process.env.PLAYWRIGHT_MCP_OUTPUT_DIR);
options.port = envToNumber(process.env.PLAYWRIGHT_MCP_PORT);
options.proxyBypass = envToString(process.env.PLAYWRIGHT_MCP_PROXY_BYPASS);
options.proxyServer = envToString(process.env.PLAYWRIGHT_MCP_PROXY_SERVER);
options.saveTrace = envToBoolean(process.env.PLAYWRIGHT_MCP_SAVE_TRACE);
options.storageState = envToString(process.env.PLAYWRIGHT_MCP_STORAGE_STATE);
options.userAgent = envToString(process.env.PLAYWRIGHT_MCP_USER_AGENT);
options.userDataDir = envToString(process.env.PLAYWRIGHT_MCP_USER_DATA_DIR);
options.viewportSize = envToString(process.env.PLAYWRIGHT_MCP_VIEWPORT_SIZE);
return configFromCLIOptions(options);
}
async function loadConfig(configFile: string | undefined): Promise<Config> { async function loadConfig(configFile: string | undefined): Promise<Config> {
if (!configFile) if (!configFile)
return {}; return {};
@@ -252,3 +285,33 @@ function mergeConfig(base: FullConfig, overrides: Config): FullConfig {
}, },
} as FullConfig; } as FullConfig;
} }
export function semicolonSeparatedList(value: string | undefined): string[] | undefined {
if (!value)
return undefined;
return value.split(';').map(v => v.trim());
}
export function commaSeparatedList(value: string | undefined): string[] | undefined {
if (!value)
return undefined;
return value.split(',').map(v => v.trim());
}
function envToNumber(value: string | undefined): number | undefined {
if (!value)
return undefined;
return +value;
}
function envToBoolean(value: string | undefined): boolean | undefined {
if (value === 'true' || value === '1')
return true;
if (value === 'false' || value === '0')
return false;
return undefined;
}
function envToString(value: string | undefined): string | undefined {
return value ? value.trim() : undefined;
}

View File

@@ -19,7 +19,7 @@ import { CallToolRequestSchema, ListToolsRequestSchema, Tool as McpTool } from '
import { zodToJsonSchema } from 'zod-to-json-schema'; import { zodToJsonSchema } from 'zod-to-json-schema';
import { Context } from './context.js'; import { Context } from './context.js';
import { snapshotTools, visionTools } from './tools.js'; import { allTools } from './tools.js';
import { packageJSON } from './package.js'; import { packageJSON } from './package.js';
import { FullConfig } from './config.js'; import { FullConfig } from './config.js';
@@ -27,9 +27,7 @@ import { FullConfig } from './config.js';
import type { BrowserContextFactory } from './browserContextFactory.js'; import type { BrowserContextFactory } from './browserContextFactory.js';
export function createConnection(config: FullConfig, browserContextFactory: BrowserContextFactory): Connection { export function createConnection(config: FullConfig, browserContextFactory: BrowserContextFactory): Connection {
const allTools = config.vision ? visionTools : snapshotTools; const tools = allTools.filter(tool => tool.capability.startsWith('core') || config.capabilities?.includes(tool.capability));
const tools = allTools.filter(tool => !config.capabilities || tool.capability === 'core' || config.capabilities.includes(tool.capability));
const context = new Context(tools, config, browserContextFactory); const context = new Context(tools, config, browserContextFactory);
const server = new McpServer({ name: 'Playwright', version: packageJSON.version }, { const server = new McpServer({ name: 'Playwright', version: packageJSON.version }, {
capabilities: { capabilities: {

View File

@@ -22,7 +22,6 @@ import { ManualPromise } from './manualPromise.js';
import { Tab } from './tab.js'; import { Tab } from './tab.js';
import { outputFile } from './config.js'; import { outputFile } from './config.js';
import type { ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';
import type { ModalState, Tool, ToolActionResult } from './tools/tool.js'; import type { ModalState, Tool, ToolActionResult } from './tools/tool.js';
import type { FullConfig } from './config.js'; import type { FullConfig } from './config.js';
import type { BrowserContextFactory } from './browserContextFactory.js'; import type { BrowserContextFactory } from './browserContextFactory.js';
@@ -53,11 +52,9 @@ export class Context {
} }
clientSupportsImages(): boolean { clientSupportsImages(): boolean {
if (this.config.imageResponses === 'allow')
return true;
if (this.config.imageResponses === 'omit') if (this.config.imageResponses === 'omit')
return false; return false;
return !this.clientVersion?.name.includes('cursor'); return true;
} }
modalStates(): ModalState[] { modalStates(): ModalState[] {
@@ -101,7 +98,7 @@ export class Context {
} }
async selectTab(index: number) { async selectTab(index: number) {
this._currentTab = this._tabs[index - 1]; this._currentTab = this._tabs[index];
await this._currentTab.page.bringToFront(); await this._currentTab.page.bringToFront();
} }
@@ -121,13 +118,13 @@ export class Context {
const title = await tab.title(); const title = await tab.title();
const url = tab.page.url(); const url = tab.page.url();
const current = tab === this._currentTab ? ' (current)' : ''; const current = tab === this._currentTab ? ' (current)' : '';
lines.push(`- ${i + 1}:${current} [${title}] (${url})`); lines.push(`- ${i}:${current} [${title}] (${url})`);
} }
return lines.join('\n'); return lines.join('\n');
} }
async closeTab(index: number | undefined) { async closeTab(index: number | undefined) {
const tab = index === undefined ? this._currentTab : this._tabs[index - 1]; const tab = index === undefined ? this._currentTab : this._tabs[index];
await tab?.page.close(); await tab?.page.close();
return await this.listTabsMarkdown(); return await this.listTabsMarkdown();
} }
@@ -136,7 +133,6 @@ export class Context {
// Tab management is done outside of the action() call. // Tab management is done outside of the action() call.
const toolResult = await tool.handle(this, tool.schema.inputSchema.parse(params || {})); const toolResult = await tool.handle(this, tool.schema.inputSchema.parse(params || {}));
const { code, action, waitForNetwork, captureSnapshot, resultOverride } = toolResult; const { code, action, waitForNetwork, captureSnapshot, resultOverride } = toolResult;
const racingAction = action ? () => this._raceAgainstModalDialogs(action) : undefined;
if (resultOverride) if (resultOverride)
return resultOverride; return resultOverride;
@@ -152,26 +148,26 @@ export class Context {
const tab = this.currentTabOrDie(); const tab = this.currentTabOrDie();
// TODO: race against modal dialogs to resolve clicks. // TODO: race against modal dialogs to resolve clicks.
let actionResult: { content?: (ImageContent | TextContent)[] } | undefined; const actionResult = await this._raceAgainstModalDialogs(async () => {
try { try {
if (waitForNetwork) if (waitForNetwork)
actionResult = await waitForCompletion(this, tab, async () => racingAction?.()) ?? undefined; return await waitForCompletion(this, tab, async () => action?.()) ?? undefined;
else else
actionResult = await racingAction?.() ?? undefined; return await action?.() ?? undefined;
} finally { } finally {
if (captureSnapshot && !this._javaScriptBlocked()) if (captureSnapshot && !this._javaScriptBlocked())
await tab.captureSnapshot(); await tab.captureSnapshot();
} }
});
const result: string[] = []; const result: string[] = [];
result.push(`- Ran Playwright code: result.push(`### Ran Playwright code
\`\`\`js \`\`\`js
${code.join('\n')} ${code.join('\n')}
\`\`\` \`\`\``);
`);
if (this.modalStates().length) { if (this.modalStates().length) {
result.push(...this.modalStatesMarkdown()); result.push('', ...this.modalStatesMarkdown());
return { return {
content: [{ content: [{
type: 'text', type: 'text',
@@ -180,6 +176,13 @@ ${code.join('\n')}
}; };
} }
const messages = tab.takeRecentConsoleMessages();
if (messages.length) {
result.push('', `### New console messages`);
for (const message of messages)
result.push(`- ${trim(message.toString(), 100)}`);
}
if (this._downloads.length) { if (this._downloads.length) {
result.push('', '### Downloads'); result.push('', '### Downloads');
for (const entry of this._downloads) { for (const entry of this._downloads) {
@@ -188,22 +191,23 @@ ${code.join('\n')}
else else
result.push(`- Downloading file ${entry.download.suggestedFilename()} ...`); result.push(`- Downloading file ${entry.download.suggestedFilename()} ...`);
} }
result.push('');
} }
if (captureSnapshot && tab.hasSnapshot()) {
if (this.tabs().length > 1) if (this.tabs().length > 1)
result.push(await this.listTabsMarkdown(), ''); result.push('', await this.listTabsMarkdown());
if (this.tabs().length > 1) if (this.tabs().length > 1)
result.push('### Current tab'); result.push('', '### Current tab');
else
result.push('', '### Page state');
result.push( result.push(
`- Page URL: ${tab.page.url()}`, `- Page URL: ${tab.page.url()}`,
`- Page Title: ${await tab.title()}` `- Page Title: ${await tab.title()}`
); );
if (captureSnapshot && tab.hasSnapshot())
result.push(tab.snapshotOrDie().text()); result.push(tab.snapshotOrDie().text());
}
const content = actionResult?.content ?? []; const content = actionResult?.content ?? [];
@@ -349,3 +353,9 @@ ${code.join('\n')}
return result; return result;
} }
} }
function trim(text: string, maxLength: number) {
if (text.length <= maxLength)
return text;
return text.slice(0, maxLength) + '...';
}

View File

@@ -14,23 +14,12 @@
* limitations under the License. * limitations under the License.
*/ */
import type { Context } from '../context.js'; import debug from 'debug';
export type ResourceSchema = { const errorsDebug = debug('pw:mcp:errors');
uri: string;
name: string;
description?: string;
mimeType?: string;
};
export type ResourceResult = { export function logUnhandledError(error: unknown) {
uri: string; errorsDebug(error);
mimeType?: string; }
text?: string;
blob?: string;
};
export type Resource = { export const testDebug = debug('pw:mcp:test');
schema: ResourceSchema;
read: (context: Context, uri: string) => Promise<ResourceResult[]>;
};

View File

@@ -42,7 +42,7 @@ export class PageSnapshot {
private async _build() { private async _build() {
const snapshot = await callOnPageNoTrace(this._page, page => (page as PageEx)._snapshotForAI()); const snapshot = await callOnPageNoTrace(this._page, page => (page as PageEx)._snapshotForAI());
this._text = [ this._text = [
`- Page Snapshot`, `- Page Snapshot:`,
'```yaml', '```yaml',
snapshot, snapshot,
'```', '```',

View File

@@ -14,12 +14,12 @@
* limitations under the License. * limitations under the License.
*/ */
import { program } from 'commander'; import { program, Option } from 'commander';
// @ts-ignore // @ts-ignore
import { startTraceViewerServer } from 'playwright-core/lib/server'; import { startTraceViewerServer } from 'playwright-core/lib/server';
import { startHttpTransport, startStdioTransport } from './transport.js'; import { startHttpServer, startHttpTransport, startStdioTransport } from './transport.js';
import { resolveCLIConfig } from './config.js'; import { commaSeparatedList, resolveCLIConfig, semicolonSeparatedList } from './config.js';
import { Server } from './server.js'; import { Server } from './server.js';
import { packageJSON } from './package.js'; import { packageJSON } from './package.js';
@@ -30,8 +30,7 @@ program
.option('--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.', semicolonSeparatedList) .option('--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.', semicolonSeparatedList)
.option('--block-service-workers', 'block service workers') .option('--block-service-workers', 'block service workers')
.option('--browser <browser>', 'browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.') .option('--browser <browser>', 'browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.')
.option('--browser-agent <endpoint>', 'Use browser agent (experimental).') .option('--caps <caps>', 'comma-separated list of additional capabilities to enable, possible values: vision, pdf.', commaSeparatedList)
.option('--caps <caps>', 'comma-separated list of capabilities to enable, possible values: tabs, pdf, history, wait, files, install. Default is all.')
.option('--cdp-endpoint <endpoint>', 'CDP endpoint to connect to.') .option('--cdp-endpoint <endpoint>', 'CDP endpoint to connect to.')
.option('--config <path>', 'path to the configuration file.') .option('--config <path>', 'path to the configuration file.')
.option('--device <device>', 'device to emulate, for example: "iPhone 15"') .option('--device <device>', 'device to emulate, for example: "iPhone 15"')
@@ -40,7 +39,7 @@ program
.option('--host <host>', 'host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.') .option('--host <host>', 'host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.')
.option('--ignore-https-errors', 'ignore https errors') .option('--ignore-https-errors', 'ignore https errors')
.option('--isolated', 'keep the browser profile in memory, do not save it to disk.') .option('--isolated', 'keep the browser profile in memory, do not save it to disk.')
.option('--image-responses <mode>', 'whether to send image responses to the client. Can be "allow", "omit", or "auto". Defaults to "auto", which sends images if the client can display them.') .option('--image-responses <mode>', 'whether to send image responses to the client. Can be "allow" or "omit", Defaults to "allow".')
.option('--no-sandbox', 'disable the sandbox for all process types that are normally sandboxed.') .option('--no-sandbox', 'disable the sandbox for all process types that are normally sandboxed.')
.option('--output-dir <path>', 'path to the directory for output files.') .option('--output-dir <path>', 'path to the directory for output files.')
.option('--port <port>', 'port to listen on for SSE transport.') .option('--port <port>', 'port to listen on for SSE transport.')
@@ -51,14 +50,21 @@ program
.option('--user-agent <ua string>', 'specify user agent string') .option('--user-agent <ua string>', 'specify user agent string')
.option('--user-data-dir <path>', 'path to the user data directory. If not specified, a temporary directory will be created.') .option('--user-data-dir <path>', 'path to the user data directory. If not specified, a temporary directory will be created.')
.option('--viewport-size <size>', 'specify browser viewport size in pixels, for example "1280, 720"') .option('--viewport-size <size>', 'specify browser viewport size in pixels, for example "1280, 720"')
.option('--vision', 'Run server that uses screenshots (Aria snapshots are used by default)') .addOption(new Option('--vision', 'Legacy option, use --caps=vision instead').hideHelp())
.action(async options => { .action(async options => {
if (options.vision) {
// eslint-disable-next-line no-console
console.error('The --vision option is deprecated, use --caps=vision instead');
options.caps = 'vision';
}
const config = await resolveCLIConfig(options); const config = await resolveCLIConfig(options);
const httpServer = config.server.port !== undefined ? await startHttpServer(config.server) : undefined;
const server = new Server(config); const server = new Server(config);
server.setupExitWatchdog(); server.setupExitWatchdog();
if (config.server.port !== undefined) if (httpServer)
startHttpTransport(server); startHttpTransport(httpServer, server);
else else
await startStdioTransport(server); await startStdioTransport(server);
@@ -71,8 +77,4 @@ program
} }
}); });
function semicolonSeparatedList(value: string): string[] {
return value.split(';').map(v => v.trim());
}
void program.parseAsync(process.argv); void program.parseAsync(process.argv);

View File

@@ -17,14 +17,16 @@
import * as playwright from 'playwright'; import * as playwright from 'playwright';
import { PageSnapshot } from './pageSnapshot.js'; import { PageSnapshot } from './pageSnapshot.js';
import { callOnPageNoTrace } from './tools/utils.js';
import { logUnhandledError } from './log.js';
import type { Context } from './context.js'; import type { Context } from './context.js';
import { callOnPageNoTrace } from './tools/utils.js';
export class Tab { export class Tab {
readonly context: Context; readonly context: Context;
readonly page: playwright.Page; readonly page: playwright.Page;
private _consoleMessages: playwright.ConsoleMessage[] = []; private _consoleMessages: ConsoleMessage[] = [];
private _recentConsoleMessages: ConsoleMessage[] = [];
private _requests: Map<playwright.Request, playwright.Response | null> = new Map(); private _requests: Map<playwright.Request, playwright.Response | null> = new Map();
private _snapshot: PageSnapshot | undefined; private _snapshot: PageSnapshot | undefined;
private _onPageClose: (tab: Tab) => void; private _onPageClose: (tab: Tab) => void;
@@ -33,7 +35,8 @@ export class Tab {
this.context = context; this.context = context;
this.page = page; this.page = page;
this._onPageClose = onPageClose; this._onPageClose = onPageClose;
page.on('console', event => this._consoleMessages.push(event)); page.on('console', event => this._handleConsoleMessage(messageToConsoleMessage(event)));
page.on('pageerror', error => this._handleConsoleMessage(pageErrorToConsoleMessage(error)));
page.on('request', request => this._requests.set(request, null)); page.on('request', request => this._requests.set(request, null));
page.on('response', response => this._requests.set(response.request(), response)); page.on('response', response => this._requests.set(response.request(), response));
page.on('close', () => this._onClose()); page.on('close', () => this._onClose());
@@ -54,9 +57,15 @@ export class Tab {
private _clearCollectedArtifacts() { private _clearCollectedArtifacts() {
this._consoleMessages.length = 0; this._consoleMessages.length = 0;
this._recentConsoleMessages.length = 0;
this._requests.clear(); this._requests.clear();
} }
private _handleConsoleMessage(message: ConsoleMessage) {
this._consoleMessages.push(message);
this._recentConsoleMessages.push(message);
}
private _onClose() { private _onClose() {
this._clearCollectedArtifacts(); this._clearCollectedArtifacts();
this._onPageClose(this); this._onPageClose(this);
@@ -67,13 +76,13 @@ export class Tab {
} }
async waitForLoadState(state: 'load', options?: { timeout?: number }): Promise<void> { async waitForLoadState(state: 'load', options?: { timeout?: number }): Promise<void> {
await callOnPageNoTrace(this.page, page => page.waitForLoadState(state, options).catch(() => {})); await callOnPageNoTrace(this.page, page => page.waitForLoadState(state, options).catch(logUnhandledError));
} }
async navigate(url: string) { async navigate(url: string) {
this._clearCollectedArtifacts(); this._clearCollectedArtifacts();
const downloadEvent = callOnPageNoTrace(this.page, page => page.waitForEvent('download').catch(() => {})); const downloadEvent = callOnPageNoTrace(this.page, page => page.waitForEvent('download').catch(logUnhandledError));
try { try {
await this.page.goto(url, { waitUntil: 'domcontentloaded' }); await this.page.goto(url, { waitUntil: 'domcontentloaded' });
} catch (_e: unknown) { } catch (_e: unknown) {
@@ -106,7 +115,7 @@ export class Tab {
return this._snapshot; return this._snapshot;
} }
consoleMessages(): playwright.ConsoleMessage[] { consoleMessages(): ConsoleMessage[] {
return this._consoleMessages; return this._consoleMessages;
} }
@@ -117,4 +126,39 @@ export class Tab {
async captureSnapshot() { async captureSnapshot() {
this._snapshot = await PageSnapshot.create(this.page); this._snapshot = await PageSnapshot.create(this.page);
} }
takeRecentConsoleMessages(): ConsoleMessage[] {
const result = this._recentConsoleMessages.slice();
this._recentConsoleMessages.length = 0;
return result;
}
}
export type ConsoleMessage = {
type: ReturnType<playwright.ConsoleMessage['type']> | undefined;
text: string;
toString(): string;
};
function messageToConsoleMessage(message: playwright.ConsoleMessage): ConsoleMessage {
return {
type: message.type(),
text: message.text(),
toString: () => `[${message.type().toUpperCase()}] ${message.text()} @ ${message.location().url}:${message.location().lineNumber}`,
};
}
function pageErrorToConsoleMessage(errorOrValue: Error | any): ConsoleMessage {
if (errorOrValue instanceof Error) {
return {
type: undefined,
text: errorOrValue.message,
toString: () => errorOrValue.stack || errorOrValue.message,
};
}
return {
type: undefined,
text: String(errorOrValue),
toString: () => String(errorOrValue),
};
} }

View File

@@ -17,6 +17,7 @@
import common from './tools/common.js'; import common from './tools/common.js';
import console from './tools/console.js'; import console from './tools/console.js';
import dialogs from './tools/dialogs.js'; import dialogs from './tools/dialogs.js';
import evaluate from './tools/evaluate.js';
import files from './tools/files.js'; import files from './tools/files.js';
import install from './tools/install.js'; import install from './tools/install.js';
import keyboard from './tools/keyboard.js'; import keyboard from './tools/keyboard.js';
@@ -26,41 +27,25 @@ import pdf from './tools/pdf.js';
import snapshot from './tools/snapshot.js'; import snapshot from './tools/snapshot.js';
import tabs from './tools/tabs.js'; import tabs from './tools/tabs.js';
import screenshot from './tools/screenshot.js'; import screenshot from './tools/screenshot.js';
import testing from './tools/testing.js';
import vision from './tools/vision.js';
import wait from './tools/wait.js'; import wait from './tools/wait.js';
import mouse from './tools/mouse.js';
import type { Tool } from './tools/tool.js'; import type { Tool } from './tools/tool.js';
export const snapshotTools: Tool<any>[] = [ export const allTools: Tool<any>[] = [
...common(true), ...common,
...console, ...console,
...dialogs(true), ...dialogs,
...files(true), ...evaluate,
...files,
...install, ...install,
...keyboard(true), ...keyboard,
...navigate(true), ...navigate,
...network, ...network,
...mouse,
...pdf, ...pdf,
...screenshot, ...screenshot,
...snapshot, ...snapshot,
...tabs(true), ...tabs,
...testing, ...wait,
...wait(true),
];
export const visionTools: Tool<any>[] = [
...common(false),
...console,
...dialogs(false),
...files(false),
...install,
...keyboard(false),
...navigate(false),
...network,
...pdf,
...tabs(false),
...testing,
...vision,
...wait(false),
]; ];

View File

@@ -15,7 +15,7 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const close = defineTool({ const close = defineTool({
capability: 'core', capability: 'core',
@@ -38,7 +38,7 @@ const close = defineTool({
}, },
}); });
const resize: ToolFactory = captureSnapshot => defineTool({ const resize = defineTool({
capability: 'core', capability: 'core',
schema: { schema: {
name: 'browser_resize', name: 'browser_resize',
@@ -66,13 +66,13 @@ const resize: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
action, action,
captureSnapshot, captureSnapshot: true,
waitForNetwork: true waitForNetwork: true
}; };
}, },
}); });
export default (captureSnapshot: boolean) => [ export default [
close, close,
resize(captureSnapshot) resize
]; ];

View File

@@ -28,7 +28,7 @@ const console = defineTool({
}, },
handle: async context => { handle: async context => {
const messages = context.currentTabOrDie().consoleMessages(); const messages = context.currentTabOrDie().consoleMessages();
const log = messages.map(message => `[${message.type().toUpperCase()}] ${message.text()}`).join('\n'); const log = messages.map(message => message.toString()).join('\n');
return { return {
code: [`// <internal code to get console messages>`], code: [`// <internal code to get console messages>`],
action: async () => { action: async () => {

View File

@@ -15,9 +15,9 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const handleDialog: ToolFactory = captureSnapshot => defineTool({ const handleDialog = defineTool({
capability: 'core', capability: 'core',
schema: { schema: {
@@ -49,7 +49,7 @@ const handleDialog: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false, waitForNetwork: false,
}; };
}, },
@@ -57,6 +57,6 @@ const handleDialog: ToolFactory = captureSnapshot => defineTool({
clearsModalState: 'dialog', clearsModalState: 'dialog',
}); });
export default (captureSnapshot: boolean) => [ export default [
handleDialog(captureSnapshot), handleDialog,
]; ];

71
src/tools/evaluate.ts Normal file
View File

@@ -0,0 +1,71 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { z } from 'zod';
import { defineTool } from './tool.js';
import * as javascript from '../javascript.js';
import { generateLocator } from './utils.js';
import type * as playwright from 'playwright';
const evaluateSchema = z.object({
function: z.string().describe('() => { /* code */ } or (element) => { /* code */ } when element is provided'),
element: z.string().optional().describe('Human-readable element description used to obtain permission to interact with the element'),
ref: z.string().optional().describe('Exact target element reference from the page snapshot'),
});
const evaluate = defineTool({
capability: 'core',
schema: {
name: 'browser_evaluate',
title: 'Evaluate JavaScript',
description: 'Evaluate JavaScript expression on page or element',
inputSchema: evaluateSchema,
type: 'destructive',
},
handle: async (context, params) => {
const tab = context.currentTabOrDie();
const code: string[] = [];
let locator: playwright.Locator | undefined;
if (params.ref && params.element) {
const snapshot = tab.snapshotOrDie();
locator = snapshot.refLocator({ ref: params.ref, element: params.element });
code.push(`await page.${await generateLocator(locator)}.evaluate(${javascript.quote(params.function)});`);
} else {
code.push(`await page.evaluate(${javascript.quote(params.function)});`);
}
return {
code,
action: async () => {
const receiver = locator ?? tab.page as any;
const result = await receiver._evaluateFunction(params.function);
return {
content: [{ type: 'text', text: '- Result: ' + (JSON.stringify(result, null, 2) || 'undefined') }],
};
},
captureSnapshot: false,
waitForNetwork: false,
};
},
});
export default [
evaluate,
];

View File

@@ -15,10 +15,10 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const uploadFile: ToolFactory = captureSnapshot => defineTool({ const uploadFile = defineTool({
capability: 'files', capability: 'core',
schema: { schema: {
name: 'browser_file_upload', name: 'browser_file_upload',
@@ -47,13 +47,13 @@ const uploadFile: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
action, action,
captureSnapshot, captureSnapshot: true,
waitForNetwork: true, waitForNetwork: true,
}; };
}, },
clearsModalState: 'fileChooser', clearsModalState: 'fileChooser',
}); });
export default (captureSnapshot: boolean) => [ export default [
uploadFile(captureSnapshot), uploadFile,
]; ];

View File

@@ -23,7 +23,7 @@ import { defineTool } from './tool.js';
import { fileURLToPath } from 'node:url'; import { fileURLToPath } from 'node:url';
const install = defineTool({ const install = defineTool({
capability: 'install', capability: 'core-install',
schema: { schema: {
name: 'browser_install', name: 'browser_install',
title: 'Install the browser specified in the config', title: 'Install the browser specified in the config',

View File

@@ -15,9 +15,13 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js';
const pressKey: ToolFactory = captureSnapshot => defineTool({ import { defineTool } from './tool.js';
import { elementSchema } from './snapshot.js';
import { generateLocator } from './utils.js';
import * as javascript from '../javascript.js';
const pressKey = defineTool({
capability: 'core', capability: 'core',
schema: { schema: {
@@ -43,12 +47,61 @@ const pressKey: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
action, action,
captureSnapshot, captureSnapshot: true,
waitForNetwork: true waitForNetwork: true
}; };
}, },
}); });
export default (captureSnapshot: boolean) => [ const typeSchema = elementSchema.extend({
pressKey(captureSnapshot), text: z.string().describe('Text to type into the element'),
submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
slowly: z.boolean().optional().describe('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.'),
});
const type = defineTool({
capability: 'core',
schema: {
name: 'browser_type',
title: 'Type text',
description: 'Type text into editable element',
inputSchema: typeSchema,
type: 'destructive',
},
handle: async (context, params) => {
const snapshot = context.currentTabOrDie().snapshotOrDie();
const locator = snapshot.refLocator(params);
const code: string[] = [];
const steps: (() => Promise<void>)[] = [];
if (params.slowly) {
code.push(`// Press "${params.text}" sequentially into "${params.element}"`);
code.push(`await page.${await generateLocator(locator)}.pressSequentially(${javascript.quote(params.text)});`);
steps.push(() => locator.pressSequentially(params.text));
} else {
code.push(`// Fill "${params.text}" into "${params.element}"`);
code.push(`await page.${await generateLocator(locator)}.fill(${javascript.quote(params.text)});`);
steps.push(() => locator.fill(params.text));
}
if (params.submit) {
code.push(`// Submit text`);
code.push(`await page.${await generateLocator(locator)}.press('Enter');`);
steps.push(() => locator.press('Enter'));
}
return {
code,
action: () => steps.reduce((acc, step) => acc.then(step), Promise.resolve()),
captureSnapshot: true,
waitForNetwork: true,
};
},
});
export default [
pressKey,
type,
]; ];

View File

@@ -17,50 +17,14 @@
import { z } from 'zod'; import { z } from 'zod';
import { defineTool } from './tool.js'; import { defineTool } from './tool.js';
import * as javascript from '../javascript.js';
const elementSchema = z.object({ const elementSchema = z.object({
element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'), element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
}); });
const screenshot = defineTool({ const mouseMove = defineTool({
capability: 'core', capability: 'vision',
schema: { schema: {
name: 'browser_screen_capture', name: 'browser_mouse_move_xy',
title: 'Take a screenshot',
description: 'Take a screenshot of the current page',
inputSchema: z.object({}),
type: 'readOnly',
},
handle: async context => {
const tab = await context.ensureTab();
const options = { type: 'jpeg' as 'jpeg', quality: 50, scale: 'css' as 'css' };
const code = [
`// Take a screenshot of the current page`,
`await page.screenshot(${javascript.formatObject(options)});`,
];
const action = () => tab.page.screenshot(options).then(buffer => {
return {
content: [{ type: 'image' as 'image', data: buffer.toString('base64'), mimeType: 'image/jpeg' }],
};
});
return {
code,
action,
captureSnapshot: false,
waitForNetwork: false
};
},
});
const moveMouse = defineTool({
capability: 'core',
schema: {
name: 'browser_screen_move_mouse',
title: 'Move mouse', title: 'Move mouse',
description: 'Move mouse to a given position', description: 'Move mouse to a given position',
inputSchema: elementSchema.extend({ inputSchema: elementSchema.extend({
@@ -86,12 +50,12 @@ const moveMouse = defineTool({
}, },
}); });
const click = defineTool({ const mouseClick = defineTool({
capability: 'core', capability: 'vision',
schema: { schema: {
name: 'browser_screen_click', name: 'browser_mouse_click_xy',
title: 'Click', title: 'Click',
description: 'Click left mouse button', description: 'Click left mouse button at a given position',
inputSchema: elementSchema.extend({ inputSchema: elementSchema.extend({
x: z.number().describe('X coordinate'), x: z.number().describe('X coordinate'),
y: z.number().describe('Y coordinate'), y: z.number().describe('Y coordinate'),
@@ -121,12 +85,12 @@ const click = defineTool({
}, },
}); });
const drag = defineTool({ const mouseDrag = defineTool({
capability: 'core', capability: 'vision',
schema: { schema: {
name: 'browser_screen_drag', name: 'browser_mouse_drag_xy',
title: 'Drag mouse', title: 'Drag mouse',
description: 'Drag left mouse button', description: 'Drag left mouse button to a given position',
inputSchema: elementSchema.extend({ inputSchema: elementSchema.extend({
startX: z.number().describe('Start X coordinate'), startX: z.number().describe('Start X coordinate'),
startY: z.number().describe('Start Y coordinate'), startY: z.number().describe('Start Y coordinate'),
@@ -163,51 +127,8 @@ const drag = defineTool({
}, },
}); });
const type = defineTool({
capability: 'core',
schema: {
name: 'browser_screen_type',
title: 'Type text',
description: 'Type text',
inputSchema: z.object({
text: z.string().describe('Text to type into the element'),
submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
}),
type: 'destructive',
},
handle: async (context, params) => {
const tab = context.currentTabOrDie();
const code = [
`// Type ${params.text}`,
`await page.keyboard.type('${params.text}');`,
];
const action = async () => {
await tab.page.keyboard.type(params.text);
if (params.submit)
await tab.page.keyboard.press('Enter');
};
if (params.submit) {
code.push(`// Submit text`);
code.push(`await page.keyboard.press('Enter');`);
}
return {
code,
action,
captureSnapshot: false,
waitForNetwork: true,
};
},
});
export default [ export default [
screenshot, mouseMove,
moveMouse, mouseClick,
click, mouseDrag,
drag,
type,
]; ];

View File

@@ -15,9 +15,9 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const navigate: ToolFactory = captureSnapshot => defineTool({ const navigate = defineTool({
capability: 'core', capability: 'core',
schema: { schema: {
@@ -41,14 +41,14 @@ const navigate: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false, waitForNetwork: false,
}; };
}, },
}); });
const goBack: ToolFactory = captureSnapshot => defineTool({ const goBack = defineTool({
capability: 'history', capability: 'core',
schema: { schema: {
name: 'browser_navigate_back', name: 'browser_navigate_back',
title: 'Go back', title: 'Go back',
@@ -67,14 +67,14 @@ const goBack: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false, waitForNetwork: false,
}; };
}, },
}); });
const goForward: ToolFactory = captureSnapshot => defineTool({ const goForward = defineTool({
capability: 'history', capability: 'core',
schema: { schema: {
name: 'browser_navigate_forward', name: 'browser_navigate_forward',
title: 'Go forward', title: 'Go forward',
@@ -91,14 +91,14 @@ const goForward: ToolFactory = captureSnapshot => defineTool({
]; ];
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false, waitForNetwork: false,
}; };
}, },
}); });
export default (captureSnapshot: boolean) => [ export default [
navigate(captureSnapshot), navigate,
goBack(captureSnapshot), goBack,
goForward(captureSnapshot), goForward,
]; ];

View File

@@ -79,7 +79,7 @@ const screenshot = defineTool({
return { return {
code, code,
action, action,
captureSnapshot: true, captureSnapshot: false,
waitForNetwork: false, waitForNetwork: false,
}; };
} }

View File

@@ -41,33 +41,44 @@ const snapshot = defineTool({
}, },
}); });
const elementSchema = z.object({ export const elementSchema = z.object({
element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'), element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
ref: z.string().describe('Exact target element reference from the page snapshot'), ref: z.string().describe('Exact target element reference from the page snapshot'),
}); });
const clickSchema = elementSchema.extend({
doubleClick: z.boolean().optional().describe('Whether to perform a double click instead of a single click'),
button: z.enum(['left', 'right', 'middle']).optional().describe('Button to click, defaults to left'),
});
const click = defineTool({ const click = defineTool({
capability: 'core', capability: 'core',
schema: { schema: {
name: 'browser_click', name: 'browser_click',
title: 'Click', title: 'Click',
description: 'Perform click on a web page', description: 'Perform click on a web page',
inputSchema: elementSchema, inputSchema: clickSchema,
type: 'destructive', type: 'destructive',
}, },
handle: async (context, params) => { handle: async (context, params) => {
const tab = context.currentTabOrDie(); const tab = context.currentTabOrDie();
const locator = tab.snapshotOrDie().refLocator(params); const locator = tab.snapshotOrDie().refLocator(params);
const button = params.button;
const buttonAttr = button ? `{ button: '${button}' }` : '';
const code = [ const code: string[] = [];
`// Click ${params.element}`, if (params.doubleClick) {
`await page.${await generateLocator(locator)}.click();` code.push(`// Double click ${params.element}`);
]; code.push(`await page.${await generateLocator(locator)}.dblclick(${buttonAttr});`);
} else {
code.push(`// Click ${params.element}`);
code.push(`await page.${await generateLocator(locator)}.click(${buttonAttr});`);
}
return { return {
code, code,
action: () => locator.click(), action: () => params.doubleClick ? locator.dblclick({ button }) : locator.click({ button }),
captureSnapshot: true, captureSnapshot: true,
waitForNetwork: true, waitForNetwork: true,
}; };
@@ -136,54 +147,6 @@ const hover = defineTool({
}, },
}); });
const typeSchema = elementSchema.extend({
text: z.string().describe('Text to type into the element'),
submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
slowly: z.boolean().optional().describe('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.'),
});
const type = defineTool({
capability: 'core',
schema: {
name: 'browser_type',
title: 'Type text',
description: 'Type text into editable element',
inputSchema: typeSchema,
type: 'destructive',
},
handle: async (context, params) => {
const snapshot = context.currentTabOrDie().snapshotOrDie();
const locator = snapshot.refLocator(params);
const code: string[] = [];
const steps: (() => Promise<void>)[] = [];
if (params.slowly) {
code.push(`// Press "${params.text}" sequentially into "${params.element}"`);
code.push(`await page.${await generateLocator(locator)}.pressSequentially(${javascript.quote(params.text)});`);
steps.push(() => locator.pressSequentially(params.text));
} else {
code.push(`// Fill "${params.text}" into "${params.element}"`);
code.push(`await page.${await generateLocator(locator)}.fill(${javascript.quote(params.text)});`);
steps.push(() => locator.fill(params.text));
}
if (params.submit) {
code.push(`// Submit text`);
code.push(`await page.${await generateLocator(locator)}.press('Enter');`);
steps.push(() => locator.press('Enter'));
}
return {
code,
action: () => steps.reduce((acc, step) => acc.then(step), Promise.resolve()),
captureSnapshot: true,
waitForNetwork: true,
};
},
});
const selectOptionSchema = elementSchema.extend({ const selectOptionSchema = elementSchema.extend({
values: z.array(z.string()).describe('Array of values to select in the dropdown. This can be a single value or multiple values.'), values: z.array(z.string()).describe('Array of values to select in the dropdown. This can be a single value or multiple values.'),
}); });
@@ -221,6 +184,5 @@ export default [
click, click,
drag, drag,
hover, hover,
type,
selectOption, selectOption,
]; ];

View File

@@ -15,10 +15,10 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const listTabs = defineTool({ const listTabs = defineTool({
capability: 'tabs', capability: 'core-tabs',
schema: { schema: {
name: 'browser_tab_list', name: 'browser_tab_list',
@@ -44,8 +44,8 @@ const listTabs = defineTool({
}, },
}); });
const selectTab: ToolFactory = captureSnapshot => defineTool({ const selectTab = defineTool({
capability: 'tabs', capability: 'core-tabs',
schema: { schema: {
name: 'browser_tab_select', name: 'browser_tab_select',
@@ -65,14 +65,14 @@ const selectTab: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false waitForNetwork: false
}; };
}, },
}); });
const newTab: ToolFactory = captureSnapshot => defineTool({ const newTab = defineTool({
capability: 'tabs', capability: 'core-tabs',
schema: { schema: {
name: 'browser_tab_new', name: 'browser_tab_new',
@@ -94,14 +94,14 @@ const newTab: ToolFactory = captureSnapshot => defineTool({
]; ];
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false waitForNetwork: false
}; };
}, },
}); });
const closeTab: ToolFactory = captureSnapshot => defineTool({ const closeTab = defineTool({
capability: 'tabs', capability: 'core-tabs',
schema: { schema: {
name: 'browser_tab_close', name: 'browser_tab_close',
@@ -120,15 +120,15 @@ const closeTab: ToolFactory = captureSnapshot => defineTool({
]; ];
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false waitForNetwork: false
}; };
}, },
}); });
export default (captureSnapshot: boolean) => [ export default [
listTabs, listTabs,
newTab(captureSnapshot), newTab,
selectTab(captureSnapshot), selectTab,
closeTab(captureSnapshot), closeTab,
]; ];

View File

@@ -1,67 +0,0 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { z } from 'zod';
import { defineTool } from './tool.js';
const generateTestSchema = z.object({
name: z.string().describe('The name of the test'),
description: z.string().describe('The description of the test'),
steps: z.array(z.string()).describe('The steps of the test'),
});
const generateTest = defineTool({
capability: 'testing',
schema: {
name: 'browser_generate_playwright_test',
title: 'Generate a Playwright test',
description: 'Generate a Playwright test for given scenario',
inputSchema: generateTestSchema,
type: 'readOnly',
},
handle: async (context, params) => {
return {
resultOverride: {
content: [{
type: 'text',
text: instructions(params),
}],
},
code: [],
captureSnapshot: false,
waitForNetwork: false,
};
},
});
const instructions = (params: { name: string, description: string, steps: string[] }) => [
`## Instructions`,
`- You are a playwright test generator.`,
`- You are given a scenario and you need to generate a playwright test for it.`,
'- DO NOT generate test code based on the scenario alone. DO run steps one by one using the tools provided instead.',
'- Only after all steps are completed, emit a Playwright TypeScript test that uses @playwright/test based on message history',
'- Save generated test file in the tests directory',
`Test name: ${params.name}`,
`Description: ${params.description}`,
`Steps:`,
...params.steps.map((step, index) => `- ${index + 1}. ${step}`),
].join('\n');
export default [
generateTest,
];

View File

@@ -61,8 +61,6 @@ export type Tool<Input extends InputType = InputType> = {
handle: (context: Context, params: z.output<Input>) => Promise<ToolResult>; handle: (context: Context, params: z.output<Input>) => Promise<ToolResult>;
}; };
export type ToolFactory = (snapshot: boolean) => Tool<any>;
export function defineTool<Input extends InputType>(tool: Tool<Input>): Tool<Input> { export function defineTool<Input extends InputType>(tool: Tool<Input>): Tool<Input> {
return tool; return tool;
} }

View File

@@ -14,6 +14,9 @@
* limitations under the License. * limitations under the License.
*/ */
// @ts-ignore
import { asLocator } from 'playwright-core/lib/utils';
import type * as playwright from 'playwright'; import type * as playwright from 'playwright';
import type { Context } from '../context.js'; import type { Context } from '../context.js';
import type { Tab } from '../tab.js'; import type { Tab } from '../tab.js';
@@ -78,7 +81,12 @@ export function sanitizeForFilePath(s: string) {
} }
export async function generateLocator(locator: playwright.Locator): Promise<string> { export async function generateLocator(locator: playwright.Locator): Promise<string> {
return (locator as any)._generateLocatorString(); try {
const { resolvedSelector } = await (locator as any)._resolveSelector();
return asLocator('javascript', resolvedSelector);
} catch (e) {
throw new Error('Ref not found, likely because element was removed. Use browser_snapshot to see what elements are currently on the page.');
}
} }
export async function callOnPageNoTrace<T>(page: playwright.Page, callback: (page: playwright.Page) => Promise<T>): Promise<T> { export async function callOnPageNoTrace<T>(page: playwright.Page, callback: (page: playwright.Page) => Promise<T>): Promise<T> {

View File

@@ -15,10 +15,10 @@
*/ */
import { z } from 'zod'; import { z } from 'zod';
import { defineTool, type ToolFactory } from './tool.js'; import { defineTool } from './tool.js';
const wait: ToolFactory = captureSnapshot => defineTool({ const wait = defineTool({
capability: 'wait', capability: 'core',
schema: { schema: {
name: 'browser_wait_for', name: 'browser_wait_for',
@@ -40,7 +40,7 @@ const wait: ToolFactory = captureSnapshot => defineTool({
if (params.time) { if (params.time) {
code.push(`await new Promise(f => setTimeout(f, ${params.time!} * 1000));`); code.push(`await new Promise(f => setTimeout(f, ${params.time!} * 1000));`);
await new Promise(f => setTimeout(f, Math.min(10000, params.time! * 1000))); await new Promise(f => setTimeout(f, Math.min(30000, params.time! * 1000)));
} }
const tab = context.currentTabOrDie(); const tab = context.currentTabOrDie();
@@ -59,12 +59,12 @@ const wait: ToolFactory = captureSnapshot => defineTool({
return { return {
code, code,
captureSnapshot, captureSnapshot: true,
waitForNetwork: false, waitForNetwork: false,
}; };
}, },
}); });
export default (captureSnapshot: boolean) => [ export default [
wait(captureSnapshot), wait,
]; ];

View File

@@ -23,6 +23,7 @@ import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'; import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
import type { AddressInfo } from 'node:net';
import type { Server } from './server.js'; import type { Server } from './server.js';
export async function startStdioTransport(server: Server) { export async function startStdioTransport(server: Server) {
@@ -96,30 +97,30 @@ async function handleStreamable(server: Server, req: http.IncomingMessage, res:
res.end('Invalid request'); res.end('Invalid request');
} }
export function startHttpTransport(server: Server) { export async function startHttpServer(config: { host?: string, port?: number }): Promise<http.Server> {
const { host, port } = config;
const httpServer = http.createServer();
await new Promise<void>((resolve, reject) => {
httpServer.on('error', reject);
httpServer.listen(port, host, () => {
resolve();
httpServer.removeListener('error', reject);
});
});
return httpServer;
}
export function startHttpTransport(httpServer: http.Server, mcpServer: Server) {
const sseSessions = new Map<string, SSEServerTransport>(); const sseSessions = new Map<string, SSEServerTransport>();
const streamableSessions = new Map<string, StreamableHTTPServerTransport>(); const streamableSessions = new Map<string, StreamableHTTPServerTransport>();
const httpServer = http.createServer(async (req, res) => { httpServer.on('request', async (req, res) => {
const url = new URL(`http://localhost${req.url}`); const url = new URL(`http://localhost${req.url}`);
if (url.pathname.startsWith('/mcp')) if (url.pathname.startsWith('/mcp'))
await handleStreamable(server, req, res, streamableSessions); await handleStreamable(mcpServer, req, res, streamableSessions);
else else
await handleSSE(server, req, res, url, sseSessions); await handleSSE(mcpServer, req, res, url, sseSessions);
}); });
const { host, port } = server.config.server; const url = httpAddressToString(httpServer.address());
httpServer.listen(port, host, () => {
const address = httpServer.address();
assert(address, 'Could not bind server socket');
let url: string;
if (typeof address === 'string') {
url = address;
} else {
const resolvedPort = address.port;
let resolvedHost = address.family === 'IPv4' ? address.address : `[${address.address}]`;
if (resolvedHost === '0.0.0.0' || resolvedHost === '[::]')
resolvedHost = 'localhost';
url = `http://${resolvedHost}:${resolvedPort}`;
}
const message = [ const message = [
`Listening on ${url}`, `Listening on ${url}`,
'Put this in your client config:', 'Put this in your client config:',
@@ -134,5 +135,15 @@ export function startHttpTransport(server: Server) {
].join('\n'); ].join('\n');
// eslint-disable-next-line no-console // eslint-disable-next-line no-console
console.error(message); console.error(message);
}); }
export function httpAddressToString(address: string | AddressInfo | null): string {
assert(address, 'Could not bind server socket');
if (typeof address === 'string')
return address;
const resolvedPort = address.port;
let resolvedHost = address.family === 'IPv4' ? address.address : `[${address.address}]`;
if (resolvedHost === '0.0.0.0' || resolvedHost === '[::]')
resolvedHost = 'localhost';
return `http://${resolvedHost}:${resolvedPort}`;
} }

View File

@@ -1,77 +0,0 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import path from 'path';
import url from 'node:url';
import { spawn } from 'child_process';
import { test as baseTest, expect } from './fixtures.js';
import type { ChildProcess } from 'child_process';
const __filename = url.fileURLToPath(import.meta.url);
const test = baseTest.extend<{ agentEndpoint: (options?: { args?: string[] }) => Promise<{ url: URL, stdout: () => string }> }>({
agentEndpoint: async ({}, use) => {
let cp: ChildProcess | undefined;
await use(async (options?: { args?: string[] }) => {
if (cp)
throw new Error('Process already running');
cp = spawn('node', [
path.join(path.dirname(__filename), '../lib/browserServer.js'),
...(options?.args || []),
], {
stdio: 'pipe',
env: {
...process.env,
DEBUG: 'pw:mcp:test',
DEBUG_COLORS: '0',
DEBUG_HIDE_DATE: '1',
},
});
let stdout = '';
const url = await new Promise<string>(resolve => cp!.stdout?.on('data', data => {
stdout += data.toString();
const match = stdout.match(/Listening on (http:\/\/.*)/);
if (match)
resolve(match[1]);
}));
return { url: new URL(url), stdout: () => stdout };
});
cp?.kill('SIGTERM');
},
});
test.skip(({ mcpBrowser }) => mcpBrowser !== 'chrome', 'Agent is CDP-only for now');
test('browser lifecycle', async ({ agentEndpoint, startClient, server }) => {
const { url: agentUrl } = await agentEndpoint();
const { client: client1 } = await startClient({ args: ['--browser-agent', agentUrl.toString()] });
expect(await client1.callTool({
name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD },
})).toContainTextContent('Hello, world!');
const { client: client2 } = await startClient({ args: ['--browser-agent', agentUrl.toString()] });
expect(await client2.callTool({
name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD },
})).toContainTextContent('Hello, world!');
await client1.close();
await client2.close();
});

View File

@@ -22,8 +22,8 @@ test('test snapshot tool list', async ({ client }) => {
'browser_click', 'browser_click',
'browser_console_messages', 'browser_console_messages',
'browser_drag', 'browser_drag',
'browser_evaluate',
'browser_file_upload', 'browser_file_upload',
'browser_generate_playwright_test',
'browser_handle_dialog', 'browser_handle_dialog',
'browser_hover', 'browser_hover',
'browser_select_option', 'browser_select_option',
@@ -34,7 +34,6 @@ test('test snapshot tool list', async ({ client }) => {
'browser_navigate_forward', 'browser_navigate_forward',
'browser_navigate', 'browser_navigate',
'browser_network_requests', 'browser_network_requests',
'browser_pdf_save',
'browser_press_key', 'browser_press_key',
'browser_resize', 'browser_resize',
'browser_snapshot', 'browser_snapshot',
@@ -47,46 +46,33 @@ test('test snapshot tool list', async ({ client }) => {
])); ]));
}); });
test('test vision tool list', async ({ visionClient }) => { test('test capabilities (pdf)', async ({ startClient }) => {
const { tools: visionTools } = await visionClient.listTools();
expect(new Set(visionTools.map(t => t.name))).toEqual(new Set([
'browser_close',
'browser_console_messages',
'browser_file_upload',
'browser_generate_playwright_test',
'browser_handle_dialog',
'browser_install',
'browser_navigate_back',
'browser_navigate_forward',
'browser_navigate',
'browser_network_requests',
'browser_pdf_save',
'browser_press_key',
'browser_resize',
'browser_screen_capture',
'browser_screen_click',
'browser_screen_drag',
'browser_screen_move_mouse',
'browser_screen_type',
'browser_tab_close',
'browser_tab_list',
'browser_tab_new',
'browser_tab_select',
'browser_wait_for',
]));
});
test('test capabilities', async ({ startClient }) => {
const { client } = await startClient({ const { client } = await startClient({
args: ['--caps="core"'], args: ['--caps=pdf'],
}); });
const { tools } = await client.listTools(); const { tools } = await client.listTools();
const toolNames = tools.map(t => t.name); const toolNames = tools.map(t => t.name);
expect(toolNames).not.toContain('browser_file_upload'); expect(toolNames).toContain('browser_pdf_save');
expect(toolNames).not.toContain('browser_pdf_save'); });
expect(toolNames).not.toContain('browser_screen_capture');
expect(toolNames).not.toContain('browser_screen_click'); test('test capabilities (vision)', async ({ startClient }) => {
expect(toolNames).not.toContain('browser_screen_drag'); const { client } = await startClient({
expect(toolNames).not.toContain('browser_screen_move_mouse'); args: ['--caps=vision'],
expect(toolNames).not.toContain('browser_screen_type'); });
const { tools } = await client.listTools();
const toolNames = tools.map(t => t.name);
expect(toolNames).toContain('browser_mouse_move_xy');
expect(toolNames).toContain('browser_mouse_click_xy');
expect(toolNames).toContain('browser_mouse_drag_xy');
});
test('support for legacy --vision option', async ({ startClient }) => {
const { client } = await startClient({
args: ['--vision'],
});
const { tools } = await client.listTools();
const toolNames = tools.map(t => t.name);
expect(toolNames).toContain('browser_mouse_move_xy');
expect(toolNames).toContain('browser_mouse_click_xy');
expect(toolNames).toContain('browser_mouse_drag_xy');
}); });

View File

@@ -14,6 +14,9 @@
* limitations under the License. * limitations under the License.
*/ */
import url from 'node:url';
import path from 'node:path';
import { spawnSync } from 'node:child_process';
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
test('cdp server', async ({ cdpServer, startClient, server }) => { test('cdp server', async ({ cdpServer, startClient, server }) => {
@@ -22,7 +25,7 @@ test('cdp server', async ({ cdpServer, startClient, server }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`- generic [ref=e1]: Hello, world!`); })).toContainTextContent(`- generic [active] [ref=e1]: Hello, world!`);
}); });
test('cdp server reuse tab', async ({ cdpServer, startClient, server }) => { test('cdp server reuse tab', async ({ cdpServer, startClient, server }) => {
@@ -43,16 +46,17 @@ test('cdp server reuse tab', async ({ cdpServer, startClient, server }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_snapshot', name: 'browser_snapshot',
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// <internal code to capture accessibility snapshot> // <internal code to capture accessibility snapshot>
\`\`\` \`\`\`
### Page state
- Page URL: ${server.HELLO_WORLD} - Page URL: ${server.HELLO_WORLD}
- Page Title: Title - Page Title: Title
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Hello, world! - generic [active] [ref=e1]: Hello, world!
\`\`\` \`\`\`
`); `);
}); });
@@ -73,5 +77,17 @@ test('should throw connection error and allow re-connecting', async ({ cdpServer
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.PREFIX }, arguments: { url: server.PREFIX },
})).toContainTextContent(`- generic [ref=e1]: Hello, world!`); })).toContainTextContent(`- generic [active] [ref=e1]: Hello, world!`);
});
// NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename.
const __filename = url.fileURLToPath(import.meta.url);
test('does not support --device', async () => {
const result = spawnSync('node', [
path.join(__filename, '../../cli.js'), '--device=Pixel 5', '--cdp-endpoint=http://localhost:1234',
]);
expect(result.error).toBeUndefined();
expect(result.status).toBe(1);
expect(result.stderr.toString()).toContain('Device emulation is not supported with cdpEndpoint.');
}); });

119
tests/click.spec.ts Normal file
View File

@@ -0,0 +1,119 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { test, expect } from './fixtures.js';
test('browser_click', async ({ client, server, mcpBrowser }) => {
server.setContent('/', `
<title>Title</title>
<button>Submit</button>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
expect(await client.callTool({
name: 'browser_click',
arguments: {
element: 'Submit button',
ref: 'e2',
},
})).toHaveTextContent(`
### Ran Playwright code
\`\`\`js
// Click Submit button
await page.getByRole('button', { name: 'Submit' }).click();
\`\`\`
### Page state
- Page URL: ${server.PREFIX}
- Page Title: Title
- Page Snapshot:
\`\`\`yaml
- button "Submit" ${mcpBrowser !== 'webkit' || process.platform === 'linux' ? '[active] ' : ''}[ref=e2]
\`\`\`
`);
});
test('browser_click (double)', async ({ client, server }) => {
server.setContent('/', `
<title>Title</title>
<script>
function handle() {
document.querySelector('h1').textContent = 'Double clicked';
}
</script>
<h1 ondblclick="handle()">Click me</h1>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
expect(await client.callTool({
name: 'browser_click',
arguments: {
element: 'Click me',
ref: 'e2',
doubleClick: true,
},
})).toHaveTextContent(`
### Ran Playwright code
\`\`\`js
// Double click Click me
await page.getByRole('heading', { name: 'Click me' }).dblclick();
\`\`\`
### Page state
- Page URL: ${server.PREFIX}
- Page Title: Title
- Page Snapshot:
\`\`\`yaml
- heading "Double clicked" [level=1] [ref=e3]
\`\`\`
`);
});
test('browser_click (right)', async ({ client, server }) => {
server.setContent('/', `
<button oncontextmenu="handle">Menu</button>
<script>
document.addEventListener('contextmenu', event => {
event.preventDefault();
document.querySelector('button').textContent = 'Right clicked';
});
</script>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
const result = await client.callTool({
name: 'browser_click',
arguments: {
element: 'Menu',
ref: 'e2',
button: 'right',
},
});
expect(result).toContainTextContent(`await page.getByRole('button', { name: 'Menu' }).click({ button: 'right' });`);
expect(result).toContainTextContent(`- button "Right clicked"`);
});

View File

@@ -19,7 +19,7 @@ import fs from 'node:fs';
import { Config } from '../config.js'; import { Config } from '../config.js';
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
test('config user data dir', async ({ startClient, server }, testInfo) => { test('config user data dir', async ({ startClient, server, mcpMode }, testInfo) => {
server.setContent('/', ` server.setContent('/', `
<title>Title</title> <title>Title</title>
<body>Hello, world!</body> <body>Hello, world!</body>
@@ -45,7 +45,7 @@ test('config user data dir', async ({ startClient, server }, testInfo) => {
test.describe(() => { test.describe(() => {
test.use({ mcpBrowser: '' }); test.use({ mcpBrowser: '' });
test('browserName', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/458' } }, async ({ startClient }, testInfo) => { test('browserName', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/458' } }, async ({ startClient, mcpMode }, testInfo) => {
const config: Config = { const config: Config = {
browser: { browser: {
browserName: 'firefox', browserName: 'firefox',

View File

@@ -38,7 +38,59 @@ test('browser_console_messages', async ({ client, server }) => {
name: 'browser_console_messages', name: 'browser_console_messages',
}); });
expect(resource).toHaveTextContent([ expect(resource).toHaveTextContent([
'[LOG] Hello, world!', `[LOG] Hello, world! @ ${server.PREFIX}:4`,
'[ERROR] Error', `[ERROR] Error @ ${server.PREFIX}:5`,
].join('\n')); ].join('\n'));
}); });
test('browser_console_messages (page error)', async ({ client, server }) => {
server.setContent('/', `
<!DOCTYPE html>
<html>
<script>
throw new Error("Error in script");
</script>
</html>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: {
url: server.PREFIX,
},
});
const resource = await client.callTool({
name: 'browser_console_messages',
});
expect(resource).toHaveTextContent(/Error: Error in script/);
expect(resource).toHaveTextContent(new RegExp(server.PREFIX));
});
test('recent console messages', async ({ client, server }) => {
server.setContent('/', `
<!DOCTYPE html>
<html>
<button onclick="console.log('Hello, world!');">Click me</button>
</html>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: {
url: server.PREFIX,
},
});
const response = await client.callTool({
name: 'browser_click',
arguments: {
element: 'Click me',
ref: 'e2',
},
});
expect(response).toContainTextContent(`
### New console messages
- [LOG] Hello, world! @`);
});

View File

@@ -21,55 +21,23 @@ test('browser_navigate', async ({ client, server }) => {
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// Navigate to ${server.HELLO_WORLD} // Navigate to ${server.HELLO_WORLD}
await page.goto('${server.HELLO_WORLD}'); await page.goto('${server.HELLO_WORLD}');
\`\`\` \`\`\`
### Page state
- Page URL: ${server.HELLO_WORLD} - Page URL: ${server.HELLO_WORLD}
- Page Title: Title - Page Title: Title
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Hello, world! - generic [active] [ref=e1]: Hello, world!
\`\`\` \`\`\`
` `
); );
}); });
test('browser_click', async ({ client, server }) => {
server.setContent('/', `
<title>Title</title>
<button>Submit</button>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
expect(await client.callTool({
name: 'browser_click',
arguments: {
element: 'Submit button',
ref: 'e2',
},
})).toHaveTextContent(`
- Ran Playwright code:
\`\`\`js
// Click Submit button
await page.getByRole('button', { name: 'Submit' }).click();
\`\`\`
- Page URL: ${server.PREFIX}
- Page Title: Title
- Page Snapshot
\`\`\`yaml
- button "Submit" [ref=e2]
\`\`\`
`);
});
test('browser_select_option', async ({ client, server }) => { test('browser_select_option', async ({ client, server }) => {
server.setContent('/', ` server.setContent('/', `
<title>Title</title> <title>Title</title>
@@ -92,15 +60,16 @@ test('browser_select_option', async ({ client, server }) => {
values: ['bar'], values: ['bar'],
}, },
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// Select options [bar] in Select // Select options [bar] in Select
await page.getByRole('combobox').selectOption(['bar']); await page.getByRole('combobox').selectOption(['bar']);
\`\`\` \`\`\`
### Page state
- Page URL: ${server.PREFIX} - Page URL: ${server.PREFIX}
- Page Title: Title - Page Title: Title
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- combobox [ref=e2]: - combobox [ref=e2]:
- option "Foo" - option "Foo"
@@ -132,15 +101,16 @@ test('browser_select_option (multiple)', async ({ client, server }) => {
values: ['bar', 'baz'], values: ['bar', 'baz'],
}, },
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// Select options [bar, baz] in Select // Select options [bar, baz] in Select
await page.getByRole('listbox').selectOption(['bar', 'baz']); await page.getByRole('listbox').selectOption(['bar', 'baz']);
\`\`\` \`\`\`
### Page state
- Page URL: ${server.PREFIX} - Page URL: ${server.PREFIX}
- Page Title: Title - Page Title: Title
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- listbox [ref=e2]: - listbox [ref=e2]:
- option "Foo" [ref=e3] - option "Foo" [ref=e3]
@@ -175,7 +145,7 @@ test('browser_type', async ({ client, server }) => {
}); });
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_console_messages', name: 'browser_console_messages',
})).toHaveTextContent('[LOG] Key pressed: Enter , Text: Hi!'); })).toHaveTextContent(/\[LOG\] Key pressed: Enter , Text: Hi!/);
}); });
test('browser_type (slowly)', async ({ client, server }) => { test('browser_type (slowly)', async ({ client, server }) => {
@@ -199,14 +169,13 @@ test('browser_type (slowly)', async ({ client, server }) => {
slowly: true, slowly: true,
}, },
}); });
expect(await client.callTool({ const response = await client.callTool({
name: 'browser_console_messages', name: 'browser_console_messages',
})).toHaveTextContent([ });
'[LOG] Key pressed: H Text: ', expect(response).toHaveTextContent(/\[LOG\] Key pressed: H Text: /);
'[LOG] Key pressed: i Text: H', expect(response).toHaveTextContent(/\[LOG\] Key pressed: i Text: H/);
'[LOG] Key pressed: ! Text: Hi', expect(response).toHaveTextContent(/\[LOG\] Key pressed: ! Text: Hi/);
'[LOG] Key pressed: Enter Text: Hi!', expect(response).toHaveTextContent(/\[LOG\] Key pressed: Enter Text: Hi!/);
].join('\n'));
}); });
test('browser_resize', async ({ client, server }) => { test('browser_resize', async ({ client, server }) => {
@@ -230,10 +199,67 @@ test('browser_resize', async ({ client, server }) => {
height: 780, height: 780,
}, },
}); });
expect(response).toContainTextContent(`- Ran Playwright code: expect(response).toContainTextContent(`### Ran Playwright code
\`\`\`js \`\`\`js
// Resize browser window to 390x780 // Resize browser window to 390x780
await page.setViewportSize({ width: 390, height: 780 }); await page.setViewportSize({ width: 390, height: 780 });
\`\`\``); \`\`\``);
await expect.poll(() => client.callTool({ name: 'browser_snapshot' })).toContainTextContent('Window size: 390x780'); await expect.poll(() => client.callTool({ name: 'browser_snapshot' })).toContainTextContent('Window size: 390x780');
}); });
test('old locator error message', async ({ client, server }) => {
server.setContent('/', `
<button>Button 1</button>
<button>Button 2</button>
<script>
document.querySelector('button').addEventListener('click', () => {
document.querySelectorAll('button')[1].remove();
});
</script>
`, 'text/html');
expect(await client.callTool({
name: 'browser_navigate',
arguments: {
url: server.PREFIX,
},
})).toContainTextContent(`
- button "Button 1" [ref=e2]
- button "Button 2" [ref=e3]
`.trim());
await client.callTool({
name: 'browser_click',
arguments: {
element: 'Button 1',
ref: 'e2',
},
});
expect(await client.callTool({
name: 'browser_click',
arguments: {
element: 'Button 2',
ref: 'e3',
},
})).toContainTextContent('Ref not found');
});
test('visibility: hidden > visible should be shown', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/535' } }, async ({ client, server }) => {
server.setContent('/', `
<div style="visibility: hidden;">
<div style="visibility: visible;">
<button>Button</button>
</div>
</div>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
expect(await client.callTool({
name: 'browser_snapshot'
})).toContainTextContent('- button "Button"');
});

View File

@@ -16,7 +16,7 @@
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
test('--device should work', async ({ startClient, server }) => { test('--device should work', async ({ startClient, server, mcpMode }) => {
const { client } = await startClient({ const { client } = await startClient({
args: ['--device', 'iPhone 15'], args: ['--device', 'iPhone 15'],
}); });

View File

@@ -16,9 +16,6 @@
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
// https://github.com/microsoft/playwright/issues/35663
test.skip(({ mcpBrowser, mcpHeadless }) => mcpBrowser === 'webkit' && mcpHeadless);
test('alert dialog', async ({ client, server }) => { test('alert dialog', async ({ client, server }) => {
server.setContent('/', `<button onclick="alert('Alert')">Button</button>`, 'text/html'); server.setContent('/', `<button onclick="alert('Alert')">Button</button>`, 'text/html');
expect(await client.callTool({ expect(await client.callTool({
@@ -32,7 +29,7 @@ test('alert dialog', async ({ client, server }) => {
element: 'Button', element: 'Button',
ref: 'e2', ref: 'e2',
}, },
})).toHaveTextContent(`- Ran Playwright code: })).toHaveTextContent(`### Ran Playwright code
\`\`\`js \`\`\`js
// Click Button // Click Button
await page.getByRole('button', { name: 'Button' }).click(); await page.getByRole('button', { name: 'Button' }).click();
@@ -49,23 +46,20 @@ await page.getByRole('button', { name: 'Button' }).click();
}); });
expect(result).not.toContainTextContent('### Modal state'); expect(result).not.toContainTextContent('### Modal state');
expect(result).toHaveTextContent(`- Ran Playwright code: expect(result).toContainTextContent(`### Ran Playwright code
\`\`\`js \`\`\`js
// <internal code to handle "alert" dialog> // <internal code to handle "alert" dialog>
\`\`\` \`\`\`
### Page state
- Page URL: ${server.PREFIX} - Page URL: ${server.PREFIX}
- Page Title: - Page Title:
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- button "Button" [ref=e2] - button "Button"`);
\`\`\`
`);
}); });
test('two alert dialogs', async ({ client, server }) => { test('two alert dialogs', async ({ client, server }) => {
test.fixme(true, 'Race between the dialog and ariaSnapshot');
server.setContent('/', ` server.setContent('/', `
<title>Title</title> <title>Title</title>
<body> <body>
@@ -84,7 +78,7 @@ test('two alert dialogs', async ({ client, server }) => {
element: 'Button', element: 'Button',
ref: 'e2', ref: 'e2',
}, },
})).toHaveTextContent(`- Ran Playwright code: })).toHaveTextContent(`### Ran Playwright code
\`\`\`js \`\`\`js
// Click Button // Click Button
await page.getByRole('button', { name: 'Button' }).click(); await page.getByRole('button', { name: 'Button' }).click();
@@ -100,7 +94,18 @@ await page.getByRole('button', { name: 'Button' }).click();
}, },
}); });
expect(result).not.toContainTextContent('### Modal state'); expect(result).toContainTextContent(`
### Modal state
- ["alert" dialog with message "Alert 2"]: can be handled by the "browser_handle_dialog" tool`);
const result2 = await client.callTool({
name: 'browser_handle_dialog',
arguments: {
accept: true,
},
});
expect(result2).not.toContainTextContent('### Modal state');
}); });
test('confirm dialog (true)', async ({ client, server }) => { test('confirm dialog (true)', async ({ client, server }) => {
@@ -134,9 +139,9 @@ test('confirm dialog (true)', async ({ client, server }) => {
expect(result).not.toContainTextContent('### Modal state'); expect(result).not.toContainTextContent('### Modal state');
expect(result).toContainTextContent('// <internal code to handle "confirm" dialog>'); expect(result).toContainTextContent('// <internal code to handle "confirm" dialog>');
expect(result).toContainTextContent(`- Page Snapshot expect(result).toContainTextContent(`- Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: "true" - generic [active] [ref=e1]: "true"
\`\`\``); \`\`\``);
}); });
@@ -169,9 +174,9 @@ test('confirm dialog (false)', async ({ client, server }) => {
}, },
}); });
expect(result).toContainTextContent(`- Page Snapshot expect(result).toContainTextContent(`- Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: "false" - generic [active] [ref=e1]: "false"
\`\`\``); \`\`\``);
}); });
@@ -205,8 +210,51 @@ test('prompt dialog', async ({ client, server }) => {
}, },
}); });
expect(result).toContainTextContent(`- Page Snapshot expect(result).toContainTextContent(`- Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Answer - generic [active] [ref=e1]: Answer
\`\`\``); \`\`\``);
}); });
test('alert dialog w/ race', async ({ client, server }) => {
server.setContent('/', `<button onclick="setTimeout(() => alert('Alert'), 100)">Button</button>`, 'text/html');
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toContainTextContent('- button "Button" [ref=e2]');
expect(await client.callTool({
name: 'browser_click',
arguments: {
element: 'Button',
ref: 'e2',
},
})).toHaveTextContent(`### Ran Playwright code
\`\`\`js
// Click Button
await page.getByRole('button', { name: 'Button' }).click();
\`\`\`
### Modal state
- ["alert" dialog with message "Alert"]: can be handled by the "browser_handle_dialog" tool`);
const result = await client.callTool({
name: 'browser_handle_dialog',
arguments: {
accept: true,
},
});
expect(result).not.toContainTextContent('### Modal state');
expect(result).toContainTextContent(`### Ran Playwright code
\`\`\`js
// <internal code to handle "alert" dialog>
\`\`\`
### Page state
- Page URL: ${server.PREFIX}
- Page Title:
- Page Snapshot:
\`\`\`yaml
- button "Button"`);
});

51
tests/evaluate.spec.ts Normal file
View File

@@ -0,0 +1,51 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { test, expect } from './fixtures.js';
test('browser_evaluate', async ({ client, server }) => {
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`- Page Title: Title`);
const result = await client.callTool({
name: 'browser_evaluate',
arguments: {
function: '() => document.title',
},
});
expect(result).toContainTextContent(`"Title"`);
});
test('browser_evaluate (element)', async ({ client, server }) => {
server.setContent('/', `
<body style="background-color: red">Hello, world!</body>
`, 'text/html');
await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
});
expect(await client.callTool({
name: 'browser_evaluate',
arguments: {
function: 'element => element.style.backgroundColor',
element: 'body',
ref: 'e1',
},
})).toContainTextContent(`- Result: "red"`);
});

View File

@@ -28,7 +28,7 @@ test('browser_file_upload', async ({ client, server }, testInfo) => {
arguments: { url: server.PREFIX }, arguments: { url: server.PREFIX },
})).toContainTextContent(` })).toContainTextContent(`
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: - generic [active] [ref=e1]:
- button "Choose File" [ref=e2] - button "Choose File" [ref=e2]
- button "Button" [ref=e3] - button "Button" [ref=e3]
\`\`\``); \`\`\``);
@@ -65,12 +65,6 @@ The tool "browser_file_upload" can only be used when there is related modal stat
}); });
expect(response).not.toContainTextContent('### Modal state'); expect(response).not.toContainTextContent('### Modal state');
expect(response).toContainTextContent(`
\`\`\`yaml
- generic [ref=e1]:
- button "Choose File" [ref=e2]
- button "Button" [ref=e3]
\`\`\``);
} }
{ {
@@ -100,7 +94,7 @@ The tool "browser_file_upload" can only be used when there is related modal stat
} }
}); });
test('clicking on download link emits download', async ({ startClient, server }, testInfo) => { test('clicking on download link emits download', async ({ startClient, server, mcpMode }, testInfo) => {
const { client } = await startClient({ const { client } = await startClient({
config: { outputDir: testInfo.outputPath('output') }, config: { outputDir: testInfo.outputPath('output') },
}); });
@@ -124,7 +118,7 @@ test('clicking on download link emits download', async ({ startClient, server },
- Downloaded file test.txt to ${testInfo.outputPath('output', 'test.txt')}`); - Downloaded file test.txt to ${testInfo.outputPath('output', 'test.txt')}`);
}); });
test('navigating to download link emits download', async ({ startClient, server, mcpBrowser }, testInfo) => { test('navigating to download link emits download', async ({ startClient, server, mcpBrowser, mcpMode }, testInfo) => {
const { client } = await startClient({ const { client } = await startClient({
config: { outputDir: testInfo.outputPath('output') }, config: { outputDir: testInfo.outputPath('output') },
}); });

View File

@@ -26,6 +26,8 @@ import { TestServer } from './testserver/index.ts';
import type { Config } from '../config'; import type { Config } from '../config';
import type { BrowserContext } from 'playwright'; import type { BrowserContext } from 'playwright';
import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
import type { Stream } from 'stream';
export type TestOptions = { export type TestOptions = {
mcpBrowser: string | undefined; mcpBrowser: string | undefined;
@@ -39,7 +41,6 @@ type CDPServer = {
type TestFixtures = { type TestFixtures = {
client: Client; client: Client;
visionClient: Client;
startClient: (options?: { clientName?: string, args?: string[], config?: Config }) => Promise<{ client: Client, stderr: () => string }>; startClient: (options?: { clientName?: string, args?: string[], config?: Config }) => Promise<{ client: Client, stderr: () => string }>;
wsEndpoint: string; wsEndpoint: string;
cdpServer: CDPServer; cdpServer: CDPServer;
@@ -59,11 +60,6 @@ export const test = baseTest.extend<TestFixtures & TestOptions, WorkerFixtures>(
await use(client); await use(client);
}, },
visionClient: async ({ startClient }, use) => {
const { client } = await startClient({ args: ['--vision'] });
await use(client);
},
startClient: async ({ mcpHeadless, mcpBrowser, mcpMode }, use, testInfo) => { startClient: async ({ mcpHeadless, mcpBrowser, mcpMode }, use, testInfo) => {
const userDataDir = mcpMode !== 'docker' ? testInfo.outputPath('user-data-dir') : undefined; const userDataDir = mcpMode !== 'docker' ? testInfo.outputPath('user-data-dir') : undefined;
const configDir = path.dirname(test.info().config.configFile!); const configDir = path.dirname(test.info().config.configFile!);
@@ -88,16 +84,16 @@ export const test = baseTest.extend<TestFixtures & TestOptions, WorkerFixtures>(
} }
client = new Client({ name: options?.clientName ?? 'test', version: '1.0.0' }); client = new Client({ name: options?.clientName ?? 'test', version: '1.0.0' });
const transport = createTransport(args, mcpMode); const { transport, stderr } = await createTransport(args, mcpMode);
let stderr = ''; let stderrBuffer = '';
transport.stderr?.on('data', data => { stderr?.on('data', data => {
if (process.env.PWMCP_DEBUG) if (process.env.PWMCP_DEBUG)
process.stderr.write(data); process.stderr.write(data);
stderr += data.toString(); stderrBuffer += data.toString();
}); });
await client.connect(transport); await client.connect(transport);
await client.ping(); await client.ping();
return { client, stderr: () => stderr }; return { client, stderr: () => stderrBuffer };
}); });
await client?.close(); await client?.close();
@@ -164,17 +160,25 @@ export const test = baseTest.extend<TestFixtures & TestOptions, WorkerFixtures>(
}, },
}); });
function createTransport(args: string[], mcpMode: TestOptions['mcpMode']) { async function createTransport(args: string[], mcpMode: TestOptions['mcpMode']): Promise<{
transport: Transport,
stderr: Stream | null,
}> {
// NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename. // NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename.
const __filename = url.fileURLToPath(import.meta.url); const __filename = url.fileURLToPath(import.meta.url);
if (mcpMode === 'docker') { if (mcpMode === 'docker') {
const dockerArgs = ['run', '--rm', '-i', '--network=host', '-v', `${test.info().project.outputDir}:/app/test-results`]; const dockerArgs = ['run', '--rm', '-i', '--network=host', '-v', `${test.info().project.outputDir}:/app/test-results`];
return new StdioClientTransport({ const transport = new StdioClientTransport({
command: 'docker', command: 'docker',
args: [...dockerArgs, 'playwright-mcp-dev:latest', ...args], args: [...dockerArgs, 'playwright-mcp-dev:latest', ...args],
}); });
return {
transport,
stderr: transport.stderr,
};
} }
return new StdioClientTransport({
const transport = new StdioClientTransport({
command: 'node', command: 'node',
args: [path.join(path.dirname(__filename), '../cli.js'), ...args], args: [path.join(path.dirname(__filename), '../cli.js'), ...args],
cwd: path.join(path.dirname(__filename), '..'), cwd: path.join(path.dirname(__filename), '..'),
@@ -186,6 +190,10 @@ function createTransport(args: string[], mcpMode: TestOptions['mcpMode']) {
DEBUG_HIDE_DATE: '1', DEBUG_HIDE_DATE: '1',
}, },
}); });
return {
transport,
stderr: transport.stderr!,
};
} }
type Response = Awaited<ReturnType<Client['callTool']>>; type Response = Awaited<ReturnType<Client['callTool']>>;
@@ -218,17 +226,14 @@ export const expect = baseExpect.extend({
}; };
}, },
toContainTextContent(response: Response, content: string | string[]) { toContainTextContent(response: Response, content: string) {
const isNot = this.isNot; const isNot = this.isNot;
try { try {
content = Array.isArray(content) ? content : [content]; const texts = (response.content as any).map(c => c.text).join('\n');
const texts = (response.content as any).map(c => c.text);
for (let i = 0; i < texts.length; i++) {
if (isNot) if (isNot)
expect(texts[i]).not.toContain(content[i]); expect(texts).not.toContain(content);
else else
expect(texts[i]).toContain(content[i]); expect(texts).toContain(content);
}
} catch (e) { } catch (e) {
return { return {
pass: isNot, pass: isNot,

View File

@@ -24,10 +24,10 @@ test('stitched aria frames', async ({ client }) => {
}, },
})).toContainTextContent(` })).toContainTextContent(`
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: - generic [active] [ref=e1]:
- heading "Hello" [level=1] [ref=e2] - heading "Hello" [level=1] [ref=e2]
- iframe [ref=e3]: - iframe [ref=e3]:
- generic [ref=f1e1]: - generic [active] [ref=f1e1]:
- button "World" [ref=f1e2] - button "World" [ref=f1e2]
- main [ref=f1e3]: - main [ref=f1e3]:
- iframe [ref=f1e4]: - iframe [ref=f1e4]:

View File

@@ -18,7 +18,7 @@ import fs from 'fs';
import { test, expect, formatOutput } from './fixtures.js'; import { test, expect, formatOutput } from './fixtures.js';
test('test reopen browser', async ({ startClient, server }) => { test('test reopen browser', async ({ startClient, server, mcpMode }) => {
const { client, stderr } = await startClient(); const { client, stderr } = await startClient();
await client.callTool({ await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
@@ -32,7 +32,7 @@ test('test reopen browser', async ({ startClient, server }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`- generic [ref=e1]: Hello, world!`); })).toContainTextContent(`- generic [active] [ref=e1]: Hello, world!`);
await client.close(); await client.close();

View File

@@ -19,7 +19,7 @@ import fs from 'fs';
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
test('save as pdf unavailable', async ({ startClient, server }) => { test('save as pdf unavailable', async ({ startClient, server }) => {
const { client } = await startClient({ args: ['--caps="no-pdf"'] }); const { client } = await startClient();
await client.callTool({ await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
@@ -32,7 +32,7 @@ test('save as pdf unavailable', async ({ startClient, server }) => {
test('save as pdf', async ({ startClient, mcpBrowser, server }, testInfo) => { test('save as pdf', async ({ startClient, mcpBrowser, server }, testInfo) => {
const { client } = await startClient({ const { client } = await startClient({
config: { outputDir: testInfo.outputPath('output') }, config: { outputDir: testInfo.outputPath('output'), capabilities: ['pdf'] },
}); });
test.skip(!!mcpBrowser && !['chromium', 'chrome', 'msedge'].includes(mcpBrowser), 'Save as PDF is only supported in Chromium.'); test.skip(!!mcpBrowser && !['chromium', 'chrome', 'msedge'].includes(mcpBrowser), 'Save as PDF is only supported in Chromium.');
@@ -40,7 +40,7 @@ test('save as pdf', async ({ startClient, mcpBrowser, server }, testInfo) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`- generic [ref=e1]: Hello, world!`); })).toContainTextContent(`- generic [active] [ref=e1]: Hello, world!`);
const response = await client.callTool({ const response = await client.callTool({
name: 'browser_pdf_save', name: 'browser_pdf_save',
@@ -52,13 +52,13 @@ test('save as pdf (filename: output.pdf)', async ({ startClient, mcpBrowser, ser
const outputDir = testInfo.outputPath('output'); const outputDir = testInfo.outputPath('output');
test.skip(!!mcpBrowser && !['chromium', 'chrome', 'msedge'].includes(mcpBrowser), 'Save as PDF is only supported in Chromium.'); test.skip(!!mcpBrowser && !['chromium', 'chrome', 'msedge'].includes(mcpBrowser), 'Save as PDF is only supported in Chromium.');
const { client } = await startClient({ const { client } = await startClient({
config: { outputDir }, config: { outputDir, capabilities: ['pdf'] },
}); });
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_navigate', name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD }, arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`- generic [ref=e1]: Hello, world!`); })).toContainTextContent(`- generic [active] [ref=e1]: Hello, world!`);
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_pdf_save', name: 'browser_pdf_save',

View File

@@ -201,32 +201,3 @@ test('browser_take_screenshot (imageResponses=omit)', async ({ startClient, serv
], ],
}); });
}); });
test('browser_take_screenshot (cursor)', async ({ startClient, server }, testInfo) => {
const outputDir = testInfo.outputPath('output');
const { client } = await startClient({
clientName: 'cursor:vscode',
config: { outputDir },
});
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD },
})).toContainTextContent(`Navigate to http://localhost`);
await client.callTool({
name: 'browser_take_screenshot',
});
expect(await client.callTool({
name: 'browser_take_screenshot',
})).toEqual({
content: [
{
text: expect.stringContaining(`Screenshot viewport and save it as`),
type: 'text',
},
],
});
});

View File

@@ -31,7 +31,7 @@ test('list initial tabs', async ({ client }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_tab_list', name: 'browser_tab_list',
})).toHaveTextContent(`### Open tabs })).toHaveTextContent(`### Open tabs
- 1: (current) [] (about:blank)`); - 0: (current) [] (about:blank)`);
}); });
test('list first tab', async ({ client }) => { test('list first tab', async ({ client }) => {
@@ -39,46 +39,36 @@ test('list first tab', async ({ client }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_tab_list', name: 'browser_tab_list',
})).toHaveTextContent(`### Open tabs })).toHaveTextContent(`### Open tabs
- 1: [] (about:blank) - 0: [] (about:blank)
- 2: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)`); - 1: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)`);
}); });
test('create new tab', async ({ client }) => { test('create new tab', async ({ client }) => {
expect(await createTab(client, 'Tab one', 'Body one')).toHaveTextContent(` expect(await createTab(client, 'Tab one', 'Body one')).toContainTextContent(`
- Ran Playwright code:
\`\`\`js
// <internal code to open a new tab>
\`\`\`
### Open tabs ### Open tabs
- 1: [] (about:blank) - 0: [] (about:blank)
- 2: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>) - 1: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)
### Current tab ### Current tab
- Page URL: data:text/html,<title>Tab one</title><body>Body one</body> - Page URL: data:text/html,<title>Tab one</title><body>Body one</body>
- Page Title: Tab one - Page Title: Tab one
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Body one - generic [active] [ref=e1]: Body one
\`\`\``); \`\`\``);
expect(await createTab(client, 'Tab two', 'Body two')).toHaveTextContent(` expect(await createTab(client, 'Tab two', 'Body two')).toContainTextContent(`
- Ran Playwright code:
\`\`\`js
// <internal code to open a new tab>
\`\`\`
### Open tabs ### Open tabs
- 1: [] (about:blank) - 0: [] (about:blank)
- 2: [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>) - 1: [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)
- 3: (current) [Tab two] (data:text/html,<title>Tab two</title><body>Body two</body>) - 2: (current) [Tab two] (data:text/html,<title>Tab two</title><body>Body two</body>)
### Current tab ### Current tab
- Page URL: data:text/html,<title>Tab two</title><body>Body two</body> - Page URL: data:text/html,<title>Tab two</title><body>Body two</body>
- Page Title: Tab two - Page Title: Tab two
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Body two - generic [active] [ref=e1]: Body two
\`\`\``); \`\`\``);
}); });
@@ -88,25 +78,25 @@ test('select tab', async ({ client }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_tab_select', name: 'browser_tab_select',
arguments: { arguments: {
index: 2, index: 1,
}, },
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// <internal code to select tab 2> // <internal code to select tab 1>
\`\`\` \`\`\`
### Open tabs ### Open tabs
- 1: [] (about:blank) - 0: [] (about:blank)
- 2: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>) - 1: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)
- 3: [Tab two] (data:text/html,<title>Tab two</title><body>Body two</body>) - 2: [Tab two] (data:text/html,<title>Tab two</title><body>Body two</body>)
### Current tab ### Current tab
- Page URL: data:text/html,<title>Tab one</title><body>Body one</body> - Page URL: data:text/html,<title>Tab one</title><body>Body one</body>
- Page Title: Tab one - Page Title: Tab one
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Body one - generic [active] [ref=e1]: Body one
\`\`\``); \`\`\``);
}); });
@@ -116,24 +106,24 @@ test('close tab', async ({ client }) => {
expect(await client.callTool({ expect(await client.callTool({
name: 'browser_tab_close', name: 'browser_tab_close',
arguments: { arguments: {
index: 3, index: 2,
}, },
})).toHaveTextContent(` })).toHaveTextContent(`
- Ran Playwright code: ### Ran Playwright code
\`\`\`js \`\`\`js
// <internal code to close tab 3> // <internal code to close tab 2>
\`\`\` \`\`\`
### Open tabs ### Open tabs
- 1: [] (about:blank) - 0: [] (about:blank)
- 2: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>) - 1: (current) [Tab one] (data:text/html,<title>Tab one</title><body>Body one</body>)
### Current tab ### Current tab
- Page URL: data:text/html,<title>Tab one</title><body>Body one</body> - Page URL: data:text/html,<title>Tab one</title><body>Body one</body>
- Page Title: Tab one - Page Title: Tab one
- Page Snapshot - Page Snapshot:
\`\`\`yaml \`\`\`yaml
- generic [ref=e1]: Body one - generic [active] [ref=e1]: Body one
\`\`\``); \`\`\``);
}); });

View File

@@ -19,7 +19,7 @@ import path from 'path';
import { test, expect } from './fixtures.js'; import { test, expect } from './fixtures.js';
test('check that trace is saved', async ({ startClient, server }, testInfo) => { test('check that trace is saved', async ({ startClient, server, mcpMode }, testInfo) => {
const outputDir = testInfo.outputPath('output'); const outputDir = testInfo.outputPath('output');
const { client } = await startClient({ const { client } = await startClient({

View File

@@ -20,60 +20,20 @@ import fs from 'node:fs'
import path from 'node:path' import path from 'node:path'
import url from 'node:url' import url from 'node:url'
import zodToJsonSchema from 'zod-to-json-schema' import zodToJsonSchema from 'zod-to-json-schema'
import commonTools from '../lib/tools/common.js';
import consoleTools from '../lib/tools/console.js';
import dialogsTools from '../lib/tools/dialogs.js';
import filesTools from '../lib/tools/files.js';
import installTools from '../lib/tools/install.js';
import keyboardTools from '../lib/tools/keyboard.js';
import navigateTools from '../lib/tools/navigate.js';
import networkTools from '../lib/tools/network.js';
import pdfTools from '../lib/tools/pdf.js';
import snapshotTools from '../lib/tools/snapshot.js';
import tabsTools from '../lib/tools/tabs.js';
import screenshotTools from '../lib/tools/screenshot.js';
import testTools from '../lib/tools/testing.js';
import visionTools from '../lib/tools/vision.js';
import waitTools from '../lib/tools/wait.js';
import { execSync } from 'node:child_process'; import { execSync } from 'node:child_process';
const categories = { import { allTools } from '../lib/tools.js';
'Interactions': [
...snapshotTools, const capabilities = {
...keyboardTools(true), 'core': 'Core automation',
...waitTools(true), 'core-tabs': 'Tab management',
...filesTools(true), 'core-install': 'Browser installation',
...dialogsTools(true), 'vision': 'Coordinate-based (opt-in via --caps=vision)',
], 'pdf': 'PDF generation (opt-in via --caps=pdf)',
'Navigation': [
...navigateTools(true),
],
'Resources': [
...screenshotTools,
...pdfTools,
...networkTools,
...consoleTools,
],
'Utilities': [
...installTools,
...commonTools(true),
],
'Tabs': [
...tabsTools(true),
],
'Testing': [
...testTools,
],
'Vision mode': [
...visionTools,
...keyboardTools(),
...waitTools(false),
...filesTools(false),
...dialogsTools(false),
],
}; };
const toolsByCapability = Object.fromEntries(Object.entries(capabilities).map(([capability, title]) => [title, allTools.filter(tool => tool.capability === capability).sort((a, b) => a.schema.name.localeCompare(b.schema.name))]));
// NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename. // NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename.
const __filename = url.fileURLToPath(import.meta.url); const __filename = url.fileURLToPath(import.meta.url);
@@ -139,14 +99,12 @@ async function updateSection(content, startMarker, endMarker, generatedLines) {
async function updateTools(content) { async function updateTools(content) {
console.log('Loading tool information from compiled modules...'); console.log('Loading tool information from compiled modules...');
const totalTools = Object.values(categories).flat().length;
console.log(`Found ${totalTools} tools`);
const generatedLines = /** @type {string[]} */ ([]); const generatedLines = /** @type {string[]} */ ([]);
for (const [category, categoryTools] of Object.entries(categories)) { for (const [capability, tools] of Object.entries(toolsByCapability)) {
generatedLines.push(`<details>\n<summary><b>${category}</b></summary>`); console.log('Updating tools for capability:', capability);
generatedLines.push(`<details>\n<summary><b>${capability}</b></summary>`);
generatedLines.push(''); generatedLines.push('');
for (const tool of categoryTools) for (const tool of tools)
generatedLines.push(...formatToolForReadme(tool.schema)); generatedLines.push(...formatToolForReadme(tool.schema));
generatedLines.push(`</details>`); generatedLines.push(`</details>`);
generatedLines.push(''); generatedLines.push('');