Cloudflare Playwright MCP

Cloudflare Playwright MCP

Overview

This project leverages Playwright for automated browser testing and integrates with Cloudflare Workers, Browser Rendering and @cloudflare/playwright for deployment.

Build and Deploy

Follow these steps to set up and deploy the project:

1. Install dependencies:

npm ci

2. Build:

cd cloudflare
npm run build

3. Deploy to Cloudflare Workers:

cd cloudflare/example
npx wrangler deploy

Use with Cloudflare AI Playground

!alt text

Cloudflare playground AI is a great way to test MCP servers using LLM models available in Workers AI.

• Navigate to https://playground.ai.cloudflare.com/
• Ensure model is set to llama-3.3-70b-instruct-fp8-fast
• In MCP Servers, set URL to https://[my-mcp-url].workers.dev/sse
• Click Connect
• Status should update to Connected and it should list 14 available tools

You can now start to interact with the model, and it will run necessary tools to accomplish what was requested.

[!TIP] For best results, give simple instructions consisting of one single action, e. g., "Create a new todo entry", "Go to cloudflare site", "Take a screenshot"

Example of a conversation:

Use with Claude Desktop

As of now, Claude Desktop only supports local MCP servers. To use playground-mcp with Claude Desktop we make use of mcp-remote, a tool that proxies remote MCP servers and exposes them locally. Use the following configuration:

1. Open the configuration file for Claude Desktop.
2. Add the following JSON snippet under the mcpServers section:

{
  "mcpServers": {
    "cloudflare-playwright-mcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://[my-mcp-url].workers.dev/sse"
      ]
    }
  }
}

3. Save the configuration file and restart Claude Desktop to apply the changes.

This setup ensures that Claude Desktop can communicate with the Cloudflare Playwright MCP server.

Here's an example of a session opening the TODO demo app, adding "buy lemons" and doing a screenshot, taking advantage of playwright-mcp tools and Browser Rendering:

!alt text

Configure in VSCode

You can install the Playwright MCP server using the VS Code CLI:

# For VS Code
code --add-mcp '{"name":"cloudflare-playwright","type":"sse","url":"https://[my-mcp-url].workers.dev/sse"}'

# For VS Code Insiders
code-insiders --add-mcp '{"name":"cloudflare-playwright","type":"sse","url":"https://[my-mcp-url].workers.dev/sse"}'

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

Tool Modes

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

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.

Snapshot-based Interactions

• browser_snapshot

  • Description: Capture accessibility snapshot of the current page, this is better than screenshot
  • Parameters: None

• browser_click

  • Description: Perform click on a web 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

• browser_drag

  • Description: Perform drag and drop between two elements
  • Parameters:
    • startElement (string): Human-readable source element description used to obtain the permission to interact with the element
    • startRef (string): Exact source element reference from the page snapshot
    • endElement (string): Human-readable target element description used to obtain the permission to interact with the element
    • endRef (string): Exact target element reference from the page snapshot

• browser_hover

  • 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

• browser_type

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

• browser_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.

• browser_take_screenshot

  • Description: Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.
  • Parameters:
    • raw (boolean, optional): Whether to return without compression (in PNG format). Default is false, which returns a JPEG image.
    • element (string, optional): Human-readable element description used to obtain permission to screenshot the element. If not provided, the screenshot will be taken of viewport. If element is provided, ref must be provided too.
    • ref (string, optional): Exact target element reference from the page snapshot. If not provided, the screenshot will be taken of viewport. If ref is provided, element must be provided too.

Vision-based Interactions

• browser_screen_capture

  • Description: Take a screenshot of the current page
  • Parameters: None

• browser_screen_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

• browser_screen_click

  • Description: Click left mouse button
  • Parameters:
    • element (string): Human-readable element description used to obtain permission to interact with the element
    • x (number): X coordinate
    • y (number): Y coordinate

• browser_screen_drag

  • Description: Drag left mouse button
  • Parameters:
    • element (string): Human-readable element description used to obtain permission to interact with the element
    • startX (number): Start X coordinate
    • startY (number): Start Y coordinate
    • endX (number): End X coordinate
    • endY (number): End Y coordinate

• browser_screen_type

  • Description: Type text
  • Parameters:
    • text (string): Text to type into the element
    • submit (boolean, optional): Whether to submit entered text (press Enter after)

Tab Management

• browser_tab_list

  • Description: List browser tabs
  • Parameters: None

• browser_tab_new

  • Description: Open a new tab
  • Parameters:
    • url (string, optional): The URL to navigate to in the new tab. If not provided, the new tab will be blank.

• browser_tab_select

  • Description: Select a tab by index
  • Parameters:
    • index (number): The index of the tab to select

• browser_tab_close

  • Description: Close a tab
  • Parameters:
    • index (number, optional): The index of the tab to close. Closes current tab if not provided.

Navigation

• browser_navigate

  • Description: Navigate to a URL
  • Parameters:
    • url (string): The URL to navigate to

• browser_navigate_back

  • Description: Go back to the previous page
  • Parameters: None

• browser_navigate_forward

  • Description: Go forward to the next page
  • Parameters: None

Keyboard

• browser_press_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

Console

• browser_console_messages
  • Description: Returns all console messages
  • Parameters: None

Files and Media

• browser_file_upload

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

• browser_pdf_save

  • Description: Save page as PDF
  • Parameters: None

Utilities

• browser_close

  • Description: Close the page
  • Parameters: None

• browser_wait

  • Description: Wait for a specified time in seconds
  • Parameters:
    • time (number): The time to wait in seconds

• browser_resize

  • Description: Resize the browser window
  • Parameters:
    • width (number): Width of the browser window
    • height (number): Height of the browser window

• browser_handle_dialog

  • Description: Handle a dialog
  • Parameters:
    • accept (boolean): Whether to accept the dialog.
    • promptText (string, optional): The text of the prompt in case of a prompt dialog.

Shared threads will appear here, showcasing real-world applications and insights from the community. Check back soon for updates!