You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-9Lines changed: 28 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ prototype!
8
8
9
9
`chrome-devtools-mcp` exposes content of the browser instance to the MCP clients
10
10
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
12
12
MCP clients.
13
13
14
14
## Requirements
@@ -33,7 +33,7 @@ Add the following config to your MCP client:
33
33
```
34
34
35
35
> [!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.
37
37
38
38
### MCP Client specific configuration
39
39
@@ -119,7 +119,8 @@ claude mcp add chrome-devtools-mcp npx chrome-devtools-mcp@latest
119
119
120
120
## Configuration
121
121
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:
123
124
124
125
```json
125
126
{
@@ -128,20 +129,22 @@ For example, to launch the system-installed Chrome Canary pass `--channel=canary
128
129
"command": "npx",
129
130
"args": [
130
131
"chrome-devtools-mcp@latest"
132
+
"--browserUrl=http://localhost:8080",
131
133
"--channel=canary",
134
+
"--headless=true",
135
+
"--isolated=true",
132
136
]
133
137
}
134
138
}
135
139
}
136
140
```
137
141
138
-
### User data directory
142
+
The following options are supported when running the Chrome DevTools MCP server from an MCP client:
139
143
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.
145
148
146
149
## CLI
147
150
@@ -174,3 +177,19 @@ Examples:
174
177
```
175
178
176
179
<!-- 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`
0 commit comments