Skip to content

Commit b6386b3

Browse files
natorionOrKoN
authored andcommitted
docs: improve clarity and add a warning to the Chrome DevTools MCP README.
1 parent 11c2ba4 commit b6386b3

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Here is a step-by-step guide on how to connect to a running Chrome Stable instan
336336

337337
**Step 1: Configure the MCP client**
338338

339-
Add the `--browser-url` option to your MCP client configuration. The value of this option should be the URL of the running Chrome instance, including the port number.
339+
Add the `--browser-url` option to your MCP client configuration. The value of this option should be the URL of the running Chrome instance. `http://localhost:9222` is a common default.
340340

341341
```json
342342
{
@@ -354,9 +354,12 @@ Add the `--browser-url` option to your MCP client configuration. The value of th
354354

355355
**Step 2: Start the Chrome browser**
356356

357-
Start the Chrome browser with the remote debugging port enabled. Make sure to close any running Chrome instances before starting a new one with the debugging port enabled.
357+
> [!WARNING]
358+
> Enabling the remote debugging port opens up a debugging port on the running browser instance. Any application on your machine can connect to this port and control the browser. Make sure that you are not browsing any sensitive websites while the debugging port is open.
359+
360+
Start the Chrome browser with the remote debugging port enabled. Make sure to close any running Chrome instances before starting a new one with the debugging port enabled. The port number you choose must be the same as the one you specified in the `--browser-url` option in your MCP client configuration.
358361

359-
For security reasons, Chrome requires you to use a non-default user data directory when enabling the remote debugging port. You can specify a custom directory using the `--user-data-dir` flag. This ensures that your regular browsing profile and data are not exposed to the debugging session.
362+
For security reasons, Chrome requires you to use a non-default user data directory when enabling the remote debugging port. You can specify a custom directory using the `--user-data-dir` flag. This ensures that your regular browsing profile and data are not exposed to the debugging session. Consult [this blog post](https://developer.chrome.com/blog/remote-debugging-port) for more details.
360363

361364
**macOS**
362365

@@ -376,12 +379,15 @@ For security reasons, Chrome requires you to use a non-default user data directo
376379
"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="%TEMP%\chrome-profile-stable"
377380
```
378381

379-
> [!WARNING]
380-
> Enabling the remote debugging port opens up a debugging port on the running browser instance. Any application on your machine can connect to this port and control the browser. Make sure that you are not browsing any sensitive websites while the debugging port is open.
382+
**Step 3: Test your setup**
381383

382-
**Step 3: Ensure the ports are the same**
384+
After configuring the MCP client and starting the Chrome browser, you can test your setup by running a simple prompt in your MCP client:
385+
386+
```
387+
Check the performance of https://developers.chrome.com
388+
```
383389

384-
The port number in the `--browser-url` option in your MCP client configuration must be the same as the port number you used to start the Chrome browser.
390+
Your MCP client should connect to the running Chrome instance and receive a performance report.
385391

386392
For more details on remote debugging, see the [Chrome DevTools documentation](https://developer.chrome.com/docs/devtools/remote-debugging/).
387393

0 commit comments

Comments
 (0)