@playwright/mcp 0.0.31 → 0.0.33

package/lib/loop/loop.js

@@ -0,0 +1,69 @@
+/**
+ * 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';
+export async function runTask(delegate, client, task, oneShot = false) {
+    const { tools } = await client.listTools();
+    const taskContent = oneShot ? `Perform following task: ${task}.` : `Perform following task: ${task}. Once the task is complete, call the "done" tool.`;
+    const conversation = delegate.createConversation(taskContent, tools, oneShot);
+    for (let iteration = 0; iteration < 5; ++iteration) {
+        debug('history')('Making API call for iteration', iteration);
+        const toolCalls = await delegate.makeApiCall(conversation);
+        if (toolCalls.length === 0)
+            throw new Error('Call the "done" tool when the task is complete.');
+        const toolResults = [];
+        for (const toolCall of toolCalls) {
+            const doneResult = delegate.checkDoneToolCall(toolCall);
+            if (doneResult !== null)
+                return conversation.messages;
+            const { name, arguments: args, id } = toolCall;
+            try {
+                debug('tool')(name, args);
+                const response = await client.callTool({
+                    name,
+                    arguments: args,
+                });
+                const responseContent = (response.content || []);
+                debug('tool')(responseContent);
+                const text = responseContent.filter(part => part.type === 'text').map(part => part.text).join('\n');
+                toolResults.push({
+                    toolCallId: id,
+                    content: text,
+                });
+            }
+            catch (error) {
+                debug('tool')(error);
+                toolResults.push({
+                    toolCallId: id,
+                    content: `Error while executing tool "${name}": ${error instanceof Error ? error.message : String(error)}\n\nPlease try to recover and complete the task.`,
+                    isError: true,
+                });
+                // Skip remaining tool calls for this iteration
+                for (const remainingToolCall of toolCalls.slice(toolCalls.indexOf(toolCall) + 1)) {
+                    toolResults.push({
+                        toolCallId: remainingToolCall.id,
+                        content: `This tool call is skipped due to previous error.`,
+                        isError: true,
+                    });
+                }
+                break;
+            }
+        }
+        delegate.addToolResults(conversation, toolResults);
+        if (oneShot)
+            return conversation.messages;
+    }
+    throw new Error('Failed to perform step, max attempts reached');
+}

package/lib/loop/loopClaude.js

@@ -0,0 +1,152 @@
+/**
+ * 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.
+ */
+const model = 'claude-sonnet-4-20250514';
+export class ClaudeDelegate {
+    _anthropic;
+    async anthropic() {
+        if (!this._anthropic) {
+            const anthropic = await import('@anthropic-ai/sdk');
+            this._anthropic = new anthropic.Anthropic();
+        }
+        return this._anthropic;
+    }
+    createConversation(task, tools, oneShot) {
+        const llmTools = tools.map(tool => ({
+            name: tool.name,
+            description: tool.description || '',
+            inputSchema: tool.inputSchema,
+        }));
+        if (!oneShot) {
+            llmTools.push({
+                name: 'done',
+                description: 'Call this tool when the task is complete.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {},
+                },
+            });
+        }
+        return {
+            messages: [{
+                    role: 'user',
+                    content: task
+                }],
+            tools: llmTools,
+        };
+    }
+    async makeApiCall(conversation) {
+        // Convert generic messages to Claude format
+        const claudeMessages = [];
+        for (const message of conversation.messages) {
+            if (message.role === 'user') {
+                claudeMessages.push({
+                    role: 'user',
+                    content: message.content
+                });
+            }
+            else if (message.role === 'assistant') {
+                const content = [];
+                // Add text content
+                if (message.content) {
+                    content.push({
+                        type: 'text',
+                        text: message.content,
+                        citations: []
+                    });
+                }
+                // Add tool calls
+                if (message.toolCalls) {
+                    for (const toolCall of message.toolCalls) {
+                        content.push({
+                            type: 'tool_use',
+                            id: toolCall.id,
+                            name: toolCall.name,
+                            input: toolCall.arguments
+                        });
+                    }
+                }
+                claudeMessages.push({
+                    role: 'assistant',
+                    content
+                });
+            }
+            else if (message.role === 'tool') {
+                // Tool results are added differently - we need to find if there's already a user message with tool results
+                const lastMessage = claudeMessages[claudeMessages.length - 1];
+                const toolResult = {
+                    type: 'tool_result',
+                    tool_use_id: message.toolCallId,
+                    content: message.content,
+                    is_error: message.isError,
+                };
+                if (lastMessage && lastMessage.role === 'user' && Array.isArray(lastMessage.content)) {
+                    // Add to existing tool results message
+                    lastMessage.content.push(toolResult);
+                }
+                else {
+                    // Create new tool results message
+                    claudeMessages.push({
+                        role: 'user',
+                        content: [toolResult]
+                    });
+                }
+            }
+        }
+        // Convert generic tools to Claude format
+        const claudeTools = conversation.tools.map(tool => ({
+            name: tool.name,
+            description: tool.description,
+            input_schema: tool.inputSchema,
+        }));
+        const anthropic = await this.anthropic();
+        const response = await anthropic.messages.create({
+            model,
+            max_tokens: 10000,
+            messages: claudeMessages,
+            tools: claudeTools,
+        });
+        // Extract tool calls and add assistant message to generic conversation
+        const toolCalls = response.content.filter(block => block.type === 'tool_use');
+        const textContent = response.content.filter(block => block.type === 'text').map(block => block.text).join('');
+        const llmToolCalls = toolCalls.map(toolCall => ({
+            name: toolCall.name,
+            arguments: toolCall.input,
+            id: toolCall.id,
+        }));
+        // Add assistant message to generic conversation
+        conversation.messages.push({
+            role: 'assistant',
+            content: textContent,
+            toolCalls: llmToolCalls.length > 0 ? llmToolCalls : undefined
+        });
+        return llmToolCalls;
+    }
+    addToolResults(conversation, results) {
+        for (const result of results) {
+            conversation.messages.push({
+                role: 'tool',
+                toolCallId: result.toolCallId,
+                content: result.content,
+                isError: result.isError,
+            });
+        }
+    }
+    checkDoneToolCall(toolCall) {
+        if (toolCall.name === 'done')
+            return toolCall.arguments.result;
+        return null;
+    }
+}

package/lib/loop/loopOpenAI.js

@@ -0,0 +1,141 @@
+/**
+ * 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.
+ */
+const model = 'gpt-4.1';
+export class OpenAIDelegate {
+    _openai;
+    async openai() {
+        if (!this._openai) {
+            const oai = await import('openai');
+            this._openai = new oai.OpenAI();
+        }
+        return this._openai;
+    }
+    createConversation(task, tools, oneShot) {
+        const genericTools = tools.map(tool => ({
+            name: tool.name,
+            description: tool.description || '',
+            inputSchema: tool.inputSchema,
+        }));
+        if (!oneShot) {
+            genericTools.push({
+                name: 'done',
+                description: 'Call this tool when the task is complete.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {},
+                },
+            });
+        }
+        return {
+            messages: [{
+                    role: 'user',
+                    content: task
+                }],
+            tools: genericTools,
+        };
+    }
+    async makeApiCall(conversation) {
+        // Convert generic messages to OpenAI format
+        const openaiMessages = [];
+        for (const message of conversation.messages) {
+            if (message.role === 'user') {
+                openaiMessages.push({
+                    role: 'user',
+                    content: message.content
+                });
+            }
+            else if (message.role === 'assistant') {
+                const toolCalls = [];
+                if (message.toolCalls) {
+                    for (const toolCall of message.toolCalls) {
+                        toolCalls.push({
+                            id: toolCall.id,
+                            type: 'function',
+                            function: {
+                                name: toolCall.name,
+                                arguments: JSON.stringify(toolCall.arguments)
+                            }
+                        });
+                    }
+                }
+                const assistantMessage = {
+                    role: 'assistant'
+                };
+                if (message.content)
+                    assistantMessage.content = message.content;
+                if (toolCalls.length > 0)
+                    assistantMessage.tool_calls = toolCalls;
+                openaiMessages.push(assistantMessage);
+            }
+            else if (message.role === 'tool') {
+                openaiMessages.push({
+                    role: 'tool',
+                    tool_call_id: message.toolCallId,
+                    content: message.content,
+                });
+            }
+        }
+        // Convert generic tools to OpenAI format
+        const openaiTools = conversation.tools.map(tool => ({
+            type: 'function',
+            function: {
+                name: tool.name,
+                description: tool.description,
+                parameters: tool.inputSchema,
+            },
+        }));
+        const openai = await this.openai();
+        const response = await openai.chat.completions.create({
+            model,
+            messages: openaiMessages,
+            tools: openaiTools,
+            tool_choice: 'auto'
+        });
+        const message = response.choices[0].message;
+        // Extract tool calls and add assistant message to generic conversation
+        const toolCalls = message.tool_calls || [];
+        const genericToolCalls = toolCalls.map(toolCall => {
+            const functionCall = toolCall.function;
+            return {
+                name: functionCall.name,
+                arguments: JSON.parse(functionCall.arguments),
+                id: toolCall.id,
+            };
+        });
+        // Add assistant message to generic conversation
+        conversation.messages.push({
+            role: 'assistant',
+            content: message.content || '',
+            toolCalls: genericToolCalls.length > 0 ? genericToolCalls : undefined
+        });
+        return genericToolCalls;
+    }
+    addToolResults(conversation, results) {
+        for (const result of results) {
+            conversation.messages.push({
+                role: 'tool',
+                toolCallId: result.toolCallId,
+                content: result.content,
+                isError: result.isError,
+            });
+        }
+    }
+    checkDoneToolCall(toolCall) {
+        if (toolCall.name === 'done')
+            return toolCall.arguments.result;
+        return null;
+    }
+}

package/lib/loop/main.js

@@ -0,0 +1,60 @@
+/**
+ * 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

@@ -0,0 +1,66 @@
+/**
+ * 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';
+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: '1.0.0' });
+        const browserContextFactory = contextFactory(config);
+        const server = mcpServer.createServer(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

@@ -0,0 +1,49 @@
+/**
+ * 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 mcpTransport from '../mcp/transport.js';
+import { packageJSON } from '../package.js';
+import { Context } from './context.js';
+import { perform } from './perform.js';
+import { snapshot } from './snapshot.js';
+export async function runLoopTools(config) {
+    dotenv.config();
+    const serverBackendFactory = () => new LoopToolsServerBackend(config);
+    await mcpTransport.start(serverBackendFactory, config.server);
+}
+class LoopToolsServerBackend {
+    name = 'Playwright';
+    version = packageJSON.version;
+    _config;
+    _context;
+    _tools = [perform, snapshot];
+    constructor(config) {
+        this._config = config;
+    }
+    async initialize() {
+        this._context = await Context.create(this._config);
+    }
+    tools() {
+        return this._tools.map(tool => tool.schema);
+    }
+    async callTool(schema, parsedArguments) {
+        const tool = this._tools.find(tool => tool.schema.name === schema.name);
+        return await tool.handle(this._context, parsedArguments);
+    }
+    serverClosed() {
+        void this._context.close();
+    }
+}

package/lib/loopTools/perform.js

@@ -0,0 +1,32 @@
+/**
+ * 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

@@ -0,0 +1,29 @@
+/**
+ * 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

@@ -0,0 +1,18 @@
+/**
+ * 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;
+}