chrome-devtools-mcp 0.7.0 → 0.8.0

package/README.md

@@ -291,6 +291,10 @@ The Chrome DevTools MCP server supports the following configuration option:
   If enabled, ignores errors relative to self-signed and expired certificates. Use with caution.
   - **Type:** boolean
 
+- **`--chromeArg`**
+  Additional arguments for Chrome. Only applies when Chrome is launched by chrome-devtools-mcp.
+  - **Type:** array
+
 <!-- END AUTO GENERATED OPTIONS -->
 
 Pass them via the `args` property in the JSON configuration. For example:
@@ -328,6 +332,69 @@ all instances of `chrome-devtools-mcp`. Set the `isolated` option to `true`
 to use a temporary user data dir instead which will be cleared automatically after
 the browser is closed.
 
+### Connecting to a running Chrome instance
+
+You can connect to a running Chrome instance by using the `--browser-url` option. This is useful if you want to use your existing Chrome profile or if you are running the MCP server in a sandboxed environment that does not allow starting a new Chrome instance.
+
+Here is a step-by-step guide on how to connect to a running Chrome Stable instance:
+
+**Step 1: Configure the MCP client**
+
+Add the `--browser-url` option to your MCP client configuration. The value of this option should be the URL of the running Chrome instance. `http://localhost:9222` is a common default.
+
+```json
+{
+  "mcpServers": {
+    "chrome-devtools": {
+      "command": "npx",
+      "args": [
+        "chrome-devtools-mcp@latest",
+        "--browser-url=http://localhost:9222"
+      ]
+    }
+  }
+}
+```
+
+**Step 2: Start the Chrome browser**
+
+> [!WARNING]  
+> Enabling the remote debugging port opens up a debugging port on the running browser instance. Any application on your machine can connect to this port and control the browser. Make sure that you are not browsing any sensitive websites while the debugging port is open.
+
+Start the Chrome browser with the remote debugging port enabled. Make sure to close any running Chrome instances before starting a new one with the debugging port enabled. The port number you choose must be the same as the one you specified in the `--browser-url` option in your MCP client configuration.
+
+For security reasons, [Chrome requires you to use a non-default user data directory](https://developer.chrome.com/blog/remote-debugging-port) when enabling the remote debugging port. You can specify a custom directory using the `--user-data-dir` flag. This ensures that your regular browsing profile and data are not exposed to the debugging session.
+
+**macOS**
+
+```bash
+/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222 --user-data-dir=/tmp/chrome-profile-stable
+```
+
+**Linux**
+
+```bash
+/usr/bin/google-chrome --remote-debugging-port=9222 --user-data-dir=/tmp/chrome-profile-stable
+```
+
+**Windows**
+
+```bash
+"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="%TEMP%\chrome-profile-stable"
+```
+
+**Step 3: Test your setup**
+
+After configuring the MCP client and starting the Chrome browser, you can test your setup by running a simple prompt in your MCP client:
+
+```
+Check the performance of https://developers.chrome.com
+```
+
+Your MCP client should connect to the running Chrome instance and receive a performance report.
+
+For more details on remote debugging, see the [Chrome DevTools documentation](https://developer.chrome.com/docs/devtools/remote-debugging/).
+
 ## Known limitations
 
 ### Operating system sandboxes

package/build/src/browser.js

@@ -8,39 +8,41 @@ import os from 'node:os';
 import path from 'node:path';
 import puppeteer from 'puppeteer-core';
 let browser;
-const ignoredPrefixes = new Set([
-    'chrome://',
-    'chrome-extension://',
-    'chrome-untrusted://',
-    'devtools://',
-]);
-function targetFilter(target) {
-    if (target.url() === 'chrome://newtab/') {
-        return true;
+function makeTargetFilter(devtools) {
+    const ignoredPrefixes = new Set([
+        'chrome://',
+        'chrome-extension://',
+        'chrome-untrusted://',
+    ]);
+    if (!devtools) {
+        ignoredPrefixes.add('devtools://');
     }
-    for (const prefix of ignoredPrefixes) {
-        if (target.url().startsWith(prefix)) {
-            return false;
+    return function targetFilter(target) {
+        if (target.url() === 'chrome://newtab/') {
+            return true;
         }
-    }
-    return true;
+        for (const prefix of ignoredPrefixes) {
+            if (target.url().startsWith(prefix)) {
+                return false;
+            }
+        }
+        return true;
+    };
 }
-const connectOptions = {
-    targetFilter,
-};
-export async function ensureBrowserConnected(browserURL) {
+export async function ensureBrowserConnected(options) {
     if (browser?.connected) {
         return browser;
     }
     browser = await puppeteer.connect({
-        ...connectOptions,
-        browserURL,
+        targetFilter: makeTargetFilter(options.devtools),
+        browserURL: options.browserURL,
         defaultViewport: null,
+        handleDevToolsAsPage: options.devtools,
     });
     return browser;
 }
 export async function launch(options) {
-    const { channel, executablePath, customDevTools, headless, isolated } = options;
+    const { channel, executablePath, headless, isolated } = options;
     const profileDirName = channel && channel !== 'stable'
         ? `chrome-profile-${channel}`
         : 'chrome-profile';
@@ -55,13 +57,13 @@ export async function launch(options) {
         ...(options.args ?? []),
         '--hide-crash-restore-bubble',
     ];
-    if (customDevTools) {
-        args.push(`--custom-devtools-frontend=file://${customDevTools}`);
-    }
     if (headless) {
         args.push('--screen-info={3840x2160}');
     }
     let puppeteerChannel;
+    if (options.devtools) {
+        args.push('--auto-open-devtools-for-tabs');
+    }
     if (!executablePath) {
         puppeteerChannel =
             channel && channel !== 'stable'
@@ -70,8 +72,8 @@ export async function launch(options) {
     }
     try {
         const browser = await puppeteer.launch({
-            ...connectOptions,
             channel: puppeteerChannel,
+            targetFilter: makeTargetFilter(options.devtools),
             executablePath,
             defaultViewport: null,
             userDataDir,
@@ -79,6 +81,7 @@ export async function launch(options) {
             headless,
             args,
             acceptInsecureCerts: options.acceptInsecureCerts,
+            handleDevToolsAsPage: options.devtools,
         });
         if (options.logFile) {
             // FIXME: we are probably subscribing too late to catch startup logs. We

package/build/src/cli.js

@@ -39,13 +39,6 @@ export const cliOptions = {
         description: 'If specified, creates a temporary user-data-dir that is automatically cleaned up after the browser is closed.',
         default: false,
     },
-    customDevtools: {
-        type: 'string',
-        description: 'Path to custom DevTools.',
-        hidden: true,
-        conflicts: 'browserUrl',
-        alias: 'd',
-    },
     channel: {
         type: 'string',
         description: 'Specify a different Chrome channel that should be used. The default is the stable channel version.',
@@ -81,6 +74,15 @@ export const cliOptions = {
         type: 'boolean',
         description: `If enabled, ignores errors relative to self-signed and expired certificates. Use with caution.`,
     },
+    experimentalDevtools: {
+        type: 'boolean',
+        describe: 'Whether to enable automation over DevTools targets',
+        hidden: true,
+    },
+    chromeArg: {
+        type: 'array',
+        describe: 'Additional arguments for Chrome. Only applies when Chrome is launched by chrome-devtools-mcp.',
+    },
 };
 export function parseArguments(version, argv = process.argv) {
     const yargsInstance = yargs(hideBin(argv))
@@ -109,6 +111,10 @@ export function parseArguments(version, argv = process.argv) {
             '$0 --viewport 1280x720',
             'Launch Chrome with the initial viewport size of 1280x720px',
         ],
+        [
+            `$0 --chrome-arg='--no-sandbox' --chrome-arg='--disable-setuid-sandbox'`,
+            'Launch Chrome without sandboxes. Use with caution.',
+        ],
     ]);
     return yargsInstance
         .wrap(Math.min(120, yargsInstance.terminalWidth()))

package/build/src/main.js

@@ -54,22 +54,26 @@ server.server.setRequestHandler(SetLevelRequestSchema, () => {
 });
 let context;
 async function getContext() {
-    const extraArgs = [];
+    const extraArgs = (args.chromeArg ?? []).map(String);
     if (args.proxyServer) {
         extraArgs.push(`--proxy-server=${args.proxyServer}`);
     }
+    const devtools = args.experimentalDevtools ?? false;
     const browser = args.browserUrl
-        ? await ensureBrowserConnected(args.browserUrl)
+        ? await ensureBrowserConnected({
+            browserURL: args.browserUrl,
+            devtools,
+        })
         : await ensureBrowserLaunched({
             headless: args.headless,
             executablePath: args.executablePath,
-            customDevTools: args.customDevtools,
             channel: args.channel,
             isolated: args.isolated,
             logFile,
             viewport: args.viewport,
             args: extraArgs,
             acceptInsecureCerts: args.acceptInsecureCerts,
+            devtools,
         });
     if (context?.browser !== browser) {
         context = await McpContext.from(browser, logger);
@@ -115,6 +119,10 @@ function registerTool(tool) {
                 };
             }
         }
+        catch (err) {
+            logger(`${tool.name} error: ${err.message}`);
+            throw err;
+        }
         finally {
             guard.dispose();
         }

package/build/src/tools/console.js

@@ -7,7 +7,7 @@ import { ToolCategories } from './categories.js';
 import { defineTool } from './ToolDefinition.js';
 export const consoleTool = defineTool({
     name: 'list_console_messages',
-    description: 'List all console messages for the currently selected page',
+    description: 'List all console messages for the currently selected page since the last navigation.',
     annotations: {
         category: ToolCategories.DEBUGGING,
         readOnlyHint: true,

package/build/src/tools/network.js

@@ -29,7 +29,7 @@ const FILTERABLE_RESOURCE_TYPES = [
 ];
 export const listNetworkRequests = defineTool({
     name: 'list_network_requests',
-    description: `List all requests for the currently selected page`,
+    description: `List all requests for the currently selected page since the last navigation.`,
     annotations: {
         category: ToolCategories.NETWORK,
         readOnlyHint: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrome-devtools-mcp",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "MCP server for Chrome DevTools",
   "type": "module",
   "bin": "./build/src/index.js",
@@ -40,7 +40,7 @@
     "@modelcontextprotocol/sdk": "1.19.1",
     "core-js": "3.45.1",
     "debug": "4.4.3",
-    "puppeteer-core": "^24.23.1",
+    "puppeteer-core": "^24.24.0",
     "yargs": "18.0.0",
     "zod": "^3.25.76"
   },
@@ -60,7 +60,7 @@
     "eslint-plugin-import": "^2.32.0",
     "globals": "^16.4.0",
     "prettier": "^3.6.2",
-    "puppeteer": "24.23.1",
+    "puppeteer": "24.24.0",
     "sinon": "^21.0.0",
     "typescript": "^5.9.2",
     "typescript-eslint": "^8.43.0"