@andrew-chen-wang/camoufox-mcp 0.0.1

package/lib/tools/vision.js

@@ -0,0 +1,189 @@
+/**
+ * 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';
+import * as javascript from '../javascript.js';
+const elementSchema = z.object({
+    element: z.string().describe('Human-readable element description used to obtain permission to interact with the element'),
+});
+const screenshot = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_screen_capture',
+        title: 'Take a screenshot',
+        description: 'Take a screenshot of the current page',
+        inputSchema: z.object({}),
+        type: 'readOnly',
+    },
+    handle: async (context) => {
+        const tab = await context.ensureTab();
+        const options = { type: 'jpeg', quality: 50, scale: 'css' };
+        const code = [
+            `// Take a screenshot of the current page`,
+            `await page.screenshot(${javascript.formatObject(options)});`,
+        ];
+        const action = () => tab.page.screenshot(options).then(buffer => {
+            return {
+                content: [{ type: 'image', data: buffer.toString('base64'), mimeType: 'image/jpeg' }],
+            };
+        });
+        return {
+            code,
+            action,
+            captureSnapshot: false,
+            waitForNetwork: false
+        };
+    },
+});
+const moveMouse = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_screen_move_mouse',
+        title: 'Move mouse',
+        description: 'Move mouse to a given position',
+        inputSchema: elementSchema.extend({
+            x: z.number().describe('X coordinate'),
+            y: z.number().describe('Y coordinate'),
+        }),
+        type: 'readOnly',
+    },
+    handle: async (context, params) => {
+        const tab = context.currentTabOrDie();
+        const code = [
+            `// Move mouse to (${params.x}, ${params.y})`,
+            `await page.mouse.move(${params.x}, ${params.y});`,
+        ];
+        const action = () => tab.page.mouse.move(params.x, params.y);
+        return {
+            code,
+            action,
+            captureSnapshot: false,
+            waitForNetwork: false
+        };
+    },
+});
+const click = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_screen_click',
+        title: 'Click',
+        description: 'Click left mouse button',
+        inputSchema: elementSchema.extend({
+            x: z.number().describe('X coordinate'),
+            y: z.number().describe('Y coordinate'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (context, params) => {
+        const tab = context.currentTabOrDie();
+        const code = [
+            `// Click mouse at coordinates (${params.x}, ${params.y})`,
+            `await page.mouse.move(${params.x}, ${params.y});`,
+            `await page.mouse.down();`,
+            `await page.mouse.up();`,
+        ];
+        const action = async () => {
+            await tab.page.mouse.move(params.x, params.y);
+            await tab.page.mouse.down();
+            await tab.page.mouse.up();
+        };
+        return {
+            code,
+            action,
+            captureSnapshot: false,
+            waitForNetwork: true,
+        };
+    },
+});
+const drag = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_screen_drag',
+        title: 'Drag mouse',
+        description: 'Drag left mouse button',
+        inputSchema: elementSchema.extend({
+            startX: z.number().describe('Start X coordinate'),
+            startY: z.number().describe('Start Y coordinate'),
+            endX: z.number().describe('End X coordinate'),
+            endY: z.number().describe('End Y coordinate'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (context, params) => {
+        const tab = context.currentTabOrDie();
+        const code = [
+            `// Drag mouse from (${params.startX}, ${params.startY}) to (${params.endX}, ${params.endY})`,
+            `await page.mouse.move(${params.startX}, ${params.startY});`,
+            `await page.mouse.down();`,
+            `await page.mouse.move(${params.endX}, ${params.endY});`,
+            `await page.mouse.up();`,
+        ];
+        const action = async () => {
+            await tab.page.mouse.move(params.startX, params.startY);
+            await tab.page.mouse.down();
+            await tab.page.mouse.move(params.endX, params.endY);
+            await tab.page.mouse.up();
+        };
+        return {
+            code,
+            action,
+            captureSnapshot: false,
+            waitForNetwork: true,
+        };
+    },
+});
+const type = defineTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_screen_type',
+        title: 'Type text',
+        description: 'Type text',
+        inputSchema: z.object({
+            text: z.string().describe('Text to type into the element'),
+            submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
+        }),
+        type: 'destructive',
+    },
+    handle: async (context, params) => {
+        const tab = context.currentTabOrDie();
+        const code = [
+            `// Type ${params.text}`,
+            `await page.keyboard.type('${params.text}');`,
+        ];
+        const action = async () => {
+            await tab.page.keyboard.type(params.text);
+            if (params.submit)
+                await tab.page.keyboard.press('Enter');
+        };
+        if (params.submit) {
+            code.push(`// Submit text`);
+            code.push(`await page.keyboard.press('Enter');`);
+        }
+        return {
+            code,
+            action,
+            captureSnapshot: false,
+            waitForNetwork: true,
+        };
+    },
+});
+export default [
+    screenshot,
+    moveMouse,
+    click,
+    drag,
+    type,
+];

package/lib/tools/wait.js

@@ -0,0 +1,59 @@
+/**
+ * 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 wait = captureSnapshot => defineTool({
+    capability: 'wait',
+    schema: {
+        name: 'browser_wait_for',
+        title: 'Wait for',
+        description: 'Wait for text to appear or disappear or a specified time to pass',
+        inputSchema: z.object({
+            time: z.number().optional().describe('The time to wait in seconds'),
+            text: z.string().optional().describe('The text to wait for'),
+            textGone: z.string().optional().describe('The text to wait for to disappear'),
+        }),
+        type: 'readOnly',
+    },
+    handle: async (context, params) => {
+        if (!params.text && !params.textGone && !params.time)
+            throw new Error('Either time, text or textGone must be provided');
+        const code = [];
+        if (params.time) {
+            code.push(`await new Promise(f => setTimeout(f, ${params.time} * 1000));`);
+            await new Promise(f => setTimeout(f, Math.min(10000, params.time * 1000)));
+        }
+        const tab = context.currentTabOrDie();
+        const locator = params.text ? tab.page.getByText(params.text).first() : undefined;
+        const goneLocator = params.textGone ? tab.page.getByText(params.textGone).first() : undefined;
+        if (goneLocator) {
+            code.push(`await page.getByText(${JSON.stringify(params.textGone)}).first().waitFor({ state: 'hidden' });`);
+            await goneLocator.waitFor({ state: 'hidden' });
+        }
+        if (locator) {
+            code.push(`await page.getByText(${JSON.stringify(params.text)}).first().waitFor({ state: 'visible' });`);
+            await locator.waitFor({ state: 'visible' });
+        }
+        return {
+            code,
+            captureSnapshot,
+            waitForNetwork: false,
+        };
+    },
+});
+export default (captureSnapshot) => [
+    wait(captureSnapshot),
+];

package/lib/tools.js

@@ -0,0 +1,73 @@
+/**
+ * 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 devtools from './tools/devtools.js';
+import dialogs from './tools/dialogs.js';
+import files from './tools/files.js';
+import forms from './tools/forms.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 storage from './tools/storage.js';
+import tabs from './tools/tabs.js';
+import screenshot from './tools/screenshot.js';
+import testing from './tools/testing.js';
+import vision from './tools/vision.js';
+import wait from './tools/wait.js';
+export const snapshotTools = [
+    ...common(true),
+    ...console,
+    ...dialogs(true),
+    ...files(true),
+    ...forms,
+    ...install,
+    ...keyboard(true),
+    ...mouse(true),
+    ...navigate(true),
+    ...network,
+    ...pdf,
+    ...screenshot,
+    ...snapshot,
+    ...storage,
+    ...tabs(true),
+    ...testing,
+    ...devtools,
+    ...wait(true),
+];
+export const visionTools = [
+    ...common(false),
+    ...console,
+    ...dialogs(false),
+    ...files(false),
+    ...forms,
+    ...install,
+    ...keyboard(false),
+    ...mouse(false),
+    ...navigate(false),
+    ...network,
+    ...pdf,
+    ...storage,
+    ...tabs(false),
+    ...testing,
+    ...devtools,
+    ...vision,
+    ...wait(false),
+];

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@andrew-chen-wang/camoufox-mcp",
+  "version": "0.0.1",
+  "description": "Camoufox-backed MCP browser automation server",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Andrew-Chen-Wang/camoufox-mcp.git"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf lib",
+    "test": "npm run build"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "lib",
+    "index.js",
+    "index.d.ts",
+    "config.d.ts",
+    "package.json"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.27.1",
+    "camoufox-js": "^0.9.3",
+    "debug": "^4.4.1",
+    "mime": "^4.1.0",
+    "playwright-core": "^1.53.0",
+    "ws": "^8.18.1",
+    "zod": "^3.25.76",
+    "zod-to-json-schema": "^3.24.6"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@types/node": "^22.15.30",
+    "typescript": "^5.8.3"
+  }
+}