File size: 34,394 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 | /**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Manages browser lifecycle for the Browser Agent.
*
* Handles:
* - Browser management via chrome-devtools-mcp with --isolated mode
* - CDP connection via raw MCP SDK Client (NOT registered in main registry)
* - Visual tools via --experimental-vision flag
*
* IMPORTANT: The MCP client here is ISOLATED from the main agent's tool registry.
* Tools discovered from chrome-devtools-mcp are NOT registered in the main registry.
* They are wrapped as DeclarativeTools and passed directly to the browser agent.
*/
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
import type { Tool as McpTool } from '@modelcontextprotocol/sdk/types.js';
import { debugLogger } from '../../utils/debugLogger.js';
import { coreEvents } from '../../utils/events.js';
import type { Config } from '../../config/config.js';
import { Storage } from '../../config/storage.js';
import { getBrowserConsentIfNeeded } from '../../utils/browserConsent.js';
import { injectInputBlocker } from './inputBlocker.js';
import * as path from 'node:path';
import * as fs from 'node:fs';
import { fileURLToPath } from 'node:url';
import { injectAutomationOverlay } from './automationOverlay.js';
import { logBrowserAgentConnection } from '../../telemetry/loggers.js';
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
// Default browser profile directory name within ~/.gemini/
const BROWSER_PROFILE_DIR = 'cli-browser-profile';
/**
* Typed error for domain restriction violations.
* Thrown when a navigation tool targets a domain not in allowedDomains.
* Caught by mcpToolWrapper to terminate the agent immediately.
*/
export class DomainNotAllowedError extends Error {
constructor(message: string) {
super(message);
this.name = 'DomainNotAllowedError';
}
}
// Default timeout for MCP operations
const MCP_TIMEOUT_MS = 60_000;
// Maximum reconnection attempts before giving up
const MAX_RECONNECT_RETRIES = 3;
// Base delay (ms) for exponential backoff between reconnection attempts
const RECONNECT_BASE_DELAY_MS = 500;
/**
* Tools that can cause a full-page navigation (explicitly or implicitly).
*
* When any of these completes successfully, the current page DOM is replaced
* and the injected automation overlay is lost. BrowserManager re-injects the
* overlay after every successful call to one of these tools.
*
* Note: chrome-devtools-mcp is a pure request/response server and emits no
* MCP notifications, so listening for page-load events via the protocol is
* not possible. Intercepting at callTool() is the equivalent mechanism.
*/
const POTENTIALLY_NAVIGATING_TOOLS = new Set([
'click', // clicking a link navigates
'click_at', // coordinate click can also follow a link
'navigate_page',
'new_page',
'select_page', // switching pages can lose the overlay
'press_key', // Enter on a focused link/form triggers navigation
'handle_dialog', // confirming beforeunload can trigger navigation
]);
/**
* Content item from an MCP tool call response.
* Can be text or image (for take_screenshot).
*/
export interface McpContentItem {
type: 'text' | 'image';
text?: string;
/** Base64-encoded image data (for type='image') */
data?: string;
/** MIME type of the image (e.g., 'image/png') */
mimeType?: string;
}
/**
* Result from an MCP tool call.
*/
export interface McpToolCallResult {
content?: McpContentItem[];
isError?: boolean;
}
/**
* Manages browser lifecycle and ISOLATED MCP client for the Browser Agent.
*
* The browser is launched and managed by chrome-devtools-mcp in --isolated mode.
* Visual tools (click_at, etc.) are enabled via --experimental-vision flag.
*
* Key isolation property: The MCP client here does NOT register tools
* in the main ToolRegistry. Tools are kept local to the browser agent.
*/
export class BrowserManager {
// --- Static singleton management ---
private static instances = new Map<string, BrowserManager>();
/**
* Maximum number of parallel browser instances allowed in isolated mode.
* Prevents unbounded resource consumption from concurrent browser_agent calls.
*/
static readonly MAX_PARALLEL_INSTANCES = 5;
/**
* Returns the cache key for a given config.
* Uses `sessionMode:profilePath` so different profiles get separate instances.
*/
private static getInstanceKey(config: Config): string {
const browserConfig = config.getBrowserAgentConfig();
const sessionMode = browserConfig.customConfig.sessionMode ?? 'persistent';
const profilePath = browserConfig.customConfig.profilePath ?? 'default';
return `${sessionMode}:${profilePath}`;
}
/**
* Returns an existing BrowserManager for the current config's session mode
* and profile, or creates a new one.
*
* Concurrency rules:
* - **persistent / existing mode**: Only one instance is allowed at a time.
* If the instance is already in-use, an error is thrown instructing the
* caller to run browser tasks sequentially.
* - **isolated mode**: Parallel instances are allowed up to
* MAX_PARALLEL_INSTANCES. Each isolated instance gets its own temp profile.
*/
static getInstance(config: Config): BrowserManager {
const key = BrowserManager.getInstanceKey(config);
const sessionMode =
config.getBrowserAgentConfig().customConfig.sessionMode ?? 'persistent';
let instance = BrowserManager.instances.get(key);
if (!instance) {
instance = new BrowserManager(config);
BrowserManager.instances.set(key, instance);
debugLogger.log(`Created new BrowserManager singleton (key: ${key})`);
} else if (instance.inUse) {
// Persistent and existing modes share a browser profile directory.
// Chrome prevents multiple instances from using the same profile, so
// concurrent usage would cause "profile locked" errors.
if (sessionMode === 'persistent' || sessionMode === 'existing') {
throw new Error(
`Cannot launch a concurrent browser agent in "${sessionMode}" session mode. ` +
`The browser instance is already in use by another task. ` +
`Please run browser tasks sequentially, or switch to "isolated" session mode for concurrent browser usage.`,
);
}
// Isolated mode: allow parallel instances up to the limit.
let inUseCount = 1; // primary is already in-use
let suffix = 1;
let parallelKey = `${key}:${suffix}`;
let parallel = BrowserManager.instances.get(parallelKey);
while (parallel?.inUse) {
inUseCount++;
if (inUseCount >= BrowserManager.MAX_PARALLEL_INSTANCES) {
throw new Error(
`Maximum number of parallel browser instances (${BrowserManager.MAX_PARALLEL_INSTANCES}) reached. ` +
`Please wait for an existing browser task to complete before starting a new one.`,
);
}
suffix++;
parallelKey = `${key}:${suffix}`;
parallel = BrowserManager.instances.get(parallelKey);
}
if (!parallel) {
parallel = new BrowserManager(config);
BrowserManager.instances.set(parallelKey, parallel);
debugLogger.log(
`Created parallel BrowserManager (key: ${parallelKey})`,
);
} else {
debugLogger.log(
`Reusing released parallel BrowserManager (key: ${parallelKey})`,
);
}
instance = parallel;
} else {
debugLogger.log(
`Reusing existing BrowserManager singleton (key: ${key})`,
);
}
return instance;
}
/**
* Closes all cached BrowserManager instances and clears the cache.
* Called on /clear commands and CLI exit.
*/
static async resetAll(): Promise<void> {
const results = await Promise.allSettled(
Array.from(BrowserManager.instances.values()).map((instance) =>
instance.close(),
),
);
for (const result of results) {
if (result.status === 'rejected') {
debugLogger.error(
`Error during BrowserManager cleanup: ${result.reason instanceof Error ? result.reason.message : String(result.reason)}`,
);
}
}
BrowserManager.instances.clear();
}
/**
* Alias for resetAll β used by CLI exit cleanup for clarity.
*/
static async closeAll(): Promise<void> {
await BrowserManager.resetAll();
}
// --- Instance state ---
// Raw MCP SDK Client - NOT the wrapper McpClient
private rawMcpClient: Client | undefined;
private mcpTransport: StdioClientTransport | undefined;
private discoveredTools: McpTool[] = [];
private disconnected = false;
private isClosing = false;
private connectionPromise: Promise<void> | undefined;
/**
* Whether this instance is currently acquired by an active invocation.
* Used by getInstance() to avoid handing the same browser to concurrent
* browser_agent calls.
*/
private inUse = false;
/**
* Marks this instance as in-use. Call this when starting a browser agent
* invocation so concurrent calls get a separate instance.
*/
acquire(): void {
this.inUse = true;
}
/**
* Marks this instance as available for reuse. Call this in the finally
* block of a browser agent invocation.
*/
release(): void {
this.inUse = false;
}
/**
* Returns whether this instance is currently acquired by an active invocation.
*/
isAcquired(): boolean {
return this.inUse;
}
/** State for action rate limiting */
private actionCounter = 0;
private readonly maxActionsPerTask: number;
/**
* Whether to inject the automation overlay.
* Always false in headless mode (no visible window to decorate).
*/
private readonly shouldInjectOverlay: boolean;
private readonly shouldDisableInput: boolean;
constructor(private config: Config) {
const browserConfig = config.getBrowserAgentConfig();
this.shouldInjectOverlay = !browserConfig?.customConfig?.headless;
this.shouldDisableInput = config.shouldDisableBrowserUserInput();
this.maxActionsPerTask =
browserConfig?.customConfig.maxActionsPerTask ?? 100;
}
/**
* Gets the raw MCP SDK Client for direct tool calls.
* This client is ISOLATED from the main tool registry.
*/
async getRawMcpClient(): Promise<Client> {
if (this.rawMcpClient) {
return this.rawMcpClient;
}
await this.ensureConnection();
if (!this.rawMcpClient) {
throw new Error('Failed to initialize chrome-devtools MCP client');
}
return this.rawMcpClient;
}
/**
* Gets the tool definitions discovered from the MCP server.
* These are dynamically fetched from chrome-devtools-mcp.
*/
async getDiscoveredTools(): Promise<McpTool[]> {
await this.ensureConnection();
return this.discoveredTools;
}
/**
* Calls a tool on the MCP server.
*
* @param toolName The name of the tool to call
* @param args Arguments to pass to the tool
* @param signal Optional AbortSignal to cancel the call
* @param isInternal Determine if the tool is for internal execution
* @returns The result from the MCP server
*/
async callTool(
toolName: string,
args: Record<string, unknown>,
signal?: AbortSignal,
isInternal: boolean = false,
): Promise<McpToolCallResult> {
if (signal?.aborted) {
throw signal.reason ?? new Error('Operation cancelled');
}
// Hard enforcement of per-action rate limit
if (!isInternal) {
if (this.actionCounter >= this.maxActionsPerTask) {
const error = new Error(
`Browser agent reached maximum action limit (${this.maxActionsPerTask}). ` +
`Task terminated to prevent runaway execution. To config the limit, use maxActionsPerTask in the settings.`,
);
throw error;
}
this.actionCounter++;
}
const errorMessage = this.checkNavigationRestrictions(toolName, args);
if (errorMessage) {
throw new DomainNotAllowedError(errorMessage);
}
const client = await this.getRawMcpClient();
const callPromise = client.callTool(
{ name: toolName, arguments: args },
undefined,
{ timeout: MCP_TIMEOUT_MS },
);
let result: McpToolCallResult;
// If no signal, just await directly
if (!signal) {
result = this.toResult(await callPromise);
} else {
// Race the call against the abort signal
let onAbort: (() => void) | undefined;
try {
const raw = await Promise.race([
callPromise,
new Promise<never>((_resolve, reject) => {
onAbort = () =>
reject(signal.reason ?? new Error('Operation cancelled'));
signal.addEventListener('abort', onAbort, { once: true });
}),
]);
result = this.toResult(raw);
} finally {
if (onAbort) {
signal.removeEventListener('abort', onAbort);
}
}
}
// Re-inject the automation overlay and input blocker after tools that
// can cause a full-page navigation. chrome-devtools-mcp emits no MCP
// notifications, so callTool() is the only interception point.
//
// The input blocker injection is idempotent: the injected function
// reuses the existing DOM element when present and only recreates
// it when navigation has actually replaced the page DOM.
if (
!result.isError &&
POTENTIALLY_NAVIGATING_TOOLS.has(toolName) &&
!signal?.aborted
) {
// Don't re-inject if explicitly switching to a page in the background
if (toolName === 'select_page' && args['bringToFront'] === false) {
return result;
}
try {
if (this.shouldInjectOverlay) {
await injectAutomationOverlay(this, signal);
}
if (this.shouldDisableInput) {
await injectInputBlocker(this, signal);
}
} catch {
// Never let overlay/blocker failures interrupt the tool result
}
}
return result;
}
/**
* Safely maps a raw MCP SDK callTool response to our typed McpToolCallResult
* without using unsafe type assertions.
*/
private toResult(
raw: Awaited<ReturnType<Client['callTool']>>,
): McpToolCallResult {
return {
content: Array.isArray(raw.content)
? raw.content.map(
(item: {
type?: string;
text?: string;
data?: string;
mimeType?: string;
}) => ({
type: item.type === 'image' ? 'image' : 'text',
text: item.text,
data: item.data,
mimeType: item.mimeType,
}),
)
: undefined,
isError: raw.isError === true,
};
}
/**
* Returns whether the MCP client is currently connected and healthy.
*/
isConnected(): boolean {
return this.rawMcpClient !== undefined && !this.disconnected;
}
/**
* Ensures browser and MCP client are connected.
* If a previous connection was lost (e.g., user closed the browser),
* this will reconnect with exponential backoff (up to MAX_RECONNECT_RETRIES).
*
* Concurrent callers share a single in-flight connection promise so that
* two subagents racing at startup do not trigger duplicate connectMcp() calls.
*/
async ensureConnection(): Promise<void> {
// Already connected and healthy β nothing to do
if (this.isConnected()) {
return;
}
// A connection is already being established β wait for it instead of racing
if (this.connectionPromise) {
return this.connectionPromise;
}
// If previously connected but transport died, clean up before reconnecting
if (this.disconnected) {
debugLogger.log(
'Previous browser connection was lost. Cleaning up before reconnecting...',
);
await this.close();
this.disconnected = false;
}
// Start connecting; store the promise so concurrent callers can join it
this.connectionPromise = this.connectWithRetry().finally(() => {
this.connectionPromise = undefined;
});
return this.connectionPromise;
}
/**
* Connects to chrome-devtools-mcp with exponential backoff retry.
*/
private async connectWithRetry(): Promise<void> {
// Request browser consent if needed (first-run privacy notice)
const consentGranted = await getBrowserConsentIfNeeded();
if (!consentGranted) {
throw new Error(
'Browser agent requires user consent to proceed. ' +
'Please re-run and accept the privacy notice.',
);
}
let lastError: Error | undefined;
for (let attempt = 0; attempt < MAX_RECONNECT_RETRIES; attempt++) {
try {
await this.connectMcp();
return;
} catch (error) {
lastError = error instanceof Error ? error : new Error(String(error));
if (attempt < MAX_RECONNECT_RETRIES - 1) {
const delay = RECONNECT_BASE_DELAY_MS * Math.pow(2, attempt);
debugLogger.log(
`Connection attempt ${attempt + 1} failed, retrying in ${delay}ms...`,
);
await new Promise((resolve) => setTimeout(resolve, delay));
}
}
}
throw lastError!;
}
/**
* Closes browser and cleans up connections.
* The browser process is managed by chrome-devtools-mcp, so closing
* the transport will terminate the browser.
*/
async close(): Promise<void> {
this.isClosing = true;
// Close MCP client first
if (this.rawMcpClient) {
try {
await this.rawMcpClient.close();
} catch (error) {
debugLogger.error(
`Error closing MCP client: ${error instanceof Error ? error.message : String(error)}`,
);
}
this.rawMcpClient = undefined;
}
// Close transport (this terminates the browser)
if (this.mcpTransport) {
try {
await this.mcpTransport.close();
} catch (error) {
debugLogger.error(
`Error closing MCP transport: ${error instanceof Error ? error.message : String(error)}`,
);
}
this.mcpTransport = undefined;
}
this.discoveredTools = [];
this.connectionPromise = undefined;
}
/**
* Connects to chrome-devtools-mcp which manages the browser process.
*
* Spawns node with the bundled chrome-devtools-mcp.mjs.
* - --experimental-vision: Enables visual tools (click_at, etc.)
*
* IMPORTANT: This does NOT use McpClientManager and does NOT register
* tools in the main ToolRegistry. The connection is isolated to this
* BrowserManager instance.
*/
private async connectMcp(): Promise<void> {
this.isClosing = false;
debugLogger.log('Connecting isolated MCP client to chrome-devtools-mcp...');
// Create raw MCP SDK Client (not the wrapper McpClient)
this.rawMcpClient = new Client(
{
name: 'gemini-cli-browser-agent',
version: '1.0.0',
},
{
capabilities: {},
},
);
// Build args for chrome-devtools-mcp
const browserConfig = this.config.getBrowserAgentConfig();
const rawSessionMode = browserConfig.customConfig.sessionMode;
let sessionMode: 'persistent' | 'isolated' | 'existing' =
rawSessionMode === 'isolated' || rawSessionMode === 'existing'
? rawSessionMode
: 'persistent';
// Detect sandbox environment.
// SANDBOX env var is set to 'sandbox-exec' (seatbelt) or the container
// name (Docker/Podman/gVisor/LXC) when running inside a sandbox.
// CI uses 'sandbox:none' as a metadata label β not a real sandbox.
const sandboxType = process.env['SANDBOX'];
const isContainerSandbox =
!!sandboxType &&
sandboxType !== 'sandbox-exec' &&
sandboxType !== 'sandbox:none';
const isSeatbeltSandbox =
sandboxType === 'sandbox-exec' && sessionMode !== 'existing';
// Seatbelt sandbox: force isolated + headless for filesystem compatibility.
// Chrome exists on the host, but persistent profiles may conflict with
// seatbelt restrictions. Isolated mode uses tmpdir (always writable).
if (isSeatbeltSandbox) {
if (sessionMode !== 'isolated') {
sessionMode = 'isolated';
coreEvents.emitFeedback(
'info',
'π Sandbox: Using isolated browser session for compatibility.',
);
}
}
const mcpArgs = ['--experimental-vision'];
// Session mode determines how the browser is managed:
// - "isolated": Temp profile, cleaned up after session (--isolated)
// - "persistent": Persistent profile at ~/.gemini/cli-browser-profile/ (default)
// - "existing": Connect to already-running Chrome (--autoConnect, requires
// remote debugging enabled at chrome://inspect/#remote-debugging)
if (sessionMode === 'isolated') {
mcpArgs.push('--isolated');
} else if (sessionMode === 'existing') {
if (isContainerSandbox) {
// In container sandboxes, --autoConnect can't discover Chrome on the
// host (it uses local pipes/sockets). Use --browser-url with the
// resolved IP of host.docker.internal instead of the hostname, because
// Chrome's DevTools protocol rejects HTTP requests where the Host
// header is not 'localhost' or an IP address.
const dns = await import('node:dns');
let browserHost = 'host.docker.internal';
try {
const { address } = await dns.promises.lookup(browserHost);
browserHost = address;
} catch {
// Fallback: use hostname as-is if DNS resolution fails
debugLogger.log(
`Could not resolve host.docker.internal, using hostname directly`,
);
}
const browserUrl = `http://${browserHost}:9222`;
mcpArgs.push('--browser-url', browserUrl);
coreEvents.emitFeedback(
'info',
`π Container sandbox: Connecting to Chrome via ${browserHost}:9222.`,
);
} else {
mcpArgs.push('--autoConnect');
const message =
'π Browsing with your signed-in Chrome profile β cookies and saved logins will be visible to the agent.';
coreEvents.emitFeedback('info', message);
coreEvents.emitConsoleLog('info', message);
}
}
// Add optional settings from config.
// Force headless in seatbelt sandbox since Chrome profile/display access
// may be restricted, and the user is running in a sandboxed environment.
const effectiveHeadless =
!!browserConfig.customConfig.headless || isSeatbeltSandbox;
if (effectiveHeadless) {
mcpArgs.push('--headless');
}
if (browserConfig.customConfig.profilePath) {
mcpArgs.push('--userDataDir', browserConfig.customConfig.profilePath);
} else if (sessionMode === 'persistent') {
// Default persistent profile lives under ~/.gemini/cli-browser-profile
const defaultProfilePath = path.join(
Storage.getGlobalGeminiDir(),
BROWSER_PROFILE_DIR,
);
mcpArgs.push('--userDataDir', defaultProfilePath);
}
// Respect the user's privacy.usageStatisticsEnabled setting
if (!this.config.getUsageStatisticsEnabled()) {
mcpArgs.push('--no-usage-statistics', '--no-performance-crux');
}
if (
browserConfig.customConfig.allowedDomains &&
browserConfig.customConfig.allowedDomains.length > 0
) {
const exclusionRules = browserConfig.customConfig.allowedDomains
.map((domain) => {
if (!/^(\*\.)?([a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]+$/.test(domain)) {
throw new Error(`Invalid domain in allowedDomains: ${domain}`);
}
return `EXCLUDE ${domain}`;
})
.join(', ');
mcpArgs.push(
`--chromeArg="--host-rules=MAP * ~NOTFOUND, ${exclusionRules}"`,
);
}
debugLogger.log(
`Launching bundled chrome-devtools-mcp (${sessionMode} mode) with args: ${mcpArgs.join(' ')}`,
);
// Create stdio transport to the bundled chrome-devtools-mcp.
// stderr is piped (not inherited) to prevent MCP server banners and
// warnings from corrupting the UI in alternate buffer mode.
let bundleMcpPath = path.resolve(
__dirname,
'bundled/chrome-devtools-mcp.mjs',
);
if (!fs.existsSync(bundleMcpPath)) {
bundleMcpPath = path.resolve(
__dirname,
__dirname.includes(`${path.sep}dist${path.sep}`)
? '../../../bundled/chrome-devtools-mcp.mjs'
: '../../../dist/bundled/chrome-devtools-mcp.mjs',
);
}
this.mcpTransport = new StdioClientTransport({
command: 'node',
args: [bundleMcpPath, ...mcpArgs],
stderr: 'pipe',
});
// Forward piped stderr to debugLogger so it's visible with --debug.
const stderrStream = this.mcpTransport.stderr;
if (stderrStream) {
stderrStream.on('data', (chunk: Buffer) => {
debugLogger.log(
`[chrome-devtools-mcp stderr] ${chunk.toString().trimEnd()}`,
);
});
}
this.mcpTransport.onclose = () => {
this.disconnected = true;
if (this.isClosing) {
return;
}
debugLogger.error(
'chrome-devtools-mcp transport closed unexpectedly. ' +
'The MCP server process may have crashed.',
);
};
this.mcpTransport.onerror = (error: Error) => {
debugLogger.error(
`chrome-devtools-mcp transport error: ${error.message}`,
);
};
// Connect to MCP server β use a shorter timeout for 'existing' mode
// since it should connect quickly if remote debugging is enabled.
const connectTimeoutMs =
sessionMode === 'existing' ? 15_000 : MCP_TIMEOUT_MS;
let timeoutId: ReturnType<typeof setTimeout> | undefined;
const connectStartMs = Date.now();
try {
await Promise.race([
(async () => {
await this.rawMcpClient!.connect(this.mcpTransport!);
debugLogger.log('MCP client connected to chrome-devtools-mcp');
await this.discoverTools();
// clear the action counter for each connection
this.actionCounter = 0;
logBrowserAgentConnection(this.config, Date.now() - connectStartMs, {
session_mode: sessionMode,
headless: effectiveHeadless,
success: true,
tool_count: this.discoveredTools.length,
});
})(),
new Promise<never>((_, reject) => {
timeoutId = setTimeout(
() =>
reject(
new Error(
`Timed out connecting to chrome-devtools-mcp (${connectTimeoutMs}ms)`,
),
),
connectTimeoutMs,
);
}),
]);
} catch (error) {
await this.close();
const rawErrorMessage =
error instanceof Error ? error.message : String(error);
const errorType = BrowserManager.classifyConnectionError(rawErrorMessage);
logBrowserAgentConnection(this.config, Date.now() - connectStartMs, {
session_mode: sessionMode,
headless: effectiveHeadless,
success: false,
error_type: errorType,
});
// Provide error-specific, session-mode-aware remediation
throw this.createConnectionError(rawErrorMessage, sessionMode);
} finally {
if (timeoutId !== undefined) {
clearTimeout(timeoutId);
}
}
}
/**
* Classifies a connection error message into a known error type.
* Shared between connectMcp error recording and createConnectionError
* to ensure consistent error categorization across the browser agent.
*/
private static classifyConnectionError(
message: string,
): 'profile_locked' | 'timeout' | 'connection_refused' | 'unknown' {
const lowerMessage = message.toLowerCase();
if (lowerMessage.includes('already running')) {
return 'profile_locked';
} else if (lowerMessage.includes('timed out')) {
return 'timeout';
} else if (lowerMessage.includes('connection refused')) {
return 'connection_refused';
}
return 'unknown';
}
/**
* Creates an Error with context-specific remediation based on the actual
* error message and the current sessionMode.
*/
private createConnectionError(message: string, sessionMode: string): Error {
const errorType = BrowserManager.classifyConnectionError(message);
// "already running for the current profile" β persistent mode profile lock
if (errorType === 'profile_locked') {
if (sessionMode === 'persistent' || sessionMode === 'isolated') {
return new Error(
`Could not connect to Chrome: ${message}\n\n` +
`The Chrome profile is locked by another running instance.\n` +
`To fix this:\n` +
` 1. Close all Chrome windows using this profile, OR\n` +
` 2. Set sessionMode to "isolated" in settings.json to use a temporary profile, OR\n` +
` 3. Set profilePath in settings.json to use a different profile directory`,
);
}
// existing mode β shouldn't normally hit this, but handle gracefully
return new Error(
`Could not connect to Chrome: ${message}\n\n` +
`The Chrome profile is locked.\n` +
`Close other Chrome instances and try again.`,
);
}
// Timeout errors
if (errorType === 'timeout') {
if (sessionMode === 'existing') {
return new Error(
`Timed out connecting to Chrome: ${message}\n\n` +
`To use sessionMode "existing", you must:\n` +
` 1. Open Chrome (version 144+)\n` +
` 2. Navigate to chrome://inspect/#remote-debugging\n` +
` 3. Enable remote debugging\n\n` +
`Alternatively, set sessionMode to "persistent" (default) in settings.json to launch a dedicated browser.`,
);
}
return new Error(
`Timed out connecting to Chrome: ${message}\n\n` +
`Possible causes:\n` +
` 1. Chrome is not installed or not in PATH\n` +
` 2. Chrome failed to start (try setting headless: true in settings.json)`,
);
}
// Generic "existing" mode failures (connection refused, etc.)
if (sessionMode === 'existing') {
return new Error(
`Failed to connect to existing Chrome instance: ${message}\n\n` +
`To use sessionMode "existing", you must:\n` +
` 1. Open Chrome (version 144+)\n` +
` 2. Navigate to chrome://inspect/#remote-debugging\n` +
` 3. Enable remote debugging\n\n` +
`Alternatively, set sessionMode to "persistent" (default) in settings.json to launch a dedicated browser.`,
);
}
// Generic fallback β include sessionMode for debugging context
return new Error(
`Failed to connect to Chrome (sessionMode: ${sessionMode}): ${message}`,
);
}
/**
* Discovers tools from the connected MCP server.
*/
private async discoverTools(): Promise<void> {
if (!this.rawMcpClient) {
throw new Error('MCP client not connected');
}
const response = await this.rawMcpClient.listTools();
this.discoveredTools = response.tools;
debugLogger.log(
`Discovered ${this.discoveredTools.length} tools from chrome-devtools-mcp: ` +
this.discoveredTools.map((t) => t.name).join(', '),
);
}
/**
* Check navigation restrictions based on tools and the args sent
* along with them.
*
* @returns error message if failed, undefined if passed.
*/
private checkNavigationRestrictions(
toolName: string,
args: Record<string, unknown>,
): string | undefined {
const pageNavigationTools = ['navigate_page', 'new_page'];
if (!pageNavigationTools.includes(toolName)) {
return undefined;
}
const allowedDomains =
this.config.getBrowserAgentConfig().customConfig.allowedDomains;
if (!allowedDomains || allowedDomains.length === 0) {
return undefined;
}
const url = args['url'];
if (!url) {
return undefined;
}
if (typeof url !== 'string') {
return `Invalid URL: URL must be a string.`;
}
try {
const parsedUrl = new URL(url);
const urlHostname = parsedUrl.hostname;
if (!this.isDomainAllowed(urlHostname, allowedDomains)) {
return 'Domain not allowed: The requested domain is not in the allowed list.';
}
// Check query parameters for embedded URLs that could bypass domain
// restrictions via proxy services (e.g. translate.google.com/translate?u=BLOCKED).
const paramsToCheck = [
...parsedUrl.searchParams.values(),
// Also check fragments which might contain query-like params
...new URLSearchParams(parsedUrl.hash.replace(/^#/, '')).values(),
];
for (const paramValue of paramsToCheck) {
try {
const embeddedUrl = new URL(paramValue);
if (
embeddedUrl.protocol === 'http:' ||
embeddedUrl.protocol === 'https:'
) {
const embeddedHostname = embeddedUrl.hostname.replace(/\.$/, '');
if (!this.isDomainAllowed(embeddedHostname, allowedDomains)) {
return 'Domain not allowed: Embedded URL targets a disallowed domain.';
}
}
} catch {
// Not a valid URL, skip.
}
}
return undefined;
} catch {
return `Invalid URL: Malformed URL string.`;
}
}
/**
* Checks whether a hostname matches any pattern in the allowed domains list.
*/
private isDomainAllowed(hostname: string, allowedDomains: string[]): boolean {
const normalized = hostname.replace(/\.$/, '');
for (const domainPattern of allowedDomains) {
if (domainPattern.startsWith('*.')) {
const baseDomain = domainPattern.substring(2);
if (
normalized === baseDomain ||
normalized.endsWith(`.${baseDomain}`)
) {
return true;
}
} else {
if (normalized === domainPattern) {
return true;
}
}
}
// If none matched, then deny
return false;
}
}
|