@playwright/mcp 0.0.20 → 0.0.24

package/README.md

@@ -76,7 +76,10 @@ The Playwright MCP server supports the following command-line options:
 - `--user-data-dir <path>`: Path to the user data directory
 - `--port <port>`: Port to listen on for SSE transport
 - `--host <host>`: Host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.
+- `--allowed-origins <origins>`: Semicolon-separated list of origins to allow the browser to request. Default is to allow all. Origins matching both `--allowed-origins` and `--blocked-origins` will be blocked.
+- `--blocked-origins <origins>`: Semicolon-separated list of origins to block the browser to request. Origins matching both `--allowed-origins` and `--blocked-origins` will be blocked.
 - `--vision`: Run server that uses screenshots (Aria snapshots are used by default)
+- `--output-dir`: Directory for output files
 - `--config <path>`: Path to the configuration file
 
 ### User profile
@@ -152,13 +155,19 @@ The Playwright MCP server can be configured using a JSON configuration file. Her
   // Directory for output files
   outputDir?: string;
 
-  // Tool-specific configurations
-  tools?: {
-    browser_take_screenshot?: {
-      // Disable base64-encoded image responses
-      omitBase64?: boolean;
-    }
-  }
+  // Network configuration
+  network?: {
+    // List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
+    allowedOrigins?: string[];
+
+    // List of origins to block the browser to request. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
+    blockedOrigins?: string[];
+  };
+ 
+  /**
+   * Do not send image responses to the client.
+   */
+  noImageResponses?: boolean;
 }
 ```
 
@@ -198,7 +207,7 @@ And then in MCP client config, set the `url` to the SSE endpoint:
   "mcpServers": {
     "playwright": {
       "command": "docker",
-      "args": ["run", "-i", "--rm", "--init", "mcp/playwright"]
+      "args": ["run", "-i", "--rm", "--init", "--pull=always", "mcr.microsoft.com/playwright/mcp"]
     }
   }
 }
@@ -207,7 +216,7 @@ And then in MCP client config, set the `url` to the SSE endpoint:
 You can build the Docker image yourself.
 
 ```
-docker build -t mcp/playwright .
+docker build -t mcr.microsoft.com/playwright/mcp .
 ```
 
 ### Programmatic usage
@@ -215,16 +224,16 @@ docker build -t mcp/playwright .
 ```js
 import http from 'http';
 
-import { createServer } from '@playwright/mcp';
+import { createConnection } from '@playwright/mcp';
 import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
 
 http.createServer(async (req, res) => {
   // ...
 
   // Creates a headless Playwright MCP server with SSE transport
-  const mcpServer = await createServer({ headless: true });
+  const connection = await createConnection({ browser: { launchOptions: { headless: true } } });
   const transport = new SSEServerTransport('/messages', res);
-  await mcpServer.connect(transport);
+  await connection.connect(transport);
 
   // ...
 });
@@ -264,38 +273,47 @@ X Y coordinate space, based on the provided screenshot.
 <!-- 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 -->
 
 - **browser_click**
+  - Title: 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
+  - Read-only: **false**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_drag**
+  - Title: Drag mouse
   - 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
+  - Read-only: **false**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_hover**
+  - 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 -->
 
 - **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
@@ -303,54 +321,67 @@ X Y coordinate space, based on the provided screenshot.
     - `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**
 
 <!-- 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_take_screenshot**
+  - Title: Take a 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.
+    - `filename` (string, optional): File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified.
     - `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.
+  - Read-only: **true**
 
 ### Vision-based Interactions
 
 <!-- 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
+  - Read-only: **true**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_screen_move_mouse**
+  - 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
   - 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
+  - Read-only: **false**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_screen_drag**
+  - Title: Drag mouse
   - Description: Drag left mouse button
   - Parameters:
     - `element` (string): Human-readable element description used to obtain permission to interact with the element
@@ -358,143 +389,191 @@ X Y coordinate space, based on the provided screenshot.
     - `startY` (number): Start Y coordinate
     - `endX` (number): End X coordinate
     - `endY` (number): End Y coordinate
+  - Read-only: **false**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_screen_type**
+  - Title: Type text
   - Description: Type text
   - Parameters:
     - `text` (string): Text to type into the element
     - `submit` (boolean, optional): Whether to submit entered text (press Enter after)
+  - Read-only: **false**
 
 ### Tab Management
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_tab_list**
+  - Title: List tabs
   - Description: List browser tabs
   - Parameters: None
+  - Read-only: **true**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_tab_new**
+  - Title: Open a new tab
   - 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.
+  - Read-only: **true**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_tab_select**
+  - Title: Select a tab
   - Description: Select a tab by index
   - Parameters:
     - `index` (number): The index of the tab to select
+  - 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**
 
 ### Navigation
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_navigate**
+  - Title: Navigate to a URL
   - Description: Navigate to a URL
   - Parameters:
     - `url` (string): The URL to navigate to
+  - Read-only: **false**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_navigate_back**
+  - Title: Go back
   - Description: Go back to the previous page
   - Parameters: None
+  - Read-only: **true**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_navigate_forward**
+  - Title: Go forward
   - Description: Go forward to the next page
   - Parameters: None
+  - Read-only: **true**
 
 ### Keyboard
 
 <!-- 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**
 
 ### Console
 
 <!-- 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**
 
 ### Files and Media
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_file_upload**
+  - Title: Upload files
   - 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 -->
 
 - **browser_pdf_save**
+  - Title: Save as PDF
   - Description: Save page as PDF
-  - Parameters: None
+  - Parameters:
+    - `filename` (string, optional): File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.
+  - Read-only: **true**
 
 ### Utilities
 
 <!-- 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_wait**
-  - Description: Wait for a specified time in seconds
+- **browser_wait_for**
+  - Title: Wait for
+  - Description: Wait for text to appear or disappear or a specified time to pass
   - Parameters:
-    - `time` (number): The time to wait in seconds
+    - `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_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_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**
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_handle_dialog**
+  - Title: Handle a 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.
+  - Read-only: **false**
+
+<!-- NOTE: This has been generated via update-readme.js -->
+
+- **browser_network_requests**
+  - Title: List network requests
+  - Description: Returns all network requests since loading the page
+  - Parameters: None
+  - Read-only: **true**
 
 ### Testing
 
 <!-- NOTE: This has been generated via update-readme.js -->
 
 - **browser_generate_playwright_test**
+  - Title: Generate a Playwright test
   - Description: Generate a Playwright test for given scenario
   - 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**
 
 <!--- End of generated section -->

package/config.d.ts

@@ -40,7 +40,7 @@ export type Config = {
      *
      * This is useful for settings options like `channel`, `headless`, `executablePath`, etc.
      */
-    launchOptions?: playwright.BrowserLaunchOptions;
+    launchOptions?: playwright.LaunchOptions;
 
     /**
      * Context options for the browser context.
@@ -94,20 +94,20 @@ export type Config = {
    */
   outputDir?: string;
 
-  /**
-   * Configuration for specific tools.
-   */
-  tools?: {
+  network?: {
+    /**
+     * List of origins to allow the browser to request. Default is to allow all. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
+     */
+    allowedOrigins?: string[];
+
     /**
-     * Configuration for the browser_take_screenshot tool.
+     * List of origins to block the browser to request. Origins matching both `allowedOrigins` and `blockedOrigins` will be blocked.
      */
-    browser_take_screenshot?: {
-
-      /**
-       * Whether to disable base64-encoded image responses to the clients that
-       * don't support binary data or prefer to save on tokens.
-      */
-      omitBase64?: boolean;
-    }
-  }
+    blockedOrigins?: string[];
+  };
+
+  /**
+   * Do not send image responses to the client.
+   */
+  noImageResponses?: boolean;
 };

package/index.d.ts

@@ -16,8 +16,14 @@
  */
 
 import type { Server } from '@modelcontextprotocol/sdk/server/index.js';
-
 import type { Config } from './config';
+import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
+
+export type Connection = {
+  server: Server;
+  connect(transport: Transport): Promise<void>;
+  close(): Promise<void>;
+};
 
-export declare function createServer(config?: Config): Promise<Server>;
+export declare function createConnection(config?: Config): Promise<Connection>;
 export {};

package/index.js

@@ -15,5 +15,5 @@
  * limitations under the License.
  */
 
-import { createServer } from './lib/index';
-export default { createServer };
+import { createConnection } from './lib/index';
+export { createConnection };

package/lib/config.js

@@ -22,7 +22,6 @@ import { sanitizeForFilePath } from './tools/utils.js';
 const defaultConfig = {
     browser: {
         browserName: 'chromium',
-        userDataDir: os.tmpdir(),
         launchOptions: {
             channel: 'chrome',
             headless: os.platform() === 'linux' && !process.env.DISPLAY,
@@ -31,6 +30,10 @@ const defaultConfig = {
             viewport: null,
         },
     },
+    network: {
+        allowedOrigins: undefined,
+        blockedOrigins: undefined,
+    },
 };
 export async function resolveConfig(cliOptions) {
     const config = await loadConfig(cliOptions.config);
@@ -69,12 +72,12 @@ export async function configFromCLIOptions(cliOptions) {
         headless: cliOptions.headless,
     };
     if (browserName === 'chromium')
-        launchOptions.webSocketPort = await findFreePort();
+        launchOptions.cdpPort = await findFreePort();
     const contextOptions = cliOptions.device ? devices[cliOptions.device] : undefined;
     return {
         browser: {
             browserName,
-            userDataDir: cliOptions.userDataDir ?? await createUserDataDir({ browserName, channel }),
+            userDataDir: cliOptions.userDataDir,
             launchOptions,
             contextOptions,
             cdpEndpoint: cliOptions.cdpEndpoint,
@@ -85,6 +88,11 @@ export async function configFromCLIOptions(cliOptions) {
         },
         capabilities: cliOptions.caps?.split(',').map((c) => c.trim()),
         vision: !!cliOptions.vision,
+        network: {
+            allowedOrigins: cliOptions.allowedOrigins,
+            blockedOrigins: cliOptions.blockedOrigins,
+        },
+        outputDir: cliOptions.outputDir,
     };
 }
 async function findFreePort() {
@@ -107,20 +115,6 @@ async function loadConfig(configFile) {
         throw new Error(`Failed to load config file: ${configFile}, ${error}`);
     }
 }
-async function createUserDataDir(options) {
-    let cacheDirectory;
-    if (process.platform === 'linux')
-        cacheDirectory = process.env.XDG_CACHE_HOME || path.join(os.homedir(), '.cache');
-    else if (process.platform === 'darwin')
-        cacheDirectory = path.join(os.homedir(), 'Library', 'Caches');
-    else if (process.platform === 'win32')
-        cacheDirectory = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
-    else
-        throw new Error('Unsupported platform: ' + process.platform);
-    const result = path.join(cacheDirectory, 'ms-playwright', `mcp-${options.channel ?? options.browserName}-profile`);
-    await fs.promises.mkdir(result, { recursive: true });
-    return result;
-}
 export async function outputFile(config, name) {
     const result = config.outputDir ?? os.tmpdir();
     await fs.promises.mkdir(result, { recursive: true });
@@ -144,11 +138,15 @@ function mergeConfig(base, overrides) {
             ...pickDefined(overrides.browser?.contextOptions),
         },
     };
-    if (browser.browserName !== 'chromium')
+    if (browser.browserName !== 'chromium' && browser.launchOptions)
         delete browser.launchOptions.channel;
     return {
         ...pickDefined(base),
         ...pickDefined(overrides),
         browser,
+        network: {
+            ...pickDefined(base.network),
+            ...pickDefined(overrides.network),
+        },
     };
 }

package/lib/{server.js → connection.js}

@@ -16,11 +16,13 @@
 import { Server } from '@modelcontextprotocol/sdk/server/index.js';
 import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
 import { zodToJsonSchema } from 'zod-to-json-schema';
-import { Context } from './context.js';
-export function createServerWithTools(serverOptions, config) {
-    const { name, version, tools } = serverOptions;
+import { Context, packageJSON } from './context.js';
+import { snapshotTools, screenshotTools } from './tools.js';
+export async function createConnection(config) {
+    const allTools = config.vision ? screenshotTools : snapshotTools;
+    const tools = allTools.filter(tool => !config.capabilities || tool.capability === 'core' || config.capabilities.includes(tool.capability));
     const context = new Context(tools, config);
-    const server = new Server({ name, version }, {
+    const server = new Server({ name: 'Playwright', version: packageJSON.version }, {
         capabilities: {
             tools: {},
         }
@@ -30,7 +32,13 @@ export function createServerWithTools(serverOptions, config) {
             tools: tools.map(tool => ({
                 name: tool.schema.name,
                 description: tool.schema.description,
-                inputSchema: zodToJsonSchema(tool.schema.inputSchema)
+                inputSchema: zodToJsonSchema(tool.schema.inputSchema),
+                annotations: {
+                    title: tool.schema.title,
+                    readOnlyHint: tool.schema.type === 'readOnly',
+                    destructiveHint: tool.schema.type === 'destructive',
+                    openWorldHint: true,
+                },
             })),
         };
     });
@@ -54,31 +62,26 @@ export function createServerWithTools(serverOptions, config) {
             return errorResult(String(error));
         }
     });
-    const oldClose = server.close.bind(server);
-    server.close = async () => {
-        await oldClose();
-        await context.close();
-    };
-    return server;
+    const connection = new Connection(server, context);
+    return connection;
 }
-export class ServerList {
-    _servers = [];
-    _serverFactory;
-    constructor(serverFactory) {
-        this._serverFactory = serverFactory;
+export class Connection {
+    server;
+    context;
+    constructor(server, context) {
+        this.server = server;
+        this.context = context;
     }
-    async create() {
-        const server = await this._serverFactory();
-        this._servers.push(server);
-        return server;
-    }
-    async close(server) {
-        const index = this._servers.indexOf(server);
-        if (index !== -1)
-            this._servers.splice(index, 1);
-        await server.close();
+    async connect(transport) {
+        await this.server.connect(transport);
+        await new Promise(resolve => {
+            this.server.oninitialized = () => resolve();
+        });
+        if (this.server.getClientVersion()?.name.includes('cursor'))
+            this.context.config.noImageResponses = true;
     }
-    async closeAll() {
-        await Promise.all(this._servers.map(server => server.close()));
+    async close() {
+        await this.server.close();
+        await this.context.close();
     }
 }