@playwright/mcp 0.0.9 → 0.0.10

package/lib/index.js

@@ -14,84 +14,49 @@
  * 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;
-    };
-})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createServer = createServer;
 const server_1 = require("./server");
-const snapshot = __importStar(require("./tools/snapshot"));
-const common = __importStar(require("./tools/common"));
-const screenshot = __importStar(require("./tools/screenshot"));
+const common_1 = __importDefault(require("./tools/common"));
+const files_1 = __importDefault(require("./tools/files"));
+const install_1 = __importDefault(require("./tools/install"));
+const keyboard_1 = __importDefault(require("./tools/keyboard"));
+const navigate_1 = __importDefault(require("./tools/navigate"));
+const pdf_1 = __importDefault(require("./tools/pdf"));
+const snapshot_1 = __importDefault(require("./tools/snapshot"));
+const tabs_1 = __importDefault(require("./tools/tabs"));
+const screen_1 = __importDefault(require("./tools/screen"));
 const console_1 = require("./resources/console");
-const commonTools = [
-    common.pressKey,
-    common.wait,
-    common.pdf,
-    common.close,
-    common.install,
-];
 const snapshotTools = [
-    common.navigate(true),
-    common.goBack(true),
-    common.goForward(true),
-    common.chooseFile(true),
-    snapshot.snapshot,
-    snapshot.click,
-    snapshot.hover,
-    snapshot.type,
-    snapshot.selectOption,
-    snapshot.screenshot,
-    ...commonTools,
+    ...common_1.default,
+    ...(0, files_1.default)(true),
+    ...install_1.default,
+    ...(0, keyboard_1.default)(true),
+    ...(0, navigate_1.default)(true),
+    ...pdf_1.default,
+    ...snapshot_1.default,
+    ...(0, tabs_1.default)(true),
 ];
 const screenshotTools = [
-    common.navigate(false),
-    common.goBack(false),
-    common.goForward(false),
-    common.chooseFile(false),
-    screenshot.screenshot,
-    screenshot.moveMouse,
-    screenshot.click,
-    screenshot.drag,
-    screenshot.type,
-    ...commonTools,
+    ...common_1.default,
+    ...(0, files_1.default)(false),
+    ...install_1.default,
+    ...(0, keyboard_1.default)(false),
+    ...(0, navigate_1.default)(false),
+    ...pdf_1.default,
+    ...screen_1.default,
+    ...(0, tabs_1.default)(false),
 ];
 const resources = [
     console_1.console,
 ];
 const packageJSON = require('../package.json');
 function createServer(options) {
-    const tools = options?.vision ? screenshotTools : snapshotTools;
+    const allTools = options?.vision ? screenshotTools : snapshotTools;
+    const tools = allTools.filter(tool => !options?.capabilities || tool.capability === 'core' || options.capabilities.includes(tool.capability));
     return (0, server_1.createServerWithTools)({
         name: 'Playwright',
         version: packageJSON.version,

package/lib/program.js

@@ -33,6 +33,7 @@ commander_1.program
     .version('Version ' + packageJSON.version)
     .name(packageJSON.name)
     .option('--browser <browser>', 'Browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.')
+    .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('--executable-path <path>', 'Path to the browser executable.')
     .option('--headless', 'Run browser in headless mode, headed by default')
@@ -79,6 +80,7 @@ commander_1.program
         launchOptions,
         vision: !!options.vision,
         cdpEndpoint: options.cdpEndpoint,
+        capabilities: options.caps?.split(',').map((c) => c.trim()),
     }));
     setupExitWatchdog(serverList);
     if (options.port) {

package/lib/resources/console.js

@@ -23,7 +23,7 @@ exports.console = {
         mimeType: 'text/plain',
     },
     read: async (context, uri) => {
-        const messages = await context.console();
+        const messages = await context.currentTab().console();
         const log = messages.map(message => `[${message.type().toUpperCase()}] ${message.text()}`).join('\n');
         return [{
                 uri,

package/lib/tools/common.js

@@ -14,70 +14,14 @@
  * 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.install = exports.chooseFile = exports.close = exports.pdf = exports.pressKey = exports.wait = exports.goForward = exports.goBack = exports.navigate = void 0;
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
 const zod_1 = require("zod");
 const zod_to_json_schema_1 = require("zod-to-json-schema");
-const utils_1 = require("./utils");
-const navigateSchema = zod_1.z.object({
-    url: zod_1.z.string().describe('The URL to navigate to'),
-});
-const navigate = snapshot => ({
-    schema: {
-        name: 'browser_navigate',
-        description: 'Navigate to a URL',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(navigateSchema),
-    },
-    handle: async (context, params) => {
-        const validatedParams = navigateSchema.parse(params);
-        const page = await context.createPage();
-        await page.goto(validatedParams.url, { waitUntil: 'domcontentloaded' });
-        // Cap load event to 5 seconds, the page is operational at this point.
-        await page.waitForLoadState('load', { timeout: 5000 }).catch(() => { });
-        if (snapshot)
-            return (0, utils_1.captureAriaSnapshot)(context);
-        return {
-            content: [{
-                    type: 'text',
-                    text: `Navigated to ${validatedParams.url}`,
-                }],
-        };
-    },
-});
-exports.navigate = navigate;
-const goBackSchema = zod_1.z.object({});
-const goBack = snapshot => ({
-    schema: {
-        name: 'browser_go_back',
-        description: 'Go back to the previous page',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goBackSchema),
-    },
-    handle: async (context) => {
-        return await (0, utils_1.runAndWait)(context, 'Navigated back', async (page) => page.goBack(), snapshot);
-    },
-});
-exports.goBack = goBack;
-const goForwardSchema = zod_1.z.object({});
-const goForward = snapshot => ({
-    schema: {
-        name: 'browser_go_forward',
-        description: 'Go forward to the next page',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goForwardSchema),
-    },
-    handle: async (context) => {
-        return await (0, utils_1.runAndWait)(context, 'Navigated forward', async (page) => page.goForward(), snapshot);
-    },
-});
-exports.goForward = goForward;
 const waitSchema = zod_1.z.object({
     time: zod_1.z.number().describe('The time to wait in seconds'),
 });
-exports.wait = {
+const wait = {
+    capability: 'wait',
     schema: {
         name: 'browser_wait',
         description: 'Wait for a specified time in seconds',
@@ -94,43 +38,9 @@ exports.wait = {
         };
     },
 };
-const pressKeySchema = zod_1.z.object({
-    key: zod_1.z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
-});
-exports.pressKey = {
-    schema: {
-        name: 'browser_press_key',
-        description: 'Press a key on the keyboard',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(pressKeySchema),
-    },
-    handle: async (context, params) => {
-        const validatedParams = pressKeySchema.parse(params);
-        return await (0, utils_1.runAndWait)(context, `Pressed key ${validatedParams.key}`, async (page) => {
-            await page.keyboard.press(validatedParams.key);
-        });
-    },
-};
-const pdfSchema = zod_1.z.object({});
-exports.pdf = {
-    schema: {
-        name: 'browser_save_as_pdf',
-        description: 'Save page as PDF',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(pdfSchema),
-    },
-    handle: async (context) => {
-        const page = context.existingPage();
-        const fileName = path_1.default.join(os_1.default.tmpdir(), (0, utils_1.sanitizeForFilePath)(`page-${new Date().toISOString()}`)) + '.pdf';
-        await page.pdf({ path: fileName });
-        return {
-            content: [{
-                    type: 'text',
-                    text: `Saved as ${fileName}`,
-                }],
-        };
-    },
-};
 const closeSchema = zod_1.z.object({});
-exports.close = {
+const close = {
+    capability: 'core',
     schema: {
         name: 'browser_close',
         description: 'Close the page',
@@ -146,36 +56,7 @@ exports.close = {
         };
     },
 };
-const chooseFileSchema = zod_1.z.object({
-    paths: zod_1.z.array(zod_1.z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
-});
-const chooseFile = snapshot => ({
-    schema: {
-        name: 'browser_choose_file',
-        description: 'Choose one or multiple files to upload',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(chooseFileSchema),
-    },
-    handle: async (context, params) => {
-        const validatedParams = chooseFileSchema.parse(params);
-        return await (0, utils_1.runAndWait)(context, `Chose files ${validatedParams.paths.join(', ')}`, async () => {
-            await context.submitFileChooser(validatedParams.paths);
-        }, snapshot);
-    },
-});
-exports.chooseFile = chooseFile;
-exports.install = {
-    schema: {
-        name: 'browser_install',
-        description: 'Install the browser specified in the config. Call this if you get an error about the browser not being installed.',
-        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(zod_1.z.object({})),
-    },
-    handle: async (context) => {
-        const channel = await context.install();
-        return {
-            content: [{
-                    type: 'text',
-                    text: `Browser ${channel} installed`,
-                }],
-        };
-    },
-};
+exports.default = [
+    close,
+    wait,
+];

package/lib/tools/files.js

@@ -0,0 +1,44 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const uploadFileSchema = zod_1.z.object({
+    paths: zod_1.z.array(zod_1.z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
+});
+const uploadFile = captureSnapshot => ({
+    capability: 'files',
+    schema: {
+        name: 'browser_file_upload',
+        description: 'Upload one or multiple files',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(uploadFileSchema),
+    },
+    handle: async (context, params) => {
+        const validatedParams = uploadFileSchema.parse(params);
+        const tab = context.currentTab();
+        return await tab.runAndWait(async () => {
+            await tab.submitFileChooser(validatedParams.paths);
+        }, {
+            status: `Chose files ${validatedParams.paths.join(', ')}`,
+            captureSnapshot,
+            noClearFileChooser: true,
+        });
+    },
+});
+exports.default = (captureSnapshot) => [
+    uploadFile(captureSnapshot),
+];

package/lib/tools/install.js

@@ -0,0 +1,59 @@
+"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 });
+const child_process_1 = require("child_process");
+const path_1 = __importDefault(require("path"));
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const install = {
+    capability: 'install',
+    schema: {
+        name: 'browser_install',
+        description: 'Install the browser specified in the config. Call this if you get an error about the browser not being installed.',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(zod_1.z.object({})),
+    },
+    handle: async (context) => {
+        const channel = context.options.launchOptions?.channel ?? context.options.browserName ?? 'chrome';
+        const cli = path_1.default.join(require.resolve('playwright/package.json'), '..', 'cli.js');
+        const child = (0, child_process_1.fork)(cli, ['install', channel], {
+            stdio: 'pipe',
+        });
+        const output = [];
+        child.stdout?.on('data', data => output.push(data.toString()));
+        child.stderr?.on('data', data => output.push(data.toString()));
+        await new Promise((resolve, reject) => {
+            child.on('close', code => {
+                if (code === 0)
+                    resolve();
+                else
+                    reject(new Error(`Failed to install browser: ${output.join('')}`));
+            });
+        });
+        return {
+            content: [{
+                    type: 'text',
+                    text: `Browser ${channel} installed`,
+                }],
+        };
+    },
+};
+exports.default = [
+    install,
+];

package/lib/tools/keyboard.js

@@ -0,0 +1,45 @@
+"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 });
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = __importDefault(require("zod-to-json-schema"));
+const pressKeySchema = zod_1.z.object({
+    key: zod_1.z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
+});
+const pressKey = captureSnapshot => ({
+    capability: 'core',
+    schema: {
+        name: 'browser_press_key',
+        description: 'Press a key on the keyboard',
+        inputSchema: (0, zod_to_json_schema_1.default)(pressKeySchema),
+    },
+    handle: async (context, params) => {
+        const validatedParams = pressKeySchema.parse(params);
+        return await context.currentTab().runAndWait(async (tab) => {
+            await tab.page.keyboard.press(validatedParams.key);
+        }, {
+            status: `Pressed key ${validatedParams.key}`,
+            captureSnapshot,
+        });
+    },
+});
+exports.default = (captureSnapshot) => [
+    pressKey(captureSnapshot),
+];

package/lib/tools/navigate.js

@@ -0,0 +1,79 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const navigateSchema = zod_1.z.object({
+    url: zod_1.z.string().describe('The URL to navigate to'),
+});
+const navigate = captureSnapshot => ({
+    capability: 'core',
+    schema: {
+        name: 'browser_navigate',
+        description: 'Navigate to a URL',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(navigateSchema),
+    },
+    handle: async (context, params) => {
+        const validatedParams = navigateSchema.parse(params);
+        const currentTab = await context.ensureTab();
+        return await currentTab.run(async (tab) => {
+            await tab.navigate(validatedParams.url);
+        }, {
+            status: `Navigated to ${validatedParams.url}`,
+            captureSnapshot,
+        });
+    },
+});
+const goBackSchema = zod_1.z.object({});
+const goBack = snapshot => ({
+    capability: 'history',
+    schema: {
+        name: 'browser_navigate_back',
+        description: 'Go back to the previous page',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goBackSchema),
+    },
+    handle: async (context) => {
+        return await context.currentTab().runAndWait(async (tab) => {
+            await tab.page.goBack();
+        }, {
+            status: 'Navigated back',
+            captureSnapshot: snapshot,
+        });
+    },
+});
+const goForwardSchema = zod_1.z.object({});
+const goForward = snapshot => ({
+    capability: 'history',
+    schema: {
+        name: 'browser_navigate_forward',
+        description: 'Go forward to the next page',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(goForwardSchema),
+    },
+    handle: async (context) => {
+        return await context.currentTab().runAndWait(async (tab) => {
+            await tab.page.goForward();
+        }, {
+            status: 'Navigated forward',
+            captureSnapshot: snapshot,
+        });
+    },
+});
+exports.default = (captureSnapshot) => [
+    navigate(captureSnapshot),
+    goBack(captureSnapshot),
+    goForward(captureSnapshot),
+];

package/lib/tools/pdf.js

@@ -0,0 +1,48 @@
+"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 });
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const utils_1 = require("./utils");
+const pdfSchema = zod_1.z.object({});
+const pdf = {
+    capability: 'pdf',
+    schema: {
+        name: 'browser_pdf_save',
+        description: 'Save page as PDF',
+        inputSchema: (0, zod_to_json_schema_1.zodToJsonSchema)(pdfSchema),
+    },
+    handle: async (context) => {
+        const tab = context.currentTab();
+        const fileName = path_1.default.join(os_1.default.tmpdir(), (0, utils_1.sanitizeForFilePath)(`page-${new Date().toISOString()}`)) + '.pdf';
+        await tab.page.pdf({ path: fileName });
+        return {
+            content: [{
+                    type: 'text',
+                    text: `Saved as ${fileName}`,
+                }],
+        };
+    },
+};
+exports.default = [
+    pdf,
+];