Skip to content

Commit ea44ea2

Browse files
committed
Polish readme
* add configuration section * move user-data-dir to new concepts section
1 parent 31a0bdc commit ea44ea2

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ prototype!
88

99
`chrome-devtools-mcp` exposes content of the browser instance to the MCP clients
1010
allowing them to inspect, debug, and modify any data in the browser or DevTools.
11-
Avoid sharing sensitive or personal information that you do want to share with
11+
Avoid sharing sensitive or personal information that you don't want to share with
1212
MCP clients.
1313

1414
## Requirements
@@ -33,7 +33,7 @@ Add the following config to your MCP client:
3333
```
3434

3535
> [!NOTE]
36-
> `Using `chrome-devtools-mcp@latest` ensures that your MCP client will always use the latest version of the Chrome DevTools MCP server.
36+
> Using `chrome-devtools-mcp@latest` ensures that your MCP client will always use the latest version of the Chrome DevTools MCP server.
3737
3838
### MCP Client specific configuration
3939

@@ -119,7 +119,8 @@ claude mcp add chrome-devtools-mcp npx chrome-devtools-mcp@latest
119119

120120
## Configuration
121121

122-
For example, to launch the system-installed Chrome Canary pass `--channel=canary` as an argument:
122+
The Chrome DevTools MCP server supports the following configuration option. Pass them via the `args` property
123+
in the JSON configuration. For example:
123124

124125
```json
125126
{
@@ -128,20 +129,22 @@ For example, to launch the system-installed Chrome Canary pass `--channel=canary
128129
"command": "npx",
129130
"args": [
130131
"chrome-devtools-mcp@latest"
132+
"--browserUrl=http://localhost:8080",
131133
"--channel=canary",
134+
"--headless=true",
135+
"--isolated=true",
132136
]
133137
}
134138
}
135139
}
136140
```
137141

138-
### User data directory
142+
The following options are supported when running the Chrome DevTools MCP server from an MCP client:
139143

140-
`chrome-devtools-mcp` starts a Chrome's stable channel instance using the user
141-
data directory at `$HOME/.cache/chrome-devtools-mcp/mcp-profile-$CHANNEL` on
142-
Linux/MacOS and `%HOMEPATH%/.cache/chrome-devtools-mcp/mcp-profile-$CHANNEL` in
143-
Windows. The user data directory is not cleared between runs and shared across
144-
all instances of `chrome-devtools-mcp`.
144+
* **browserUrl**: Connect to a running Chrome instance using [port forwarding](https://developer.chrome.com/docs/devtools/remote-debugging/local-server).
145+
* **channel**: By default the Chrome MCP Server will run the stable version of Chrome. Use this option to use the `canary`, `beta` or `dev` channel version instead.
146+
* **headless**: Set to `true` if the browser should be run in headless mode without UI. The default is `false`.
147+
* **isolated**: Set to `true` if you want to always start the browser with a clean user profile in a temporary `user-data-dir`. The directory will be cleaned up when closing the browser. The default is `false`. See the [user data directory section](#user-data-directory) for more details.
145148

146149
## CLI
147150

@@ -174,3 +177,19 @@ Examples:
174177
```
175178

176179
<!-- END AUTO GENERATED CLI -->
180+
181+
## Concepts
182+
183+
### User data directory
184+
185+
`chrome-devtools-mcp` starts a Chrome's stable channel instance using the following user
186+
data directory:
187+
188+
* Linux / MacOS: `$HOME/.cache/chrome-devtools-mcp/mcp-profile-$CHANNEL`
189+
* Window: `%HOMEPATH%/.cache/chrome-devtools-mcp/mcp-profile-$CHANNEL`
190+
191+
The user data directory is not cleared between runs and shared across
192+
all instances of `chrome-devtools-mcp`. Set the `isolated` option to `true`
193+
to use a temporary user data dir instead which will be cleared automatically after
194+
the browser is closed.
195+

0 commit comments

Comments
 (0)