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

package/lib/loop/main.js

@@ -1,60 +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.
- */
-/* eslint-disable no-console */
-import path from 'path';
-import url from 'url';
-import dotenv from 'dotenv';
-import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
-import { Client } from '@modelcontextprotocol/sdk/client/index.js';
-import { program } from 'commander';
-import { OpenAIDelegate } from './loopOpenAI.js';
-import { ClaudeDelegate } from './loopClaude.js';
-import { runTask } from './loop.js';
-dotenv.config();
-const __filename = url.fileURLToPath(import.meta.url);
-async function run(delegate) {
-    const transport = new StdioClientTransport({
-        command: 'node',
-        args: [
-            path.resolve(__filename, '../../../cli.js'),
-            '--save-session',
-            '--output-dir', path.resolve(__filename, '../../../sessions')
-        ],
-        stderr: 'inherit',
-        env: process.env,
-    });
-    const client = new Client({ name: 'test', version: '1.0.0' });
-    await client.connect(transport);
-    await client.ping();
-    for (const task of tasks) {
-        const messages = await runTask(delegate, client, task);
-        for (const message of messages)
-            console.log(`${message.role}: ${message.content}`);
-    }
-    await client.close();
-}
-const tasks = [
-    'Open https://playwright.dev/',
-];
-program
-    .option('--model <model>', 'model to use')
-    .action(async (options) => {
-    if (options.model === 'claude')
-        await run(new ClaudeDelegate());
-    else
-        await run(new OpenAIDelegate());
-});
-void program.parseAsync(process.argv);

package/lib/loopTools/context.js

@@ -1,67 +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 { Client } from '@modelcontextprotocol/sdk/client/index.js';
-import { contextFactory } from '../browserContextFactory.js';
-import { BrowserServerBackend } from '../browserServerBackend.js';
-import { Context as BrowserContext } from '../context.js';
-import { runTask } from '../loop/loop.js';
-import { OpenAIDelegate } from '../loop/loopOpenAI.js';
-import { ClaudeDelegate } from '../loop/loopClaude.js';
-import { InProcessTransport } from '../mcp/inProcessTransport.js';
-import * as mcpServer from '../mcp/server.js';
-import { packageJSON } from '../utils/package.js';
-export class Context {
-    config;
-    _client;
-    _delegate;
-    constructor(config, client) {
-        this.config = config;
-        this._client = client;
-        if (process.env.OPENAI_API_KEY)
-            this._delegate = new OpenAIDelegate();
-        else if (process.env.ANTHROPIC_API_KEY)
-            this._delegate = new ClaudeDelegate();
-        else
-            throw new Error('No LLM API key found. Please set OPENAI_API_KEY or ANTHROPIC_API_KEY environment variable.');
-    }
-    static async create(config) {
-        const client = new Client({ name: 'Playwright Proxy', version: packageJSON.version });
-        const browserContextFactory = contextFactory(config);
-        const server = mcpServer.createServer('Playwright Subagent', packageJSON.version, new BrowserServerBackend(config, browserContextFactory), false);
-        await client.connect(new InProcessTransport(server));
-        await client.ping();
-        return new Context(config, client);
-    }
-    async runTask(task, oneShot = false) {
-        const messages = await runTask(this._delegate, this._client, task, oneShot);
-        const lines = [];
-        // Skip the first message, which is the user's task.
-        for (const message of messages.slice(1)) {
-            // Trim out all page snapshots.
-            if (!message.content.trim())
-                continue;
-            const index = oneShot ? -1 : message.content.indexOf('### Page state');
-            const trimmedContent = index === -1 ? message.content : message.content.substring(0, index);
-            lines.push(`[${message.role}]:`, trimmedContent);
-        }
-        return {
-            content: [{ type: 'text', text: lines.join('\n') }],
-        };
-    }
-    async close() {
-        await BrowserContext.disposeAll();
-    }
-}

package/lib/loopTools/main.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 dotenv from 'dotenv';
-import * as mcpServer from '../mcp/server.js';
-import { packageJSON } from '../utils/package.js';
-import { Context } from './context.js';
-import { perform } from './perform.js';
-import { snapshot } from './snapshot.js';
-import { toMcpTool } from '../mcp/tool.js';
-export async function runLoopTools(config) {
-    dotenv.config();
-    const serverBackendFactory = {
-        name: 'Playwright',
-        nameInConfig: 'playwright-loop',
-        version: packageJSON.version,
-        create: () => new LoopToolsServerBackend(config)
-    };
-    await mcpServer.start(serverBackendFactory, config.server);
-}
-class LoopToolsServerBackend {
-    _config;
-    _context;
-    _tools = [perform, snapshot];
-    constructor(config) {
-        this._config = config;
-    }
-    async initialize() {
-        this._context = await Context.create(this._config);
-    }
-    async listTools() {
-        return this._tools.map(tool => toMcpTool(tool.schema));
-    }
-    async callTool(name, args) {
-        const tool = this._tools.find(tool => tool.schema.name === name);
-        const parsedArguments = tool.schema.inputSchema.parse(args || {});
-        return await tool.handle(this._context, parsedArguments);
-    }
-    serverClosed() {
-        void this._context.close();
-    }
-}

package/lib/loopTools/perform.js

@@ -1,32 +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 { defineTool } from './tool.js';
-const performSchema = z.object({
-    task: z.string().describe('The task to perform with the browser'),
-});
-export const perform = defineTool({
-    schema: {
-        name: 'browser_perform',
-        title: 'Perform a task with the browser',
-        description: 'Perform a task with the browser. It can click, type, export, capture screenshot, drag, hover, select options, etc.',
-        inputSchema: performSchema,
-        type: 'destructive',
-    },
-    handle: async (context, params) => {
-        return await context.runTask(params.task);
-    },
-});

package/lib/loopTools/snapshot.js

@@ -1,29 +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 { defineTool } from './tool.js';
-export const snapshot = defineTool({
-    schema: {
-        name: 'browser_snapshot',
-        title: 'Take a snapshot of the browser',
-        description: 'Take a snapshot of the browser to read what is on the page.',
-        inputSchema: z.object({}),
-        type: 'readOnly',
-    },
-    handle: async (context, params) => {
-        return await context.runTask('Capture browser snapshot', true);
-    },
-});

package/lib/loopTools/tool.js

@@ -1,18 +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.
- */
-export function defineTool(tool) {
-    return tool;
-}

package/lib/mcp/server.js

@@ -1,123 +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 debug from 'debug';
-import { Server } from '@modelcontextprotocol/sdk/server/index.js';
-import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
-import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import { httpAddressToString, installHttpTransport, startHttpServer } from './http.js';
-import { InProcessTransport } from './inProcessTransport.js';
-const serverDebug = debug('pw:mcp:server');
-const errorsDebug = debug('pw:mcp:errors');
-export async function connect(factory, transport, runHeartbeat) {
-    const server = createServer(factory.name, factory.version, factory.create(), runHeartbeat);
-    await server.connect(transport);
-}
-export async function wrapInProcess(backend) {
-    const server = createServer('Internal', '0.0.0', backend, false);
-    return new InProcessTransport(server);
-}
-export function createServer(name, version, backend, runHeartbeat) {
-    let initializedPromiseResolve = () => { };
-    const initializedPromise = new Promise(resolve => initializedPromiseResolve = resolve);
-    const server = new Server({ name, version }, {
-        capabilities: {
-            tools: {},
-        }
-    });
-    server.setRequestHandler(ListToolsRequestSchema, async () => {
-        serverDebug('listTools');
-        await initializedPromise;
-        const tools = await backend.listTools();
-        return { tools };
-    });
-    let heartbeatRunning = false;
-    server.setRequestHandler(CallToolRequestSchema, async (request) => {
-        serverDebug('callTool', request);
-        await initializedPromise;
-        if (runHeartbeat && !heartbeatRunning) {
-            heartbeatRunning = true;
-            startHeartbeat(server);
-        }
-        try {
-            return await backend.callTool(request.params.name, request.params.arguments || {});
-        }
-        catch (error) {
-            return {
-                content: [{ type: 'text', text: '### Result\n' + String(error) }],
-                isError: true,
-            };
-        }
-    });
-    addServerListener(server, 'initialized', async () => {
-        try {
-            const capabilities = server.getClientCapabilities();
-            let clientRoots = [];
-            if (capabilities?.roots) {
-                const { roots } = await server.listRoots(undefined, { timeout: 2_000 }).catch(() => ({ roots: [] }));
-                clientRoots = roots;
-            }
-            const clientVersion = server.getClientVersion() ?? { name: 'unknown', version: 'unknown' };
-            await backend.initialize?.(server, clientVersion, clientRoots);
-            initializedPromiseResolve();
-        }
-        catch (e) {
-            errorsDebug(e);
-        }
-    });
-    addServerListener(server, 'close', () => backend.serverClosed?.(server));
-    return server;
-}
-const startHeartbeat = (server) => {
-    const beat = () => {
-        Promise.race([
-            server.ping(),
-            new Promise((_, reject) => setTimeout(() => reject(new Error('ping timeout')), 5000)),
-        ]).then(() => {
-            setTimeout(beat, 3000);
-        }).catch(() => {
-            void server.close();
-        });
-    };
-    beat();
-};
-function addServerListener(server, event, listener) {
-    const oldListener = server[`on${event}`];
-    server[`on${event}`] = () => {
-        oldListener?.();
-        listener();
-    };
-}
-export async function start(serverBackendFactory, options) {
-    if (options.port === undefined) {
-        await connect(serverBackendFactory, new StdioServerTransport(), false);
-        return;
-    }
-    const httpServer = await startHttpServer(options);
-    await installHttpTransport(httpServer, serverBackendFactory);
-    const url = httpAddressToString(httpServer.address());
-    const mcpConfig = { mcpServers: {} };
-    mcpConfig.mcpServers[serverBackendFactory.nameInConfig] = {
-        url: `${url}/mcp`
-    };
-    const message = [
-        `Listening on ${url}`,
-        'Put this in your client config:',
-        JSON.stringify(mcpConfig, undefined, 2),
-        'For legacy SSE transport support, you can use the /sse endpoint instead.',
-    ].join('\n');
-    // eslint-disable-next-line no-console
-    console.error(message);
-}

package/lib/tools/evaluate.js

@@ -1,53 +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 evaluateSchema = z.object({
-    function: z.string().describe('() => { /* code */ } or (element) => { /* code */ } when element is provided'),
-    element: z.string().optional().describe('Human-readable element description used to obtain permission to interact with the element'),
-    ref: z.string().optional().describe('Exact target element reference from the page snapshot'),
-});
-const evaluate = defineTabTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_evaluate',
-        title: 'Evaluate JavaScript',
-        description: 'Evaluate JavaScript expression on page or element',
-        inputSchema: evaluateSchema,
-        type: 'destructive',
-    },
-    handle: async (tab, params, response) => {
-        response.setIncludeSnapshot();
-        let locator;
-        if (params.ref && params.element) {
-            locator = await tab.refLocator({ ref: params.ref, element: params.element });
-            response.addCode(`await page.${await generateLocator(locator)}.evaluate(${javascript.quote(params.function)});`);
-        }
-        else {
-            response.addCode(`await page.evaluate(${javascript.quote(params.function)});`);
-        }
-        await tab.waitForCompletion(async () => {
-            const receiver = locator ?? tab.page;
-            const result = await receiver._evaluateFunction(params.function);
-            response.addResult(JSON.stringify(result, null, 2) || 'undefined');
-        });
-    },
-});
-export default [
-    evaluate,
-];

package/lib/tools/form.js

@@ -1,57 +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 { generateLocator } from './utils.js';
-import * as javascript from '../utils/codegen.js';
-const fillForm = defineTabTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_fill_form',
-        title: 'Fill form',
-        description: 'Fill multiple form fields',
-        inputSchema: z.object({
-            fields: z.array(z.object({
-                name: z.string().describe('Human-readable field name'),
-                type: z.enum(['textbox', 'checkbox', 'radio', 'combobox', 'slider']).describe('Type of the field'),
-                ref: z.string().describe('Exact target field reference from the page snapshot'),
-                value: z.string().describe('Value to fill in the field. If the field is a checkbox, the value should be `true` or `false`. If the field is a combobox, the value should be the text of the option.'),
-            })).describe('Fields to fill in'),
-        }),
-        type: 'destructive',
-    },
-    handle: async (tab, params, response) => {
-        for (const field of params.fields) {
-            const locator = await tab.refLocator({ element: field.name, ref: field.ref });
-            const locatorSource = `await page.${await generateLocator(locator)}`;
-            if (field.type === 'textbox' || field.type === 'slider') {
-                await locator.fill(field.value);
-                response.addCode(`${locatorSource}.fill(${javascript.quote(field.value)});`);
-            }
-            else if (field.type === 'checkbox' || field.type === 'radio') {
-                await locator.setChecked(field.value === 'true');
-                response.addCode(`${locatorSource}.setChecked(${javascript.quote(field.value)});`);
-            }
-            else if (field.type === 'combobox') {
-                await locator.selectOption({ label: field.value });
-                response.addCode(`${locatorSource}.selectOption(${javascript.quote(field.value)});`);
-            }
-        }
-    },
-});
-export default [
-    fillForm,
-];

package/lib/tools/keyboard.js

@@ -1,78 +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 { elementSchema } from './snapshot.js';
-import { generateLocator } from './utils.js';
-import * as javascript from '../utils/codegen.js';
-const pressKey = defineTabTool({
-    capability: 'core',
-    schema: {
-        name: 'browser_press_key',
-        title: 'Press a key',
-        description: 'Press a key on the keyboard',
-        inputSchema: z.object({
-            key: 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 = elementSchema.extend({
-    text: z.string().describe('Text to type into the element'),
-    submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
-    slowly: 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 = 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 generateLocator(locator)}.pressSequentially(${javascript.quote(params.text)});`);
-                await locator.pressSequentially(params.text);
-            }
-            else {
-                response.addCode(`await page.${await generateLocator(locator)}.fill(${javascript.quote(params.text)});`);
-                await locator.fill(params.text);
-            }
-            if (params.submit) {
-                response.setIncludeSnapshot();
-                response.addCode(`await page.${await generateLocator(locator)}.press('Enter');`);
-                await locator.press('Enter');
-            }
-        });
-    },
-});
-export default [
-    pressKey,
-    type,
-];

package/lib/tools/pdf.js

@@ -1,40 +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';
-const pdfSchema = z.object({
-    filename: z.string().optional().describe('File name to save the pdf to. Defaults to `page-{timestamp}.pdf` if not specified.'),
-});
-const pdf = 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) => {
-        const fileName = await tab.context.outputFile(params.filename ?? `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 });
-    },
-});
-export default [
-    pdf,
-];