Skip to content

Commit 38dd346

Browse files
authored
docs: fix showing defaults in configuration (#2234)
closes #2233
1 parent 6225ffb commit 38dd346

2 files changed

Lines changed: 30 additions & 3 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,14 +553,17 @@ The Chrome DevTools MCP server supports the following configuration option:
553553
- **`--browserUrl`/ `--browser-url`, `-u`**
554554
Connect to a running, debuggable Chrome instance (e.g. `http://127.0.0.1:9222`). For more details see: https://github.com/ChromeDevTools/chrome-devtools-mcp#connecting-to-a-running-chrome-instance.
555555
- **Type:** string
556+
- **Default:** `false`
556557

557558
- **`--wsEndpoint`/ `--ws-endpoint`, `-w`**
558559
WebSocket endpoint to connect to a running Chrome instance (e.g., ws://127.0.0.1:9222/devtools/browser/<id>). Alternative to --browserUrl.
559560
- **Type:** string
561+
- **Default:** `false`
560562

561563
- **`--wsHeaders`/ `--ws-headers`**
562564
Custom headers for WebSocket connection in JSON format (e.g., '{"Authorization":"Bearer token"}'). Only works with --wsEndpoint.
563565
- **Type:** string
566+
- **Default:** `false`
564567

565568
- **`--headless`**
566569
Whether to run in headless (no UI) mode.
@@ -570,87 +573,108 @@ The Chrome DevTools MCP server supports the following configuration option:
570573
- **`--executablePath`/ `--executable-path`, `-e`**
571574
Path to custom Chrome executable.
572575
- **Type:** string
576+
- **Default:** `false`
573577

574578
- **`--isolated`**
575579
If specified, creates a temporary user-data-dir that is automatically cleaned up after the browser is closed. Defaults to false.
576580
- **Type:** boolean
581+
- **Default:** `false`
577582

578583
- **`--userDataDir`/ `--user-data-dir`**
579584
Path to the user data directory for Chrome. Default is $HOME/.cache/chrome-devtools-mcp/chrome-profile$CHANNEL_SUFFIX_IF_NON_STABLE
580585
- **Type:** string
586+
- **Default:** `false`
581587

582588
- **`--channel`**
583589
Specify a different Chrome channel that should be used. The default is the stable channel version.
584590
- **Type:** string
585591
- **Choices:** `canary`, `dev`, `beta`, `stable`
592+
- **Default:** `false`
586593

587594
- **`--logFile`/ `--log-file`**
588595
Path to a file to write debug logs to. Set the env variable `DEBUG` to `*` to enable verbose logs. Useful for submitting bug reports.
589596
- **Type:** string
597+
- **Default:** `false`
590598

591599
- **`--viewport`**
592600
Initial viewport size for the Chrome instances started by the server. For example, `1280x720`. In headless mode, max size is 3840x2160px.
593601
- **Type:** string
602+
- **Default:** `false`
594603

595604
- **`--proxyServer`/ `--proxy-server`**
596605
Proxy server configuration for Chrome passed as --proxy-server when launching the browser. See https://www.chromium.org/developers/design-documents/network-settings/ for details.
597606
- **Type:** string
607+
- **Default:** `false`
598608

599609
- **`--acceptInsecureCerts`/ `--accept-insecure-certs`**
600610
If enabled, ignores errors relative to self-signed and expired certificates. Use with caution.
601611
- **Type:** boolean
612+
- **Default:** `false`
602613

603614
- **`--experimentalPageIdRouting`/ `--experimental-page-id-routing`**
604615
Whether to expose pageId on page-scoped tools and route requests by page ID (useful for concurrent agent sessions).
605616
- **Type:** boolean
617+
- **Default:** `false`
606618

607619
- **`--experimentalDevtools`/ `--experimental-devtools`**
608620
Whether to enable automation over DevTools targets
609621
- **Type:** boolean
622+
- **Default:** `false`
610623

611624
- **`--experimentalVision`/ `--experimental-vision`**
612625
Whether to enable coordinate-based tools such as click_at(x,y). Usually requires a computer-use model able to produce accurate coordinates by looking at screenshots.
613626
- **Type:** boolean
627+
- **Default:** `false`
614628

615629
- **`--memoryDebugging`/ `--memory-debugging`, `-experimentalMemory`**
616630
Whether to enable memory debugging tools.
617631
- **Type:** boolean
632+
- **Default:** `false`
618633

619634
- **`--experimentalStructuredContent`/ `--experimental-structured-content`**
620635
Whether to output structured formatted content.
621636
- **Type:** boolean
637+
- **Default:** `false`
622638

623639
- **`--experimentalIncludeAllPages`/ `--experimental-include-all-pages`**
624640
Whether to include all kinds of pages such as webviews or background pages as pages.
625641
- **Type:** boolean
642+
- **Default:** `false`
626643

627644
- **`--experimentalScreencast`/ `--experimental-screencast`**
628645
Exposes experimental screencast tools (requires ffmpeg). Install ffmpeg https://www.ffmpeg.org/download.html and ensure it is available in the MCP server PATH.
629646
- **Type:** boolean
647+
- **Default:** `false`
630648

631649
- **`--experimentalFfmpegPath`/ `--experimental-ffmpeg-path`**
632650
Path to ffmpeg executable for screencast recording.
633651
- **Type:** string
652+
- **Default:** `false`
634653

635654
- **`--categoryExperimentalWebmcp`/ `--category-experimental-webmcp`**
636655
Set to true to enable debugging WebMCP tools. Requires Chrome 149+ with the following flags: `--enable-features=WebMCP,DevToolsWebMCPSupport`
637656
- **Type:** boolean
657+
- **Default:** `false`
638658

639659
- **`--chromeArg`/ `--chrome-arg`**
640660
Additional arguments for Chrome. Only applies when Chrome is launched by chrome-devtools-mcp.
641661
- **Type:** array
662+
- **Default:** `false`
642663

643664
- **`--blockedUrlPattern`/ `--blocked-url-pattern`**
644665
Restricts network access by blocking specified URL patterns (uses https://urlpattern.spec.whatwg.org/). Silently detaches from targets with blocked URLs upon connection, and blocks runtime requests (including navigations and subresources). Accepts an array of patterns.
645666
- **Type:** array
667+
- **Default:** `false`
646668

647669
- **`--allowedUrlPattern`/ `--allowed-url-pattern`**
648670
Restricts network access by allowing only specified URL patterns (uses https://urlpattern.spec.whatwg.org/). Requires Chrome 149+. Silently detaches from targets with unallowed URLs upon connection, and blocks runtime requests (including navigations and subresources). Accepts an array of patterns.
649671
- **Type:** array
672+
- **Default:** `false`
650673

651674
- **`--ignoreDefaultChromeArg`/ `--ignore-default-chrome-arg`**
652675
Explicitly disable default arguments for Chrome. Only applies when Chrome is launched by chrome-devtools-mcp.
653676
- **Type:** array
677+
- **Default:** `false`
654678

655679
- **`--categoryEmulation`/ `--category-emulation`**
656680
Set to false to exclude tools related to emulation.
@@ -691,22 +715,27 @@ The Chrome DevTools MCP server supports the following configuration option:
691715
Override the default output format used by take_screenshot when the caller does not specify one. JPEG and WebP are ~3-5x smaller than PNG, which helps reduce context size in AI conversations. Unset preserves the existing default ("png").
692716
- **Type:** string
693717
- **Choices:** `jpeg`, `png`, `webp`
718+
- **Default:** `false`
694719

695720
- **`--screenshotQuality`/ `--screenshot-quality`**
696721
Override the default compression quality (0-100) used by take_screenshot for JPEG and WebP when the caller does not specify one. Lower values mean smaller files. Ignored for PNG. Unset preserves the Puppeteer default.
697722
- **Type:** number
723+
- **Default:** `false`
698724

699725
- **`--screenshotMaxWidth`/ `--screenshot-max-width`**
700726
Maximum width in pixels for screenshots. If the captured image is wider, it is downscaled (preserving aspect ratio) before being returned. Reduces context size in AI conversations. Unset means no resize.
701727
- **Type:** number
728+
- **Default:** `false`
702729

703730
- **`--screenshotMaxHeight`/ `--screenshot-max-height`**
704731
Maximum height in pixels for screenshots. If the captured image is taller, it is downscaled (preserving aspect ratio) before being returned. Can be combined with --screenshot-max-width; the smaller scale factor wins. Unset means no resize.
705732
- **Type:** number
733+
- **Default:** `false`
706734

707735
- **`--slim`**
708736
Exposes a "slim" set of 3 tools covering navigation, script execution and screenshots only. Useful for basic browser tasks.
709737
- **Type:** boolean
738+
- **Default:** `false`
710739

711740
- **`--redactNetworkHeaders`/ `--redact-network-headers`**
712741
If true, redacts some of the network headers considered sensitive before returning to the client.

scripts/generate-docs.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,7 @@ function generateConfigOptionsMarkdown(): string {
185185
}
186186

187187
// Add default if available
188-
if (optionConfig.default !== undefined) {
189-
markdown += ` - **Default:** \`${optionConfig.default}\`\n`;
190-
}
188+
markdown += ` - **Default:** \`${optionConfig.default ?? 'false'}\`\n`;
191189

192190
markdown += '\n';
193191
}

0 commit comments

Comments
 (0)