@playwright/mcp 0.0.36-alpha-2025-09-03 → 0.0.36-alpha-2025-09-04

package/lib/{tools → browser/tools}/install.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,30 +14,33 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { fork } from 'child_process';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { z } from 'zod';
-import { defineTool } from './tool.js';
-const install = defineTool({
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const path_1 = __importDefault(require("path"));
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const install = (0, tool_1.defineTool)({
     capability: 'core-install',
     schema: {
         name: '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.',
-        inputSchema: z.object({}),
+        inputSchema: bundle_1.z.object({}),
         type: 'destructive',
     },
     handle: async (context, params, response) => {
-        const channel = context.config.browser?.launchOptions?.channel ?? context.config.browser?.browserName ?? 'chrome';
-        const cliUrl = import.meta.resolve('playwright/package.json');
-        const cliPath = path.join(fileURLToPath(cliUrl), '..', 'cli.js');
-        const child = fork(cliPath, ['install', channel], {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const channel = (_e = (_c = (_b = (_a = context.config.browser) === null || _a === void 0 ? void 0 : _a.launchOptions) === null || _b === void 0 ? void 0 : _b.channel) !== null && _c !== void 0 ? _c : (_d = context.config.browser) === null || _d === void 0 ? void 0 : _d.browserName) !== null && _e !== void 0 ? _e : 'chrome';
+        const cliPath = path_1.default.join(require.resolve('playwright/package.json'), '../cli.js');
+        const child = (0, child_process_1.fork)(cliPath, ['install', channel], {
             stdio: 'pipe',
         });
         const output = [];
-        child.stdout?.on('data', data => output.push(data.toString()));
-        child.stderr?.on('data', data => output.push(data.toString()));
+        (_f = child.stdout) === null || _f === void 0 ? void 0 : _f.on('data', data => output.push(data.toString()));
+        (_g = child.stderr) === null || _g === void 0 ? void 0 : _g.on('data', data => output.push(data.toString()));
         await new Promise((resolve, reject) => {
             child.on('close', code => {
                 if (code === 0)
@@ -48,6 +52,6 @@ const install = defineTool({
         response.setIncludeTabs();
     },
 });
-export default [
+exports.default = [
     install,
 ];

package/lib/browser/tools/keyboard.js

@@ -0,0 +1,113 @@
+"use strict";
+/**
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const snapshot_1 = require("./snapshot");
+const utils_1 = require("./utils");
+const javascript = __importStar(require("../codegen"));
+const pressKey = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_press_key',
+        title: 'Press a key',
+        description: 'Press a key on the keyboard',
+        inputSchema: bundle_1.z.object({
+            key: bundle_1.z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (tab, params, response) => {
+        response.setIncludeSnapshot();
+        response.addCode(`// Press ${params.key}`);
+        response.addCode(`await page.keyboard.press('${params.key}');`);
+        await tab.waitForCompletion(async () => {
+            await tab.page.keyboard.press(params.key);
+        });
+    },
+});
+const typeSchema = snapshot_1.elementSchema.extend({
+    text: bundle_1.z.string().describe('Text to type into the element'),
+    submit: bundle_1.z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
+    slowly: bundle_1.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 = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_type',
+        title: 'Type text',
+        description: 'Type text into editable element',
+        inputSchema: typeSchema,
+        type: 'destructive',
+    },
+    handle: async (tab, params, response) => {
+        const locator = await tab.refLocator(params);
+        await tab.waitForCompletion(async () => {
+            if (params.slowly) {
+                response.setIncludeSnapshot();
+                response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.pressSequentially(${javascript.quote(params.text)});`);
+                await locator.pressSequentially(params.text);
+            }
+            else {
+                response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.fill(${javascript.quote(params.text)});`);
+                await locator.fill(params.text);
+            }
+            if (params.submit) {
+                response.setIncludeSnapshot();
+                response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.press('Enter');`);
+                await locator.press('Enter');
+            }
+        });
+    },
+});
+exports.default = [
+    pressKey,
+    type,
+];

package/lib/{tools → browser/tools}/mouse.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,20 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTabTool } from './tool.js';
-const elementSchema = z.object({
-    element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const elementSchema = bundle_1.z.object({
+    element: bundle_1.z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
 });
-const mouseMove = defineTabTool({
+const mouseMove = (0, tool_1.defineTabTool)({
     capability: 'vision',
     schema: {
         name: 'browser_mouse_move_xy',
         title: 'Move mouse',
         description: 'Move mouse to a given position',
         inputSchema: elementSchema.extend({
-            x: z.number().describe('X coordinate'),
-            y: z.number().describe('Y coordinate'),
+            x: bundle_1.z.number().describe('X coordinate'),
+            y: bundle_1.z.number().describe('Y coordinate'),
         }),
         type: 'readOnly',
     },
@@ -38,15 +40,15 @@ const mouseMove = defineTabTool({
         });
     },
 });
-const mouseClick = defineTabTool({
+const mouseClick = (0, tool_1.defineTabTool)({
     capability: 'vision',
     schema: {
         name: 'browser_mouse_click_xy',
         title: 'Click',
         description: 'Click left mouse button at a given position',
         inputSchema: elementSchema.extend({
-            x: z.number().describe('X coordinate'),
-            y: z.number().describe('Y coordinate'),
+            x: bundle_1.z.number().describe('X coordinate'),
+            y: bundle_1.z.number().describe('Y coordinate'),
         }),
         type: 'destructive',
     },
@@ -63,17 +65,17 @@ const mouseClick = defineTabTool({
         });
     },
 });
-const mouseDrag = defineTabTool({
+const mouseDrag = (0, tool_1.defineTabTool)({
     capability: 'vision',
     schema: {
         name: 'browser_mouse_drag_xy',
         title: 'Drag mouse',
         description: 'Drag left mouse button to a given position',
         inputSchema: elementSchema.extend({
-            startX: z.number().describe('Start X coordinate'),
-            startY: z.number().describe('Start Y coordinate'),
-            endX: z.number().describe('End X coordinate'),
-            endY: z.number().describe('End Y coordinate'),
+            startX: bundle_1.z.number().describe('Start X coordinate'),
+            startY: bundle_1.z.number().describe('Start Y coordinate'),
+            endX: bundle_1.z.number().describe('End X coordinate'),
+            endY: bundle_1.z.number().describe('End Y coordinate'),
         }),
         type: 'destructive',
     },
@@ -92,7 +94,7 @@ const mouseDrag = defineTabTool({
         });
     },
 });
-export default [
+exports.default = [
     mouseMove,
     mouseClick,
     mouseDrag,

package/lib/{tools → browser/tools}/navigate.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,16 +14,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTool, defineTabTool } from './tool.js';
-const navigate = defineTool({
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const navigate = (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_navigate',
         title: 'Navigate to a URL',
         description: 'Navigate to a URL',
-        inputSchema: z.object({
-            url: z.string().describe('The URL to navigate to'),
+        inputSchema: bundle_1.z.object({
+            url: bundle_1.z.string().describe('The URL to navigate to'),
         }),
         type: 'destructive',
     },
@@ -33,13 +35,13 @@ const navigate = defineTool({
         response.addCode(`await page.goto('${params.url}');`);
     },
 });
-const goBack = defineTabTool({
+const goBack = (0, tool_1.defineTabTool)({
     capability: 'core',
     schema: {
         name: 'browser_navigate_back',
         title: 'Go back',
         description: 'Go back to the previous page',
-        inputSchema: z.object({}),
+        inputSchema: bundle_1.z.object({}),
         type: 'readOnly',
     },
     handle: async (tab, params, response) => {
@@ -48,7 +50,7 @@ const goBack = defineTabTool({
         response.addCode(`await page.goBack();`);
     },
 });
-export default [
+exports.default = [
     navigate,
     goBack,
 ];

package/lib/{tools → browser/tools}/network.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,15 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTabTool } from './tool.js';
-const requests = defineTabTool({
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const requests = (0, tool_1.defineTabTool)({
     capability: 'core',
     schema: {
         name: 'browser_network_requests',
         title: 'List network requests',
         description: 'Returns all network requests since loading the page',
-        inputSchema: z.object({}),
+        inputSchema: bundle_1.z.object({}),
         type: 'readOnly',
     },
     handle: async (tab, params, response) => {
@@ -36,6 +38,6 @@ function renderRequest(request, response) {
         result.push(`=> [${response.status()}] ${response.statusText()}`);
     return result.join(' ');
 }
-export default [
+exports.default = [
     requests,
 ];

package/lib/browser/tools/pdf.js

@@ -0,0 +1,76 @@
+"use strict";
+/**
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const javascript = __importStar(require("../codegen"));
+const pdfSchema = bundle_1.z.object({
+    filename: bundle_1.z.string().optional().describe('File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.'),
+});
+const pdf = (0, tool_1.defineTabTool)({
+    capability: 'pdf',
+    schema: {
+        name: 'browser_pdf_save',
+        title: 'Save as PDF',
+        description: 'Save page as PDF',
+        inputSchema: pdfSchema,
+        type: 'readOnly',
+    },
+    handle: async (tab, params, response) => {
+        var _a;
+        const fileName = await tab.context.outputFile((_a = params.filename) !== null && _a !== void 0 ? _a : `page-${new Date().toISOString()}.pdf`);
+        response.addCode(`await page.pdf(${javascript.formatObject({ path: fileName })});`);
+        response.addResult(`Saved page as ${fileName}`);
+        await tab.page.pdf({ path: fileName });
+    },
+});
+exports.default = [
+    pdf,
+];

package/lib/browser/tools/screenshot.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const javascript = __importStar(require("../codegen"));
+const utils_1 = require("./utils");
+const screenshotSchema = bundle_1.z.object({
+    type: bundle_1.z.enum(['png', 'jpeg']).default('png').describe('Image format for the screenshot. Default is png.'),
+    filename: bundle_1.z.string().optional().describe('File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified.'),
+    element: bundle_1.z.string().optional().describe('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: bundle_1.z.string().optional().describe('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.'),
+    fullPage: bundle_1.z.boolean().optional().describe('When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Cannot be used with element screenshots.'),
+}).refine(data => {
+    return !!data.element === !!data.ref;
+}, {
+    message: 'Both element and ref must be provided or neither.',
+    path: ['ref', 'element']
+}).refine(data => {
+    return !(data.fullPage && (data.element || data.ref));
+}, {
+    message: 'fullPage cannot be used with element screenshots.',
+    path: ['fullPage']
+});
+const screenshot = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: '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.`,
+        inputSchema: screenshotSchema,
+        type: 'readOnly',
+    },
+    handle: async (tab, params, response) => {
+        var _a;
+        const fileType = params.type || 'png';
+        const fileName = await tab.context.outputFile((_a = params.filename) !== null && _a !== void 0 ? _a : `page-${new Date().toISOString()}.${fileType}`);
+        const options = {
+            type: fileType,
+            quality: fileType === 'png' ? undefined : 90,
+            scale: 'css',
+            path: fileName,
+            ...(params.fullPage !== undefined && { fullPage: params.fullPage })
+        };
+        const isElementScreenshot = params.element && params.ref;
+        const screenshotTarget = isElementScreenshot ? params.element : (params.fullPage ? 'full page' : 'viewport');
+        response.addCode(`// Screenshot ${screenshotTarget} and save it as ${fileName}`);
+        // Only get snapshot when element screenshot is needed
+        const locator = params.ref ? await tab.refLocator({ element: params.element || '', ref: params.ref }) : null;
+        if (locator)
+            response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.screenshot(${javascript.formatObject(options)});`);
+        else
+            response.addCode(`await page.screenshot(${javascript.formatObject(options)});`);
+        const buffer = locator ? await locator.screenshot(options) : await tab.page.screenshot(options);
+        response.addResult(`Took the ${screenshotTarget} screenshot and saved it as ${fileName}`);
+        // https://github.com/microsoft/playwright-mcp/issues/817
+        // Never return large images to LLM, saving them to the file system is enough.
+        if (!params.fullPage) {
+            response.addImage({
+                contentType: fileType === 'png' ? 'image/png' : 'image/jpeg',
+                data: buffer
+            });
+        }
+    }
+});
+exports.default = [
+    screenshot,
+];