chrome-devtools-mcp 0.17.1 → 0.17.2

package/build/src/main.js

@@ -1,196 +0,0 @@
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import './polyfill.js';
-import process from 'node:process';
-import { ensureBrowserConnected, ensureBrowserLaunched } from './browser.js';
-import { cliOptions, parseArguments } from './cli.js';
-import { loadIssueDescriptions } from './issue-descriptions.js';
-import { logger, saveLogsToFile } from './logger.js';
-import { McpContext } from './McpContext.js';
-import { McpResponse } from './McpResponse.js';
-import { Mutex } from './Mutex.js';
-import { ClearcutLogger } from './telemetry/ClearcutLogger.js';
-import { computeFlagUsage } from './telemetry/flagUtils.js';
-import { bucketizeLatency } from './telemetry/metricUtils.js';
-import { McpServer, StdioServerTransport, SetLevelRequestSchema, } from './third_party/index.js';
-import { ToolCategory } from './tools/categories.js';
-import { tools } from './tools/tools.js';
-// If moved update release-please config
-// x-release-please-start-version
-const VERSION = '0.17.1';
-// x-release-please-end
-export const args = parseArguments(VERSION);
-const logFile = args.logFile ? saveLogsToFile(args.logFile) : undefined;
-if (process.env['CI'] ||
-    process.env['CHROME_DEVTOOLS_MCP_NO_USAGE_STATISTICS']) {
-    console.error("turning off usage statistics. process.env['CI'] || process.env['CHROME_DEVTOOLS_MCP_NO_USAGE_STATISTICS'] is set.");
-    args.usageStatistics = false;
-}
-let clearcutLogger;
-if (args.usageStatistics) {
-    clearcutLogger = new ClearcutLogger({
-        logFile: args.logFile,
-        appVersion: VERSION,
-        clearcutEndpoint: args.clearcutEndpoint,
-        clearcutForceFlushIntervalMs: args.clearcutForceFlushIntervalMs,
-        clearcutIncludePidHeader: args.clearcutIncludePidHeader,
-    });
-}
-process.on('unhandledRejection', (reason, promise) => {
-    logger('Unhandled promise rejection', promise, reason);
-});
-logger(`Starting Chrome DevTools MCP Server v${VERSION}`);
-const server = new McpServer({
-    name: 'chrome_devtools',
-    title: 'Chrome DevTools MCP server',
-    version: VERSION,
-}, { capabilities: { logging: {} } });
-server.server.setRequestHandler(SetLevelRequestSchema, () => {
-    return {};
-});
-let context;
-async function getContext() {
-    const chromeArgs = (args.chromeArg ?? []).map(String);
-    const ignoreDefaultChromeArgs = (args.ignoreDefaultChromeArg ?? []).map(String);
-    if (args.proxyServer) {
-        chromeArgs.push(`--proxy-server=${args.proxyServer}`);
-    }
-    const devtools = args.experimentalDevtools ?? false;
-    const browser = args.browserUrl || args.wsEndpoint || args.autoConnect
-        ? await ensureBrowserConnected({
-            browserURL: args.browserUrl,
-            wsEndpoint: args.wsEndpoint,
-            wsHeaders: args.wsHeaders,
-            // Important: only pass channel, if autoConnect is true.
-            channel: args.autoConnect ? args.channel : undefined,
-            userDataDir: args.userDataDir,
-            devtools,
-        })
-        : await ensureBrowserLaunched({
-            headless: args.headless,
-            executablePath: args.executablePath,
-            channel: args.channel,
-            isolated: args.isolated ?? false,
-            userDataDir: args.userDataDir,
-            logFile,
-            viewport: args.viewport,
-            chromeArgs,
-            ignoreDefaultChromeArgs,
-            acceptInsecureCerts: args.acceptInsecureCerts,
-            devtools,
-            enableExtensions: args.categoryExtensions,
-        });
-    if (context?.browser !== browser) {
-        context = await McpContext.from(browser, logger, {
-            experimentalDevToolsDebugging: devtools,
-            experimentalIncludeAllPages: args.experimentalIncludeAllPages,
-            performanceCrux: args.performanceCrux,
-        });
-    }
-    return context;
-}
-const logDisclaimers = () => {
-    console.error(`chrome-devtools-mcp exposes content of the browser instance to the MCP clients allowing them to inspect,
-debug, and modify any data in the browser or DevTools.
-Avoid sharing sensitive or personal information that you do not want to share with MCP clients.`);
-    if (args.performanceCrux) {
-        console.error(`Performance tools may send trace URLs to the Google CrUX API to fetch real-user experience data. To disable, run with --no-performance-crux.`);
-    }
-    if (args.usageStatistics) {
-        console.error(`
-Google collects usage statistics to improve Chrome DevTools MCP. To opt-out, run with --no-usage-statistics.
-For more details, visit: https://github.com/ChromeDevTools/chrome-devtools-mcp#usage-statistics`);
-    }
-};
-const toolMutex = new Mutex();
-function registerTool(tool) {
-    if (tool.annotations.category === ToolCategory.EMULATION &&
-        args.categoryEmulation === false) {
-        return;
-    }
-    if (tool.annotations.category === ToolCategory.PERFORMANCE &&
-        args.categoryPerformance === false) {
-        return;
-    }
-    if (tool.annotations.category === ToolCategory.NETWORK &&
-        args.categoryNetwork === false) {
-        return;
-    }
-    if (tool.annotations.category === ToolCategory.EXTENSIONS &&
-        args.categoryExtensions === false) {
-        return;
-    }
-    if (tool.annotations.conditions?.includes('computerVision') &&
-        !args.experimentalVision) {
-        return;
-    }
-    if (tool.annotations.conditions?.includes('experimentalInteropTools') &&
-        !args.experimentalInteropTools) {
-        return;
-    }
-    server.registerTool(tool.name, {
-        description: tool.description,
-        inputSchema: tool.schema,
-        annotations: tool.annotations,
-    }, async (params) => {
-        const guard = await toolMutex.acquire();
-        const startTime = Date.now();
-        let success = false;
-        try {
-            logger(`${tool.name} request: ${JSON.stringify(params, null, '  ')}`);
-            const context = await getContext();
-            logger(`${tool.name} context: resolved`);
-            await context.detectOpenDevToolsWindows();
-            const response = new McpResponse();
-            await tool.handler({
-                params,
-            }, response, context);
-            const { content, structuredContent } = await response.handle(tool.name, context);
-            const result = {
-                content,
-            };
-            success = true;
-            if (args.experimentalStructuredContent) {
-                result.structuredContent = structuredContent;
-            }
-            return result;
-        }
-        catch (err) {
-            logger(`${tool.name} error:`, err, err?.stack);
-            let errorText = err && 'message' in err ? err.message : String(err);
-            if ('cause' in err && err.cause) {
-                errorText += `\nCause: ${err.cause.message}`;
-            }
-            return {
-                content: [
-                    {
-                        type: 'text',
-                        text: errorText,
-                    },
-                ],
-                isError: true,
-            };
-        }
-        finally {
-            void clearcutLogger?.logToolInvocation({
-                toolName: tool.name,
-                success,
-                latencyMs: bucketizeLatency(Date.now() - startTime),
-            });
-            guard.dispose();
-        }
-    });
-}
-for (const tool of tools) {
-    registerTool(tool);
-}
-await loadIssueDescriptions();
-const transport = new StdioServerTransport();
-await server.connect(transport);
-logger('Chrome DevTools MCP Server connected');
-logDisclaimers();
-void clearcutLogger?.logDailyActiveIfNeeded();
-void clearcutLogger?.logServerStart(computeFlagUsage(args, cliOptions));

package/build/src/polyfill.js

@@ -1,7 +0,0 @@
-/**
- * @license
- * Copyright 2025 Google Inc.
- * SPDX-License-Identifier: Apache-2.0
- */
-// polyfills are now bundled with all other dependencies
-import './third_party/index.js';

package/build/src/telemetry/ClearcutLogger.js

@@ -1,102 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import process from 'node:process';
-import { logger } from '../logger.js';
-import { FilePersistence } from './persistence.js';
-import { WatchdogMessageType, OsType } from './types.js';
-import { WatchdogClient } from './WatchdogClient.js';
-const MS_PER_DAY = 24 * 60 * 60 * 1000;
-function detectOsType() {
-    switch (process.platform) {
-        case 'win32':
-            return OsType.OS_TYPE_WINDOWS;
-        case 'darwin':
-            return OsType.OS_TYPE_MACOS;
-        case 'linux':
-            return OsType.OS_TYPE_LINUX;
-        default:
-            return OsType.OS_TYPE_UNSPECIFIED;
-    }
-}
-export class ClearcutLogger {
-    #persistence;
-    #watchdog;
-    constructor(options) {
-        this.#persistence = options.persistence ?? new FilePersistence();
-        this.#watchdog =
-            options.watchdogClient ??
-                new WatchdogClient({
-                    parentPid: process.pid,
-                    appVersion: options.appVersion,
-                    osType: detectOsType(),
-                    logFile: options.logFile,
-                    clearcutEndpoint: options.clearcutEndpoint,
-                    clearcutForceFlushIntervalMs: options.clearcutForceFlushIntervalMs,
-                    clearcutIncludePidHeader: options.clearcutIncludePidHeader,
-                });
-    }
-    async logToolInvocation(args) {
-        this.#watchdog.send({
-            type: WatchdogMessageType.LOG_EVENT,
-            payload: {
-                tool_invocation: {
-                    tool_name: args.toolName,
-                    success: args.success,
-                    latency_ms: args.latencyMs,
-                },
-            },
-        });
-    }
-    async logServerStart(flagUsage) {
-        this.#watchdog.send({
-            type: WatchdogMessageType.LOG_EVENT,
-            payload: {
-                server_start: {
-                    flag_usage: flagUsage,
-                },
-            },
-        });
-    }
-    async logDailyActiveIfNeeded() {
-        try {
-            const state = await this.#persistence.loadState();
-            if (this.#shouldLogDailyActive(state)) {
-                let daysSince = -1;
-                if (state.lastActive) {
-                    const lastActiveDate = new Date(state.lastActive);
-                    const now = new Date();
-                    const diffTime = Math.abs(now.getTime() - lastActiveDate.getTime());
-                    daysSince = Math.ceil(diffTime / MS_PER_DAY);
-                }
-                this.#watchdog.send({
-                    type: WatchdogMessageType.LOG_EVENT,
-                    payload: {
-                        daily_active: {
-                            days_since_last_active: daysSince,
-                        },
-                    },
-                });
-                state.lastActive = new Date().toISOString();
-                await this.#persistence.saveState(state);
-            }
-        }
-        catch (err) {
-            logger('Error in logDailyActiveIfNeeded:', err);
-        }
-    }
-    #shouldLogDailyActive(state) {
-        if (!state.lastActive) {
-            return true;
-        }
-        const lastActiveDate = new Date(state.lastActive);
-        const now = new Date();
-        // Compare UTC dates
-        const isSameDay = lastActiveDate.getUTCFullYear() === now.getUTCFullYear() &&
-            lastActiveDate.getUTCMonth() === now.getUTCMonth() &&
-            lastActiveDate.getUTCDate() === now.getUTCDate();
-        return !isSameDay;
-    }
-}

package/build/src/telemetry/WatchdogClient.js

@@ -1,60 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { spawn } from 'node:child_process';
-import { fileURLToPath } from 'node:url';
-import { logger } from '../logger.js';
-export class WatchdogClient {
-    #childProcess;
-    constructor(config, options) {
-        const watchdogPath = fileURLToPath(new URL('./watchdog/main.js', import.meta.url));
-        const args = [
-            watchdogPath,
-            `--parent-pid=${config.parentPid}`,
-            `--app-version=${config.appVersion}`,
-            `--os-type=${config.osType}`,
-        ];
-        if (config.logFile) {
-            args.push(`--log-file=${config.logFile}`);
-        }
-        if (config.clearcutEndpoint) {
-            args.push(`--clearcut-endpoint=${config.clearcutEndpoint}`);
-        }
-        if (config.clearcutForceFlushIntervalMs) {
-            args.push(`--clearcut-force-flush-interval-ms=${config.clearcutForceFlushIntervalMs}`);
-        }
-        if (config.clearcutIncludePidHeader) {
-            args.push('--clearcut-include-pid-header');
-        }
-        const spawner = options?.spawn ?? spawn;
-        this.#childProcess = spawner(process.execPath, args, {
-            stdio: ['pipe', 'ignore', 'ignore'],
-            detached: true,
-        });
-        this.#childProcess.unref();
-        this.#childProcess.on('error', err => {
-            logger('Watchdog process error:', err);
-        });
-        this.#childProcess.on('exit', (code, signal) => {
-            logger(`Watchdog exited with code ${code} and signal ${signal}`);
-        });
-    }
-    send(message) {
-        if (this.#childProcess.stdin &&
-            !this.#childProcess.stdin.destroyed &&
-            this.#childProcess.pid) {
-            try {
-                const line = JSON.stringify(message) + '\n';
-                this.#childProcess.stdin.write(line);
-            }
-            catch (err) {
-                logger('Failed to write to watchdog stdin', err);
-            }
-        }
-        else {
-            logger('Watchdog stdin not available, dropping message');
-        }
-    }
-}

package/build/src/telemetry/flagUtils.js

@@ -1,45 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import { toSnakeCase } from '../utils/string.js';
-/**
- * Computes telemetry flag usage from parsed arguments and CLI options.
- *
- * Iterates over the defined CLI options to construct a payload:
- * - Flag names are converted to snake_case (e.g. `browserUrl` -> `browser_url`).
- * - A flag is logged as `{flag_name}_present` if:
- *    - It has no default value, OR
- *    - The provided value differs from the default value.
- * - Boolean flags are logged with their literal value.
- * - String flags with defined `choices` (Enums) are logged as their uppercase value.
- */
-export function computeFlagUsage(args, options) {
-    const usage = {};
-    for (const [flagName, config] of Object.entries(options)) {
-        const value = args[flagName];
-        const snakeCaseName = toSnakeCase(flagName);
-        // If there isn't a default value provided for the flag,
-        // we're going to log whether it's present on the args user
-        // provided or not. If there is a default value, we only log presence
-        // if the value differs from the default, implying explicit user intent.
-        if (!('default' in config) || value !== config.default) {
-            usage[`${snakeCaseName}_present`] = value !== undefined && value !== null;
-        }
-        if (config.type === 'boolean' && typeof value === 'boolean') {
-            // For boolean options, we're going to log the value directly.
-            usage[snakeCaseName] = value;
-        }
-        else if (config.type === 'string' &&
-            typeof value === 'string' &&
-            'choices' in config &&
-            config.choices) {
-            // For enums, log the value as uppercase
-            // We're going to have an enum for such flags with choices represented
-            // as an `enum` where the keys of the enum will map to the uppercase `choice`.
-            usage[snakeCaseName] = `${snakeCaseName}_${value}`.toUpperCase();
-        }
-    }
-    return usage;
-}

package/build/src/telemetry/metricUtils.js

@@ -1,14 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-const LATENCY_BUCKETS = [50, 100, 250, 500, 1000, 2500, 5000, 10000];
-export function bucketizeLatency(latencyMs) {
-    for (const bucket of LATENCY_BUCKETS) {
-        if (latencyMs <= bucket) {
-            return bucket;
-        }
-    }
-    return LATENCY_BUCKETS[LATENCY_BUCKETS.length - 1];
-}

package/build/src/telemetry/persistence.js

@@ -1,53 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-import fs from 'node:fs/promises';
-import os from 'node:os';
-import path from 'node:path';
-import process from 'node:process';
-import { logger } from '../logger.js';
-const STATE_FILE_NAME = 'telemetry_state.json';
-function getDataFolder() {
-    const homedir = os.homedir();
-    const { env } = process;
-    const name = 'chrome-devtools-mcp';
-    if (process.platform === 'darwin') {
-        return path.join(homedir, 'Library', 'Application Support', name);
-    }
-    if (process.platform === 'win32') {
-        const localAppData = env.LOCALAPPDATA || path.join(homedir, 'AppData', 'Local');
-        return path.join(localAppData, name, 'Data');
-    }
-    return path.join(env.XDG_DATA_HOME || path.join(homedir, '.local', 'share'), name);
-}
-export class FilePersistence {
-    #dataFolder;
-    constructor(dataFolderOverride) {
-        this.#dataFolder = dataFolderOverride ?? getDataFolder();
-    }
-    async loadState() {
-        try {
-            const filePath = path.join(this.#dataFolder, STATE_FILE_NAME);
-            const content = await fs.readFile(filePath, 'utf-8');
-            return JSON.parse(content);
-        }
-        catch {
-            return {
-                lastActive: '',
-            };
-        }
-    }
-    async saveState(state) {
-        const filePath = path.join(this.#dataFolder, STATE_FILE_NAME);
-        try {
-            await fs.mkdir(this.#dataFolder, { recursive: true });
-            await fs.writeFile(filePath, JSON.stringify(state, null, 2), 'utf-8');
-        }
-        catch (error) {
-            // Ignore errors during state saving to avoid crashing the server
-            logger(`Failed to save telemetry state to ${filePath}:`, error);
-        }
-    }
-}

package/build/src/telemetry/types.js

@@ -1,33 +0,0 @@
-/**
- * @license
- * Copyright 2026 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-// Enums
-export var OsType;
-(function (OsType) {
-    OsType[OsType["OS_TYPE_UNSPECIFIED"] = 0] = "OS_TYPE_UNSPECIFIED";
-    OsType[OsType["OS_TYPE_WINDOWS"] = 1] = "OS_TYPE_WINDOWS";
-    OsType[OsType["OS_TYPE_MACOS"] = 2] = "OS_TYPE_MACOS";
-    OsType[OsType["OS_TYPE_LINUX"] = 3] = "OS_TYPE_LINUX";
-})(OsType || (OsType = {}));
-export var ChromeChannel;
-(function (ChromeChannel) {
-    ChromeChannel[ChromeChannel["CHROME_CHANNEL_UNSPECIFIED"] = 0] = "CHROME_CHANNEL_UNSPECIFIED";
-    ChromeChannel[ChromeChannel["CHROME_CHANNEL_CANARY"] = 1] = "CHROME_CHANNEL_CANARY";
-    ChromeChannel[ChromeChannel["CHROME_CHANNEL_DEV"] = 2] = "CHROME_CHANNEL_DEV";
-    ChromeChannel[ChromeChannel["CHROME_CHANNEL_BETA"] = 3] = "CHROME_CHANNEL_BETA";
-    ChromeChannel[ChromeChannel["CHROME_CHANNEL_STABLE"] = 4] = "CHROME_CHANNEL_STABLE";
-})(ChromeChannel || (ChromeChannel = {}));
-export var McpClient;
-(function (McpClient) {
-    McpClient[McpClient["MCP_CLIENT_UNSPECIFIED"] = 0] = "MCP_CLIENT_UNSPECIFIED";
-    McpClient[McpClient["MCP_CLIENT_CLAUDE_CODE"] = 1] = "MCP_CLIENT_CLAUDE_CODE";
-    McpClient[McpClient["MCP_CLIENT_GEMINI_CLI"] = 2] = "MCP_CLIENT_GEMINI_CLI";
-})(McpClient || (McpClient = {}));
-// IPC types for messages between the main process and the
-// telemetry watchdog process.
-export var WatchdogMessageType;
-(function (WatchdogMessageType) {
-    WatchdogMessageType["LOG_EVENT"] = "log-event";
-})(WatchdogMessageType || (WatchdogMessageType = {}));