Skip to content

Commit 9236834

Browse files
authored
docs: fix skill and reference documentation issues (#1249)
## Summary This PR fixes several documentation and skill-reference issues across the repo to improve accuracy and reduce confusion in implementation and troubleshooting workflows. ## Changes - corrected CLI examples in skill docs - fixed the documented argument order for `performance_analyze_insight` - updated the memory leak fallback script path - corrected generated tool reference wording by updating the source-of-truth tool descriptions --------- Co-authored-by: ojonesjr <50652264+ojonesjr@users.noreply.github.com>
1 parent 0755ebf commit 9236834

12 files changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Avoid sharing sensitive or personal information that you don't want to share wit
2828
MCP clients.
2929

3030
`chrome-devtools-mcp` officially supports Google Chrome and [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) only.
31-
Other Chromium-based browser may work, but this is not guaranteed, and you may encounter unexpected behavior. Use at your own discretion.
31+
Other Chromium-based browsers may work, but this is not guaranteed, and you may encounter unexpected behavior. Use at your own discretion.
3232
We are committed to providing fixes and support for the latest version of [Extended Stable Chrome](https://chromiumdash.appspot.com/schedule).
3333

3434
Performance tools may send trace URLs to the Google CrUX API to fetch real-user
@@ -506,7 +506,7 @@ The Chrome DevTools MCP server supports the following configuration option:
506506
<!-- BEGIN AUTO GENERATED OPTIONS -->
507507

508508
- **`--autoConnect`/ `--auto-connect`**
509-
If specified, automatically connects to a browser (Chrome 144+) running locally from the user data directory identified by the channel param (default channel is stable). Requires the remoted debugging server to be started in the Chrome instance via chrome://inspect/#remote-debugging.
509+
If specified, automatically connects to a browser (Chrome 144+) running locally from the user data directory identified by the channel param (default channel is stable). Requires the remote debugging server to be started in the Chrome instance via chrome://inspect/#remote-debugging.
510510
- **Type:** boolean
511511
- **Default:** `false`
512512

docs/tool-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- AUTO GENERATED DO NOT EDIT - run 'npm run gen' to update-->
22

3-
# Chrome DevTools MCP Tool Reference (~6949 cl100k_base tokens)
3+
# Chrome DevTools MCP Tool Reference (~6951 cl100k_base tokens)
44

55
- **[Input automation](#input-automation)** (9 tools)
66
- [`click`](#click)
@@ -66,7 +66,7 @@
6666

6767
### `fill`
6868

69-
**Description:** Type text into a input, text area or select an option from a &lt;select&gt; element.
69+
**Description:** Type text into an input, text area or select an option from a &lt;select&gt; element.
7070

7171
**Parameters:**
7272

@@ -223,7 +223,7 @@
223223

224224
- **colorScheme** (enum: "dark", "light", "auto") _(optional)_: [`Emulate`](#emulate) the dark or the light mode. Set to "auto" to reset to the default.
225225
- **cpuThrottlingRate** (number) _(optional)_: Represents the CPU slowdown factor. Omit or set the rate to 1 to disable throttling
226-
- **geolocation** (string) _(optional)_: Geolocation (`&lt;latitude&gt;x&lt;longitude&gt;`) to [`emulate`](#emulate). Latitude between -90 and 90. Longitude between -180 and 180. Omit clear the geolocation override.
226+
- **geolocation** (string) _(optional)_: Geolocation (`&lt;latitude&gt;x&lt;longitude&gt;`) to [`emulate`](#emulate). Latitude between -90 and 90. Longitude between -180 and 180. Omit to clear the geolocation override.
227227
- **networkConditions** (enum: "Offline", "Slow 3G", "Fast 3G", "Slow 4G", "Fast 4G") _(optional)_: Throttle network. Omit to disable throttling.
228228
- **userAgent** (string) _(optional)_: User agent to [`emulate`](#emulate). Set to empty string to clear the user agent override.
229229
- **viewport** (string) _(optional)_: [`Emulate`](#emulate) device viewports '&lt;width&gt;x&lt;height&gt;x&lt;devicePixelRatio&gt;[,mobile][,touch][,landscape]'. 'touch' and 'mobile' to [`emulate`](#emulate) mobile devices. 'landscape' to [`emulate`](#emulate) landscape mode.
@@ -366,7 +366,7 @@ so returned values have to be JSON-serializable.
366366

367367
- **includePreservedMessages** (boolean) _(optional)_: Set to true to return the preserved messages over the last 3 navigations.
368368
- **pageIdx** (integer) _(optional)_: Page number to return (0-based). When omitted, returns the first page.
369-
- **pageSize** (integer) _(optional)_: Maximum number of messages to return. When omitted, returns all requests.
369+
- **pageSize** (integer) _(optional)_: Maximum number of messages to return. When omitted, returns all messages.
370370
- **types** (array) _(optional)_: Filter messages to only return messages of the specified resource types. When omitted or empty, returns all messages.
371371

372372
---
@@ -381,7 +381,7 @@ so returned values have to be JSON-serializable.
381381
- **format** (enum: "png", "jpeg", "webp") _(optional)_: Type of format to save the screenshot as. Default is "png"
382382
- **fullPage** (boolean) _(optional)_: If set to true takes a screenshot of the full page instead of the currently visible viewport. Incompatible with uid.
383383
- **quality** (number) _(optional)_: Compression quality for JPEG and WebP formats (0-100). Higher values mean better quality but larger file sizes. Ignored for PNG format.
384-
- **uid** (string) _(optional)_: The uid of an element on the page from the page content snapshot. If omitted takes a pages screenshot.
384+
- **uid** (string) _(optional)_: The uid of an element on the page from the page content snapshot. If omitted, takes a page screenshot.
385385

386386
---
387387

docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Possible workarounds include:
9898
3. Start `chrome-devtools-mcp` with:
9999
`npx chrome-devtools-mcp --browser-url http://127.0.0.1:9222`
100100

101-
- **Use Powershell or Git Bash** instead of WSL.
101+
- **Use PowerShell or Git Bash** instead of WSL.
102102

103103
### Windows 10: Error during discovery for MCP server 'chrome-devtools': MCP error -32000: Connection closed
104104

skills/chrome-devtools-cli/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: chrome-devtools-cli
3-
description: Use this to skill to write shell scripts or run shell commands to automate tasks in the browser or otherwise use Chrome DevTools via CLI.
3+
description: Use this skill to write shell scripts or run shell commands to automate tasks in the browser or otherwise use Chrome DevTools via CLI.
44
---
55

66
The `chrome-devtools-mcp` CLI lets you interact with the browser from your terminal.
@@ -74,7 +74,7 @@ chrome-devtools select_page 1 --bringToFront true # Select a page and bring it t
7474

7575
```bash
7676
chrome-devtools emulate --networkConditions "Offline" # Emulate network conditions
77-
chrome-devtools emulate --cpuThrottlingRate 4 --geolocation "0,0" # Emulate CPU throttling and geolocation
77+
chrome-devtools emulate --cpuThrottlingRate 4 --geolocation "0x0" # Emulate CPU throttling and geolocation
7878
chrome-devtools emulate --colorScheme "dark" --viewport "1920x1080" # Emulate color scheme and viewport
7979
chrome-devtools emulate --userAgent "Mozilla/5.0..." # Emulate user agent
8080
chrome-devtools resize_page 1920 1080 # Resizes the selected page's window
@@ -107,7 +107,7 @@ chrome-devtools list_network_requests --includePreservedRequests true # Include
107107

108108
```bash
109109
chrome-devtools evaluate_script "() => document.title" # Evaluate a JavaScript function on the page
110-
evaluate_script "(a) => a.innerText" --args 1_4 # Evaluate JS with UID arguments
110+
chrome-devtools evaluate_script "(a) => a.innerText" --args 1_4 # Evaluate JS with UID arguments
111111
chrome-devtools get_console_message 1 # Gets a console message by its ID
112112
chrome-devtools lighthouse_audit --mode "navigation" # Run Lighthouse audit for navigation
113113
chrome-devtools lighthouse_audit --mode "snapshot" --device "mobile" # Run Lighthouse audit for a snapshot on mobile

skills/debug-optimize-lcp/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Use `performance_analyze_insight` to drill into LCP-specific insights. Look for
5050
- **RenderBlocking** — Resources blocking the LCP element from rendering.
5151
- **LCPDiscovery** — Whether the LCP resource was discoverable early.
5252

53-
Call `performance_analyze_insight` with the insight name and the insight set ID from the trace results.
53+
Call `performance_analyze_insight` with the insight set ID and the insight name from the trace results.
5454

5555
### Step 3: Identify the LCP Element
5656

skills/memory-leak-debugging/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If `memlab` is not available, you MUST use the fallback script in the references
4444
Run the script using Node.js:
4545

4646
```bash
47-
node compare_snapshots.js <baseline.heapsnapshot> <target.heapsnapshot>
47+
node skills/memory-leak-debugging/references/compare_snapshots.js <baseline.heapsnapshot> <target.heapsnapshot>
4848
```
4949

5050
The script will analyze and output the top growing objects by size and highlight the 3 most common types of memory leaks (e.g., Detached DOM nodes, closures, Contexts) if they are present.

src/bin/chrome-devtools-mcp-cli-options.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const cliOptions = {
1111
autoConnect: {
1212
type: 'boolean',
1313
description:
14-
'If specified, automatically connects to a browser (Chrome 144+) running locally from the user data directory identified by the channel param (default channel is stable). Requires the remoted debugging server to be started in the Chrome instance via chrome://inspect/#remote-debugging.',
14+
'If specified, automatically connects to a browser (Chrome 144+) running locally from the user data directory identified by the channel param (default channel is stable). Requires the remote debugging server to be started in the Chrome instance via chrome://inspect/#remote-debugging.',
1515
conflicts: ['isolated', 'executablePath', 'categoryExtensions'],
1616
default: false,
1717
coerce: (value: boolean | undefined) => {

src/bin/cliDefinitions.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export const commands: Commands = {
110110
name: 'geolocation',
111111
type: 'string',
112112
description:
113-
'Geolocation (`<latitude>x<longitude>`) to emulate. Latitude between -90 and 90. Longitude between -180 and 180. Omit clear the geolocation override.',
113+
'Geolocation (`<latitude>x<longitude>`) to emulate. Latitude between -90 and 90. Longitude between -180 and 180. Omit to clear the geolocation override.',
114114
required: false,
115115
},
116116
userAgent: {
@@ -159,7 +159,7 @@ export const commands: Commands = {
159159
},
160160
fill: {
161161
description:
162-
'Type text into a input, text area or select an option from a <select> element.',
162+
'Type text into an input, text area or select an option from a <select> element.',
163163
category: 'Input automation',
164164
args: {
165165
uid: {
@@ -305,7 +305,7 @@ export const commands: Commands = {
305305
name: 'pageSize',
306306
type: 'integer',
307307
description:
308-
'Maximum number of messages to return. When omitted, returns all requests.',
308+
'Maximum number of messages to return. When omitted, returns all messages.',
309309
required: false,
310310
},
311311
pageIdx: {
@@ -618,7 +618,7 @@ export const commands: Commands = {
618618
name: 'uid',
619619
type: 'string',
620620
description:
621-
'The uid of an element on the page from the page content snapshot. If omitted takes a pages screenshot.',
621+
'The uid of an element on the page from the page content snapshot. If omitted, takes a page screenshot.',
622622
required: false,
623623
},
624624
fullPage: {

src/tools/console.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export const listConsoleMessages = definePageTool({
5252
.positive()
5353
.optional()
5454
.describe(
55-
'Maximum number of messages to return. When omitted, returns all requests.',
55+
'Maximum number of messages to return. When omitted, returns all messages.',
5656
),
5757
pageIdx: zod
5858
.number()

src/tools/emulation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export const emulate = definePageTool({
4444
.optional()
4545
.transform(geolocationTransform)
4646
.describe(
47-
'Geolocation (`<latitude>x<longitude>`) to emulate. Latitude between -90 and 90. Longitude between -180 and 180. Omit clear the geolocation override.',
47+
'Geolocation (`<latitude>x<longitude>`) to emulate. Latitude between -90 and 90. Longitude between -180 and 180. Omit to clear the geolocation override.',
4848
),
4949
userAgent: zod
5050
.string()

0 commit comments

Comments
 (0)