playwriter 0.0.0 → 0.0.1

package/README.md

@@ -0,0 +1,60 @@
+# PlayWriter MCP
+
+A powerful browser automation MCP (Model Context Protocol) server that provides persistent browser sessions with advanced automation capabilities through Playwright.
+
+## Key Differences from playwright-mcp
+
+### 🔒 Persistent Data Directory
+PlayWriter MCP maintains a persistent user data directory between runs. This enables:
+- Login sessions with Google and other OAuth providers
+- Website authentication that persists across sessions
+- Test automation without repeated logins
+- Preserved cookies, local storage, and browser state
+
+### 🛡️ Anti-Detection Features
+Built-in detection prevention mechanisms allow automation on websites with bot protection:
+- Works seamlessly with Google and other major platforms
+- User-agent rotation
+- Automation flag removal
+- Realistic browser fingerprinting
+
+### 🌐 Shared Chrome Instance
+- Single Chrome instance shared between all agents
+- Each agent operates in its own tab
+- Can reuse existing pages/tabs via `context.pages()` in the execute tool
+- Find and switch between pages by URL or other criteria
+- Efficient resource usage
+- Better performance for multi-agent workflows
+
+### 🚀 Single Powerful Execute Tool
+Instead of many granular tools, PlayWriter provides one flexible `execute` tool:
+- Direct access to Playwright `page` and `context` objects
+- Write complex automation logic with loops and conditions
+- Full JavaScript execution capabilities
+- Custom wait conditions and complex interactions
+
+Example:
+```javascript
+// Complex wait logic with custom conditions
+while (!(await page.isVisible('.success-message'))) {
+    await page.click('.retry-button');
+    await page.waitForTimeout(1000);
+}
+```
+
+### 🔧 Additional Tools
+- `new_page` - Create a new browser tab/page
+- `accessibility_snapshot` - Get page structure as JSON
+- `console_logs` - Retrieve browser console messages
+- `network_history` - Monitor network requests
+
+## Roadmap
+
+- ☁️ Cloud service integration for shared persistent state
+- 🧪 Quality assertion tests in CI/CD pipelines
+- 🤖 Multi-agent collaboration features
+- 📊 Advanced debugging and monitoring capabilities
+
+## Installation
+
+See the main project documentation for installation and setup instructions.

package/bin.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import './dist/mcp.js';

package/dist/browser-config.d.ts

@@ -0,0 +1,2 @@
+export declare function getBrowserExecutablePath(): string;
+//# sourceMappingURL=browser-config.d.ts.map

package/dist/browser-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-config.d.ts","sourceRoot":"","sources":["../src/browser-config.ts"],"names":[],"mappings":"AAKA,wBAAgB,wBAAwB,IAAI,MAAM,CAejD"}

package/dist/browser-config.js

@@ -0,0 +1,59 @@
+import fs from 'node:fs';
+import os from 'node:os';
+// Function to get the browser executable path
+// Can be overridden by environment variable PLAYWRITER_BROWSER_PATH
+export function getBrowserExecutablePath() {
+    // Check environment variable first
+    const envPath = process.env.PLAYWRITER_BROWSER_PATH;
+    if (envPath && fs.existsSync(envPath)) {
+        return envPath;
+    }
+    // Check for Ghost Browser on macOS
+    // const ghostBrowserPath = '/Applications/Ghost Browser.app/Contents/MacOS/Ghost Browser'
+    // if (fs.existsSync(ghostBrowserPath)) {
+    //     return ghostBrowserPath
+    // }
+    // Fall back to finding Chrome
+    return findChromeExecutablePath();
+}
+// Original Chrome finding logic
+function findChromeExecutablePath() {
+    const osPlatform = os.platform();
+    const paths = (() => {
+        if (osPlatform === 'darwin') {
+            return [
+                '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+                '/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary',
+                '/Applications/Chromium.app/Contents/MacOS/Chromium',
+                '~/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+            ];
+        }
+        if (osPlatform === 'win32') {
+            return [
+                'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe',
+                'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
+                `${process.env.LOCALAPPDATA}\\Google\\Chrome\\Application\\chrome.exe`,
+                `${process.env.PROGRAMFILES}\\Google\\Chrome\\Application\\chrome.exe`,
+                `${process.env['PROGRAMFILES(X86)']}\\Google\\Chrome\\Application\\chrome.exe`,
+            ].filter(Boolean);
+        }
+        // Linux
+        return [
+            '/usr/bin/google-chrome',
+            '/usr/bin/google-chrome-stable',
+            '/usr/bin/chromium',
+            '/usr/bin/chromium-browser',
+            '/snap/bin/chromium',
+        ];
+    })();
+    for (const path of paths) {
+        const resolvedPath = path.startsWith('~')
+            ? path.replace('~', process.env.HOME || '')
+            : path;
+        if (fs.existsSync(resolvedPath)) {
+            return resolvedPath;
+        }
+    }
+    throw new Error('Could not find Chrome executable. Please install Google Chrome or set PLAYWRITER_BROWSER_PATH environment variable.');
+}
+//# sourceMappingURL=browser-config.js.map

package/dist/browser-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-config.js","sourceRoot":"","sources":["../src/browser-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,EAAE,MAAM,SAAS,CAAA;AAExB,8CAA8C;AAC9C,oEAAoE;AACpE,MAAM,UAAU,wBAAwB;IACpC,mCAAmC;IACnC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAA;IACnD,IAAI,OAAO,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,OAAO,CAAA;IAClB,CAAC;IAED,mCAAmC;IACnC,0FAA0F;IAC1F,yCAAyC;IACzC,8BAA8B;IAC9B,IAAI;IAEJ,8BAA8B;IAC9B,OAAO,wBAAwB,EAAE,CAAA;AACrC,CAAC;AAED,gCAAgC;AAChC,SAAS,wBAAwB;IAC7B,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAA;IAChC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE;QAChB,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO;gBACH,8DAA8D;gBAC9D,4EAA4E;gBAC5E,oDAAoD;gBACpD,+DAA+D;aAClE,CAAA;QACL,CAAC;QACD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YACzB,OAAO;gBACH,4DAA4D;gBAC5D,kEAAkE;gBAClE,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,2CAA2C;gBACtE,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,2CAA2C;gBACtE,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,2CAA2C;aACjF,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QACD,QAAQ;QACR,OAAO;YACH,wBAAwB;YACxB,+BAA+B;YAC/B,mBAAmB;YACnB,2BAA2B;YAC3B,oBAAoB;SACvB,CAAA;IACL,CAAC,CAAC,EAAE,CAAA;IAEJ,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YAC3C,CAAC,CAAC,IAAI,CAAA;QACV,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,OAAO,YAAY,CAAA;QACvB,CAAC;IACL,CAAC;IAED,MAAM,IAAI,KAAK,CACX,qHAAqH,CACxH,CAAA;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { startPlaywriter } from './playwriter';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { startPlaywriter } from './playwriter';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA"}

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,8 @@
+import { test, expect } from 'vitest';
+test('ready', () => {
+    expect(true).toBe(true);
+});
+test('two', () => {
+    expect(true).toBe(true);
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAErC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;IACf,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE;IACb,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC,CAAC,CAAA"}

package/dist/mcp-client.d.ts

@@ -0,0 +1,16 @@
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
+import { Stream } from 'node:stream';
+export interface CreateTransportOptions {
+    clientName?: string;
+}
+export declare function createTransport(args: string[]): Promise<{
+    transport: Transport;
+    stderr: Stream | null;
+}>;
+export declare function createMCPClient(options?: CreateTransportOptions): Promise<{
+    client: Client;
+    stderr: string;
+    cleanup: () => Promise<void>;
+}>;
+//# sourceMappingURL=mcp-client.d.ts.map

package/dist/mcp-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp-client.d.ts","sourceRoot":"","sources":["../src/mcp-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAA;AAElE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+CAA+C,CAAA;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMpC,MAAM,WAAW,sBAAsB;IACnC,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3D,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAC,CAkBD;AAED,wBAAsB,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/B,CAAC,CAgCD"}

package/dist/mcp-client.js

@@ -0,0 +1,52 @@
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
+import path from 'node:path';
+import url from 'node:url';
+const __filename = url.fileURLToPath(import.meta.url);
+export async function createTransport(args) {
+    const transport = new StdioClientTransport({
+        command: 'pnpm',
+        args: ['vite-node', path.join(path.dirname(__filename), 'mcp.ts'), ...args],
+        cwd: path.join(path.dirname(__filename), '..'),
+        stderr: 'pipe',
+        env: {
+            ...process.env,
+            DEBUG: 'playwriter:mcp:test',
+            DEBUG_COLORS: '0',
+            DEBUG_HIDE_DATE: '1',
+        },
+    });
+    return {
+        transport,
+        stderr: transport.stderr,
+    };
+}
+export async function createMCPClient(options) {
+    const client = new Client({
+        name: options?.clientName ?? 'test',
+        version: '1.0.0'
+    });
+    const { transport, stderr } = await createTransport([]);
+    let stderrBuffer = '';
+    stderr?.on('data', (data) => {
+        process.stderr.write(data);
+        stderrBuffer += data.toString();
+    });
+    await client.connect(transport);
+    await client.ping();
+    const cleanup = async () => {
+        try {
+            await client.close();
+        }
+        catch (e) {
+            console.error('Error during MCP client cleanup:', e);
+            // Ignore errors during cleanup
+        }
+    };
+    return {
+        client,
+        stderr: stderrBuffer,
+        cleanup,
+    };
+}
+//# sourceMappingURL=mcp-client.js.map

package/dist/mcp-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp-client.js","sourceRoot":"","sources":["../src/mcp-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAA;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAA;AAGhF,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,GAAG,MAAM,UAAU,CAAA;AAE1B,MAAM,UAAU,GAAG,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAMrD,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAc;IAIhD,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC;QACvC,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC;QAC3E,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;QAC9C,MAAM,EAAE,MAAM;QACd,GAAG,EAAE;YACD,GAAG,OAAO,CAAC,GAAG;YACd,KAAK,EAAE,qBAAqB;YAC5B,YAAY,EAAE,GAAG;YACjB,eAAe,EAAE,GAAG;SACvB;KACJ,CAAC,CAAA;IAEF,OAAO;QACH,SAAS;QACT,MAAM,EAAE,SAAS,CAAC,MAAO;KAC5B,CAAA;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgC;IAKlE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACtB,IAAI,EAAE,OAAO,EAAE,UAAU,IAAI,MAAM;QACnC,OAAO,EAAE,OAAO;KACnB,CAAC,CAAA;IAEF,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,eAAe,CAAC,EAAE,CAAC,CAAA;IAEvD,IAAI,YAAY,GAAG,EAAE,CAAA;IACrB,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAE1B,YAAY,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC/B,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnB,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;QACvB,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACxB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,CAAC,CAAC,CAAA;YAClD,+BAA+B;QACnC,CAAC;IACL,CAAC,CAAA;IAED,OAAO;QACH,MAAM;QACN,MAAM,EAAE,YAAY;QACpB,OAAO;KACV,CAAA;AACL,CAAC"}

package/dist/mcp.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mcp.d.ts.map

package/dist/mcp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":""}