ringo-patchright-mcp 1.0.0

package/cli.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/**
+ * 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.
+ */
+
+require('./monkey-patch.js');
+const { program } = require("patchright-core/lib/utilsBundle");
+const { decorateCommand } = require('patchright/lib/mcp/program');
+
+const packageJSON = require("./node_modules/patchright/package.json");
+const p = program.version('Version ' + packageJSON.version).name('Playwright MCP');
+decorateCommand(p, packageJSON.version)
+void program.parseAsync(process.argv);

package/index.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+/**
+ * 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 { createConnection } = require('patchright/lib/mcp/index');
+module.exports = { createConnection };

package/monkey-patch.js

@@ -0,0 +1,168 @@
+
+const tools = require("patchright/lib/mcp/browser/tools");
+const tool = require("patchright/lib/mcp/browser/tools/tool");
+const defineTabTool = tool.defineTabTool;
+
+let z = require('zod');
+
+const requests = defineTabTool({
+    capability: 'core',
+
+    schema: {
+        name: 'browser_network_requests_v2',
+        title: 'List network requests',
+        description: 'Returns all network requests since loading the page',
+        inputSchema: z.object({
+            // includeStatic: z.boolean()
+            //     .default(false)
+            //     .describe('Whether to include successful static resources like images, fonts, scripts, etc. Defaults to false.'),
+
+            "hidePing": z.boolean()
+                .default(true)
+                .describe('Whether to hide ping requests. Defaults to true.'),
+
+            "hideOther": z.boolean()
+                .default(true)
+                .describe('Whether to hide other requests. Defaults to true.'),
+
+            "hideImage": z.boolean()
+                .default(true)
+                .describe('Whether to hide image requests. Defaults to true.'),
+
+            "hideFont": z.boolean()
+                .default(true)
+                .describe('Whether to hide font requests. Defaults to true.'),
+
+            "hideMedia": z.boolean()
+                .default(true)
+                .describe('Whether to hide media requests. Defaults to true.'),
+
+            "hideStylesheet": z.boolean()
+                .default(true)
+                .describe('Whether to hide stylesheet requests. Defaults to true.'),
+
+            "hideScript": z.boolean()
+                .default(false)
+                .describe('Whether to hide script requests. Defaults to false.'),
+
+
+
+        }),
+        type: 'readOnly',
+    },
+
+    handle: async (tab, params, response) => {
+
+        function isHidden(request) {
+            if (params.hidePing && request.resourceType() === 'ping')
+                return true;
+            if (params.hideOther && request.resourceType() === 'other')
+                return true;
+            if (params.hideImage && request.resourceType() === 'image')
+                return true;
+            if (params.hideFont && request.resourceType() === 'font')
+                return true;
+            if (params.hideMedia && request.resourceType() === 'media')
+                return true;
+            if (params.hideStylesheet && request.resourceType() === 'stylesheet')
+                return true;
+            if (params.hideScript && request.resourceType() === 'script')
+                return true;
+
+            return false;
+        }
+
+
+        const requests = await tab.requests();
+        for (const request of requests) {
+            if (isHidden(request))
+                continue;
+            const rendered = await renderRequest(request,);
+            if (rendered)
+                response.addResult(rendered);
+        }
+    },
+});
+
+const requestMap = new Map();
+const requestIdMap = new Map();
+
+function getId(request) {
+    if (requestIdMap.has(request))
+        return requestIdMap.get(request);
+    const id = "req_" + (requestMap.size + 1);
+    requestMap.set(id, request);
+    requestIdMap.set(request, id);
+    return id;
+}
+
+function getRequestById(id) {
+    return requestMap.get(id);
+}
+
+async function renderRequest(request, includeStatic) {
+    const response = (request)._hasResponse ? await request.response() : undefined;
+    const isStaticRequest = ['document', 'stylesheet', 'image', 'media', 'font', 'script', 'manifest'].includes(request.resourceType());
+    const isSuccessfulRequest = !response || response.status() < 400;
+
+    if (isStaticRequest && isSuccessfulRequest && !includeStatic)
+        return undefined;
+
+    let id = getId(request);
+    const result = [];
+    result.push(`[${id}] [${request.method().toUpperCase()}] ${request.url()} [${request.resourceType()}]`);
+    if (response)
+        result.push(`=> [${response.status()}] ${response.statusText()} `);
+    return result.join(' ');
+}
+
+const response = defineTabTool({
+    capability: 'core',
+    schema: {
+        name: 'browser_network_full_response_by_id',
+        title: 'List network full request response by id',
+        description: 'Returns all network full request response by id since loading the page',
+        inputSchema: z.object({
+            id: z.string().describe('Id of the network request'),
+        }),
+        type: 'readOnly',
+    },
+
+    handle: async (tab, params, mcpResponse) => {
+        const request = getRequestById(params.id);
+        if (!request) {
+            mcpResponse.addError(`Request with id ${params.id} not found`);
+            return;
+        }
+
+        let response = (request)._hasResponse ? await request.response() : undefined;
+
+        let requestInfo = `[${params.id}] ${request.method().toUpperCase()} ${request.url()}`;
+        if (response) {
+            requestInfo += ` => ${response.status()} ${response.statusText()}`;
+        }
+        let reqHeadersInfo = `\n ======Request Headers======\n${JSON.stringify(await request.allHeaders())}\n`;
+
+        let requestBodyInfo = "";
+        if (request.postData()) {
+            requestBodyInfo = `\n ======Request Body======\n${request.postData()}\n`;
+        }
+
+        let finalStr = `${requestInfo}\n${reqHeadersInfo}${requestBodyInfo}`;
+        if (response) {
+            let bodyText = await response.text();
+            let respHeadersInfo = JSON.stringify(await response.allHeaders());
+            finalStr += `\n ======Response Headers======\n${respHeadersInfo}\n`;
+            finalStr += `\n ======Response Body======\n${bodyText}\n`;
+        }
+
+        mcpResponse.addResult(finalStr);
+    },
+})
+
+
+tools.browserTools.push(requests)
+tools.browserTools.push(response)
+
+//移除 tools.browserTools中的browser_network_requests
+tools.browserTools = tools.browserTools.filter((tool) => tool.schema.name !== 'browser_network_requests');

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "ringo-patchright-mcp",
+  "version": "1.0.0",
+  "description": "Patchright-based MCP server for browser automation",
+  "main": "index.js",
+  "bin": {
+    "ringo-patchright-mcp": "cli.js"
+  },
+  "files": [
+    "cli.js",
+    "index.js",
+    "monkey-patch.js",
+    "patch-patchright.js",
+    "tools/",
+    "README.md"
+  ],
+  "scripts": {
+    "postinstall": "node ./patch-patchright.js"
+  },
+  "dependencies": {
+    "patchright": "^1.57.0",
+    "rrweb": "^2.0.0-alpha.4",
+    "rrweb-player": "^1.0.0-alpha.4",
+    "zod": "^3.25.76"
+  },
+  "author": "",
+  "license": "Apache-2.0"
+}

package/patch-patchright.js

@@ -0,0 +1,22 @@
+// import fs from "fs";
+// import path from "path";
+
+// const pkgPath = path.resolve("node_modules/patchright/package.json");
+// const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+
+// // 增加你想暴露的内部模块
+// pkg.exports["./lib/mcp/browser/tab"] = "./lib/mcp/browser/tab.js";
+
+// // 写回文件
+// fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+
+// console.log("patchright patched");
+
+let fs = require("fs");
+let path = require("path");
+const pkgPath = path.resolve("node_modules/patchright/package.json");
+const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+
+pkg.exports["./lib/mcp/browser/tools/tool"] = "./lib/mcp/browser/tools/tool.js";
+fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+console.log("patchright mcp export patched");