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

package/lib/tools/screenshot.js

@@ -1,79 +0,0 @@
-/**
- * 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.
- */
-import { z } from 'zod';
-import { defineTabTool } from './tool.js';
-import * as javascript from '../utils/codegen.js';
-import { generateLocator } from './utils.js';
-const screenshotSchema = z.object({
-    type: z.enum(['png', 'jpeg']).default('png').describe('Image format for the screenshot. Default is png.'),
-    filename: z.string().optional().describe('File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified.'),
-    element: 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: 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: 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 = 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) => {
-        const fileType = params.type || 'png';
-        const fileName = await tab.context.outputFile(params.filename ?? `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 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
-            });
-        }
-    }
-});
-export default [
-    screenshot,
-];

package/lib/tools/snapshot.js

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

package/lib/tools.js

@@ -1,54 +0,0 @@
-/**
- * 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.
- */
-import common from './tools/common.js';
-import console from './tools/console.js';
-import dialogs from './tools/dialogs.js';
-import evaluate from './tools/evaluate.js';
-import files from './tools/files.js';
-import form from './tools/form.js';
-import install from './tools/install.js';
-import keyboard from './tools/keyboard.js';
-import mouse from './tools/mouse.js';
-import navigate from './tools/navigate.js';
-import network from './tools/network.js';
-import pdf from './tools/pdf.js';
-import snapshot from './tools/snapshot.js';
-import tabs from './tools/tabs.js';
-import screenshot from './tools/screenshot.js';
-import wait from './tools/wait.js';
-import verify from './tools/verify.js';
-export const allTools = [
-    ...common,
-    ...console,
-    ...dialogs,
-    ...evaluate,
-    ...files,
-    ...form,
-    ...install,
-    ...keyboard,
-    ...navigate,
-    ...network,
-    ...mouse,
-    ...pdf,
-    ...screenshot,
-    ...snapshot,
-    ...tabs,
-    ...wait,
-    ...verify,
-];
-export function filteredTools(config) {
-    return allTools.filter(tool => tool.capability.startsWith('core') || config.capabilities?.includes(tool.capability));
-}

package/lib/utils/fileUtils.js

@@ -1,36 +0,0 @@
-/**
- * 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.
- */
-import os from 'node:os';
-import path from 'node:path';
-export function cacheDir() {
-    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);
-    return path.join(cacheDirectory, 'ms-playwright');
-}
-export function sanitizeForFilePath(s) {
-    const sanitize = (s) => s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
-    const separator = s.lastIndexOf('.');
-    if (separator === -1)
-        return sanitize(s);
-    return sanitize(s.substring(0, separator)) + '.' + sanitize(s.substring(separator + 1));
-}

package/lib/utils/guid.js

@@ -1,22 +0,0 @@
-/**
- * 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.
- */
-import crypto from 'crypto';
-export function createGuid() {
-    return crypto.randomBytes(16).toString('hex');
-}
-export function createHash(data) {
-    return crypto.createHash('sha256').update(data).digest('hex').slice(0, 7);
-}