Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -633,6 +633,9 @@ In these cases, start Chrome first and let the Chrome DevTools MCP server connec
- **Automatic connection (available in Chrome 144)**: best for sharing state between manual and agent-driven testing.
- **Manual connection via remote debugging port**: best when running inside a sandboxed environment.

> [!NOTE]
> To include extension pages and extension service workers while connecting to an existing Chrome instance, add `--category-extensions`. This applies to `--autoConnect`, `--browserUrl`, and `--wsEndpoint`.

#### Automatically connecting to a running Chrome instance

**Step 1:** Set up remote debugging in Chrome
Expand Down
95 changes: 59 additions & 36 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,65 @@ import {pageIdSchema} from './tools/ToolDefinition.js';
import {createTools} from './tools/tools.js';
import {VERSION} from './version.js';

type ServerArgs = ReturnType<typeof parseArguments>;

interface BrowserResolvers {
ensureBrowserConnected: typeof ensureBrowserConnected;
ensureBrowserLaunched: typeof ensureBrowserLaunched;
}

export async function resolveBrowser(
serverArgs: ServerArgs,
options: {
logFile?: fs.WriteStream;
},
resolvers: BrowserResolvers = {
ensureBrowserConnected,
ensureBrowserLaunched,
},
) {
const chromeArgs: string[] = (serverArgs.chromeArg ?? []).map(String);
const ignoreDefaultChromeArgs: string[] = (
serverArgs.ignoreDefaultChromeArg ?? []
).map(String);
if (serverArgs.proxyServer) {
chromeArgs.push(`--proxy-server=${serverArgs.proxyServer}`);
}
const devtools = serverArgs.experimentalDevtools ?? false;
return serverArgs.browserUrl ||
serverArgs.wsEndpoint ||
serverArgs.autoConnect
? await resolvers.ensureBrowserConnected({
browserURL: serverArgs.browserUrl,
wsEndpoint: serverArgs.wsEndpoint,
wsHeaders: serverArgs.wsHeaders,
// Important: only pass channel, if autoConnect is true.
channel: serverArgs.autoConnect
? (serverArgs.channel as Channel)
: undefined,
userDataDir: serverArgs.userDataDir,
devtools,
enableExtensions: serverArgs.categoryExtensions,
})
: await resolvers.ensureBrowserLaunched({
headless: serverArgs.headless,
executablePath: serverArgs.executablePath,
channel: serverArgs.channel as Channel,
isolated: serverArgs.isolated ?? false,
userDataDir: serverArgs.userDataDir,
logFile: options.logFile,
viewport: serverArgs.viewport,
chromeArgs,
ignoreDefaultChromeArgs,
acceptInsecureCerts: serverArgs.acceptInsecureCerts,
devtools,
enableExtensions: serverArgs.categoryExtensions,
viaCli: serverArgs.viaCli,
});
}

export async function createMcpServer(
serverArgs: ReturnType<typeof parseArguments>,
serverArgs: ServerArgs,
options: {
logFile?: fs.WriteStream;
},
Expand Down Expand Up @@ -59,42 +116,8 @@ export async function createMcpServer(

let context: McpContext;
async function getContext(): Promise<McpContext> {
const chromeArgs: string[] = (serverArgs.chromeArg ?? []).map(String);
const ignoreDefaultChromeArgs: string[] = (
serverArgs.ignoreDefaultChromeArg ?? []
).map(String);
if (serverArgs.proxyServer) {
chromeArgs.push(`--proxy-server=${serverArgs.proxyServer}`);
}
const devtools = serverArgs.experimentalDevtools ?? false;
const browser =
serverArgs.browserUrl || serverArgs.wsEndpoint || serverArgs.autoConnect
? await ensureBrowserConnected({
browserURL: serverArgs.browserUrl,
wsEndpoint: serverArgs.wsEndpoint,
wsHeaders: serverArgs.wsHeaders,
// Important: only pass channel, if autoConnect is true.
channel: serverArgs.autoConnect
? (serverArgs.channel as Channel)
: undefined,
userDataDir: serverArgs.userDataDir,
devtools,
})
: await ensureBrowserLaunched({
headless: serverArgs.headless,
executablePath: serverArgs.executablePath,
channel: serverArgs.channel as Channel,
isolated: serverArgs.isolated ?? false,
userDataDir: serverArgs.userDataDir,
logFile: options.logFile,
viewport: serverArgs.viewport,
chromeArgs,
ignoreDefaultChromeArgs,
acceptInsecureCerts: serverArgs.acceptInsecureCerts,
devtools,
enableExtensions: serverArgs.categoryExtensions,
viaCli: serverArgs.viaCli,
});
const browser = await resolveBrowser(serverArgs, options);

if (context?.browser !== browser) {
context = await McpContext.from(browser, logger, {
Expand Down
69 changes: 69 additions & 0 deletions tests/resolveBrowser.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/

import assert from 'node:assert';
import {describe, it} from 'node:test';

import {parseArguments} from '../src/bin/chrome-devtools-mcp-cli-options.js';
import {resolveBrowser} from '../src/index.js';
import type {Browser} from '../src/third_party/index.js';

describe('resolveBrowser', () => {
for (const [label, args] of [
[
'browserUrl',
['--browser-url', 'http://127.0.0.1:9222', '--category-extensions'],
],
[
'wsEndpoint',
[
'--ws-endpoint',
'ws://127.0.0.1:9222/devtools/browser/test',
'--category-extensions',
],
],
[
'autoConnect',
[
'--auto-connect',
'--user-data-dir',
'/tmp/profile',
'--category-extensions',
],
],
] as const) {
it(`passes enableExtensions on the connected-browser path via ${label}`, async () => {
const serverArgs = parseArguments('0.0.0', [
'node',
'chrome-devtools-mcp',
...args,
]);
const browser = {} as Browser;
const connectedCalls: Array<Record<string, unknown>> = [];
let launchedCallCount = 0;

const resolvedBrowser = await resolveBrowser(
serverArgs,
{},
{
ensureBrowserConnected: async options => {
connectedCalls.push(options as Record<string, unknown>);
return browser;
},
ensureBrowserLaunched: async () => {
launchedCallCount += 1;
return browser;
},
},
);

assert.strictEqual(resolvedBrowser, browser);
assert.strictEqual(launchedCallCount, 0);
assert.strictEqual(connectedCalls.length, 1);
assert.strictEqual(connectedCalls[0]?.['enableExtensions'], true);
});
}
});