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

package/lib/browser/tools/snapshot.js

@@ -0,0 +1,175 @@
+"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 });
+exports.elementSchema = void 0;
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const javascript = __importStar(require("../codegen"));
+const utils_1 = require("./utils");
+const snapshot = (0, tool_1.defineTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_snapshot',
+        title: 'Page snapshot',
+        description: 'Capture accessibility snapshot of the current page, this is better than screenshot',
+        inputSchema: bundle_1.z.object({}),
+        type: 'readOnly',
+    },
+    handle: async (context, params, response) => {
+        await context.ensureTab();
+        response.setIncludeSnapshot();
+    },
+});
+exports.elementSchema = bundle_1.z.object({
+    element: bundle_1.z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
+    ref: bundle_1.z.string().describe('Exact target element reference from the page snapshot'),
+});
+const clickSchema = exports.elementSchema.extend({
+    doubleClick: bundle_1.z.boolean().optional().describe('Whether to perform a double click instead of a single click'),
+    button: bundle_1.z.enum(['left', 'right', 'middle']).optional().describe('Button to click, defaults to left'),
+});
+const click = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_click',
+        title: 'Click',
+        description: 'Perform click on a web page',
+        inputSchema: clickSchema,
+        type: 'destructive',
+    },
+    handle: async (tab, params, response) => {
+        response.setIncludeSnapshot();
+        const locator = await tab.refLocator(params);
+        const button = params.button;
+        const buttonAttr = button ? `{ button: '${button}' }` : '';
+        if (params.doubleClick)
+            response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.dblclick(${buttonAttr});`);
+        else
+            response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.click(${buttonAttr});`);
+        await tab.waitForCompletion(async () => {
+            if (params.doubleClick)
+                await locator.dblclick({ button });
+            else
+                await locator.click({ button });
+        });
+    },
+});
+const drag = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_drag',
+        title: 'Drag mouse',
+        description: 'Perform drag and drop between two elements',
+        inputSchema: bundle_1.z.object({
+            startElement: bundle_1.z.string().describe('Human-readable source element description used to obtain the permission to interact with the element'),
+            startRef: bundle_1.z.string().describe('Exact source element reference from the page snapshot'),
+            endElement: bundle_1.z.string().describe('Human-readable target element description used to obtain the permission to interact with the element'),
+            endRef: bundle_1.z.string().describe('Exact target element reference from the page snapshot'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (tab, params, response) => {
+        response.setIncludeSnapshot();
+        const [startLocator, endLocator] = await tab.refLocators([
+            { ref: params.startRef, element: params.startElement },
+            { ref: params.endRef, element: params.endElement },
+        ]);
+        await tab.waitForCompletion(async () => {
+            await startLocator.dragTo(endLocator);
+        });
+        response.addCode(`await page.${await (0, utils_1.generateLocator)(startLocator)}.dragTo(page.${await (0, utils_1.generateLocator)(endLocator)});`);
+    },
+});
+const hover = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_hover',
+        title: 'Hover mouse',
+        description: 'Hover over element on page',
+        inputSchema: exports.elementSchema,
+        type: 'readOnly',
+    },
+    handle: async (tab, params, response) => {
+        response.setIncludeSnapshot();
+        const locator = await tab.refLocator(params);
+        response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.hover();`);
+        await tab.waitForCompletion(async () => {
+            await locator.hover();
+        });
+    },
+});
+const selectOptionSchema = exports.elementSchema.extend({
+    values: bundle_1.z.array(bundle_1.z.string()).describe('Array of values to select in the dropdown. This can be a single value or multiple values.'),
+});
+const selectOption = (0, tool_1.defineTabTool)({
+    capability: 'core',
+    schema: {
+        name: 'browser_select_option',
+        title: 'Select option',
+        description: 'Select an option in a dropdown',
+        inputSchema: selectOptionSchema,
+        type: 'destructive',
+    },
+    handle: async (tab, params, response) => {
+        response.setIncludeSnapshot();
+        const locator = await tab.refLocator(params);
+        response.addCode(`await page.${await (0, utils_1.generateLocator)(locator)}.selectOption(${javascript.formatObject(params.values)});`);
+        await tab.waitForCompletion(async () => {
+            await locator.selectOption(params.values);
+        });
+    },
+});
+exports.default = [
+    snapshot,
+    click,
+    drag,
+    hover,
+    selectOption,
+];

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

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,17 +14,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTool } from './tool.js';
-const browserTabs = defineTool({
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const browserTabs = (0, tool_1.defineTool)({
     capability: 'core-tabs',
     schema: {
         name: 'browser_tabs',
         title: 'Manage tabs',
         description: 'List, create, close, or select a browser tab.',
-        inputSchema: z.object({
-            action: z.enum(['list', 'new', 'close', 'select']).describe('Operation to perform'),
-            index: z.number().optional().describe('Tab index, used for close/select. If omitted for close, current tab is closed.'),
+        inputSchema: bundle_1.z.object({
+            action: bundle_1.z.enum(['list', 'new', 'close', 'select']).describe('Operation to perform'),
+            index: bundle_1.z.number().optional().describe('Tab index, used for close/select. If omitted for close, current tab is closed.'),
         }),
         type: 'destructive',
     },
@@ -54,6 +56,6 @@ const browserTabs = defineTool({
         }
     },
 });
-export default [
+exports.default = [
     browserTabs,
 ];

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

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,10 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export function defineTool(tool) {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineTool = defineTool;
+exports.defineTabTool = defineTabTool;
+function defineTool(tool) {
     return tool;
 }
-export function defineTabTool(tool) {
+function defineTabTool(tool) {
     return {
         ...tool,
         handle: async (context, params, response) => {

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

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,9 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForCompletion = waitForCompletion;
+exports.generateLocator = generateLocator;
+exports.callOnPageNoTrace = callOnPageNoTrace;
 // @ts-ignore
-import { asLocator } from 'playwright-core/lib/utils';
-export async function waitForCompletion(tab, callback) {
+const utils_1 = require("playwright-core/lib/utils");
+async function waitForCompletion(tab, callback) {
     const requests = new Set();
     let frameNavigated = false;
     let waitCallback = () => { };
@@ -60,15 +65,15 @@ export async function waitForCompletion(tab, callback) {
         dispose();
     }
 }
-export async function generateLocator(locator) {
+async function generateLocator(locator) {
     try {
         const { resolvedSelector } = await locator._resolveSelector();
-        return asLocator('javascript', resolvedSelector);
+        return (0, utils_1.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(page, callback) {
+async function callOnPageNoTrace(page, callback) {
     return await page._wrapApiCall(() => callback(page), { internal: true });
 }

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

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,19 +14,53 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTabTool } from './tool.js';
-import * as javascript from '../utils/codegen.js';
-import { generateLocator } from './utils.js';
-const verifyElement = defineTabTool({
+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 verifyElement = (0, tool_1.defineTabTool)({
     capability: 'verify',
     schema: {
         name: 'browser_verify_element_visible',
         title: 'Verify element visible',
         description: 'Verify element is visible on the page',
-        inputSchema: z.object({
-            role: z.string().describe('ROLE of the element. Can be found in the snapshot like this: \`- {ROLE} "Accessible Name":\`'),
-            accessibleName: z.string().describe('ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: \`- role "{ACCESSIBLE_NAME}"\`'),
+        inputSchema: bundle_1.z.object({
+            role: bundle_1.z.string().describe('ROLE of the element. Can be found in the snapshot like this: \`- {ROLE} "Accessible Name":\`'),
+            accessibleName: bundle_1.z.string().describe('ACCESSIBLE_NAME of the element. Can be found in the snapshot like this: \`- role "{ACCESSIBLE_NAME}"\`'),
         }),
         type: 'readOnly',
     },
@@ -39,14 +74,14 @@ const verifyElement = defineTabTool({
         response.addResult('Done');
     },
 });
-const verifyText = defineTabTool({
+const verifyText = (0, tool_1.defineTabTool)({
     capability: 'verify',
     schema: {
         name: 'browser_verify_text_visible',
         title: 'Verify text visible',
         description: `Verify text is visible on the page. Prefer ${verifyElement.schema.name} if possible.`,
-        inputSchema: z.object({
-            text: z.string().describe('TEXT to verify. Can be found in the snapshot like this: \`- role "Accessible Name": {TEXT}\` or like this: \`- text: {TEXT}\`'),
+        inputSchema: bundle_1.z.object({
+            text: bundle_1.z.string().describe('TEXT to verify. Can be found in the snapshot like this: \`- role "Accessible Name": {TEXT}\` or like this: \`- text: {TEXT}\`'),
         }),
         type: 'readOnly',
     },
@@ -60,16 +95,16 @@ const verifyText = defineTabTool({
         response.addResult('Done');
     },
 });
-const verifyList = defineTabTool({
+const verifyList = (0, tool_1.defineTabTool)({
     capability: 'verify',
     schema: {
         name: 'browser_verify_list_visible',
         title: 'Verify list visible',
         description: 'Verify list is visible on the page',
-        inputSchema: z.object({
-            element: z.string().describe('Human-readable list description'),
-            ref: z.string().describe('Exact target element reference that points to the list'),
-            items: z.array(z.string()).describe('Items to verify'),
+        inputSchema: bundle_1.z.object({
+            element: bundle_1.z.string().describe('Human-readable list description'),
+            ref: bundle_1.z.string().describe('Exact target element reference that points to the list'),
+            items: bundle_1.z.array(bundle_1.z.string()).describe('Items to verify'),
         }),
         type: 'readOnly',
     },
@@ -92,23 +127,23 @@ ${itemTexts.map(t => `  - listitem: ${javascript.escapeWithQuotes(t, '"')}`).joi
         response.addResult('Done');
     },
 });
-const verifyValue = defineTabTool({
+const verifyValue = (0, tool_1.defineTabTool)({
     capability: 'verify',
     schema: {
         name: 'browser_verify_value',
         title: 'Verify value',
         description: 'Verify element value',
-        inputSchema: z.object({
-            type: z.enum(['textbox', 'checkbox', 'radio', 'combobox', 'slider']).describe('Type of the element'),
-            element: z.string().describe('Human-readable element description'),
-            ref: z.string().describe('Exact target element reference that points to the element'),
-            value: z.string().describe('Value to verify. For checkbox, use "true" or "false".'),
+        inputSchema: bundle_1.z.object({
+            type: bundle_1.z.enum(['textbox', 'checkbox', 'radio', 'combobox', 'slider']).describe('Type of the element'),
+            element: bundle_1.z.string().describe('Human-readable element description'),
+            ref: bundle_1.z.string().describe('Exact target element reference that points to the element'),
+            value: bundle_1.z.string().describe('Value to verify. For checkbox, use "true" or "false".'),
         }),
         type: 'readOnly',
     },
     handle: async (tab, params, response) => {
         const locator = await tab.refLocator({ ref: params.ref, element: params.element });
-        const locatorSource = `page.${await generateLocator(locator)}`;
+        const locatorSource = `page.${await (0, utils_1.generateLocator)(locator)}`;
         if (params.type === 'textbox' || params.type === 'slider' || params.type === 'combobox') {
             const value = await locator.inputValue();
             if (value !== params.value) {
@@ -129,7 +164,7 @@ const verifyValue = defineTabTool({
         response.addResult('Done');
     },
 });
-export default [
+exports.default = [
     verifyElement,
     verifyText,
     verifyList,

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

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Copyright (c) Microsoft Corporation.
  *
@@ -13,18 +14,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { defineTool } from './tool.js';
-const wait = defineTool({
+Object.defineProperty(exports, "__esModule", { value: true });
+const bundle_1 = require("../../sdk/bundle");
+const tool_1 = require("./tool");
+const wait = (0, tool_1.defineTool)({
     capability: 'core',
     schema: {
         name: 'browser_wait_for',
         title: 'Wait for',
         description: 'Wait for text to appear or disappear or a specified time to pass',
-        inputSchema: z.object({
-            time: z.number().optional().describe('The time to wait in seconds'),
-            text: z.string().optional().describe('The text to wait for'),
-            textGone: z.string().optional().describe('The text to wait for to disappear'),
+        inputSchema: bundle_1.z.object({
+            time: bundle_1.z.number().optional().describe('The time to wait in seconds'),
+            text: bundle_1.z.string().optional().describe('The text to wait for'),
+            textGone: bundle_1.z.string().optional().describe('The text to wait for to disappear'),
         }),
         type: 'readOnly',
     },
@@ -50,6 +52,6 @@ const wait = defineTool({
         response.setIncludeSnapshot();
     },
 });
-export default [
+exports.default = [
     wait,
 ];

package/lib/browser/tools.js

@@ -0,0 +1,61 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allTools = void 0;
+exports.filteredTools = filteredTools;
+const common_1 = __importDefault(require("./tools/common"));
+const console_1 = __importDefault(require("./tools/console"));
+const dialogs_1 = __importDefault(require("./tools/dialogs"));
+const evaluate_1 = __importDefault(require("./tools/evaluate"));
+const files_1 = __importDefault(require("./tools/files"));
+const form_1 = __importDefault(require("./tools/form"));
+const install_1 = __importDefault(require("./tools/install"));
+const keyboard_1 = __importDefault(require("./tools/keyboard"));
+const mouse_1 = __importDefault(require("./tools/mouse"));
+const navigate_1 = __importDefault(require("./tools/navigate"));
+const network_1 = __importDefault(require("./tools/network"));
+const pdf_1 = __importDefault(require("./tools/pdf"));
+const snapshot_1 = __importDefault(require("./tools/snapshot"));
+const tabs_1 = __importDefault(require("./tools/tabs"));
+const screenshot_1 = __importDefault(require("./tools/screenshot"));
+const wait_1 = __importDefault(require("./tools/wait"));
+const verify_1 = __importDefault(require("./tools/verify"));
+exports.allTools = [
+    ...common_1.default,
+    ...console_1.default,
+    ...dialogs_1.default,
+    ...evaluate_1.default,
+    ...files_1.default,
+    ...form_1.default,
+    ...install_1.default,
+    ...keyboard_1.default,
+    ...navigate_1.default,
+    ...network_1.default,
+    ...mouse_1.default,
+    ...pdf_1.default,
+    ...screenshot_1.default,
+    ...snapshot_1.default,
+    ...tabs_1.default,
+    ...wait_1.default,
+    ...verify_1.default,
+];
+function filteredTools(config) {
+    return exports.allTools.filter(tool => { var _a; return tool.capability.startsWith('core') || ((_a = config.capabilities) === null || _a === void 0 ? void 0 : _a.includes(tool.capability)); });
+}