Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ for PR and commit titles.

## Installation

Check that you are using node version specified in .nvmrc, then run following commands:
Check that you are using the Node.js version specified in `.nvmrc`, then run the following commands:

```sh
git clone https://github.com/ChromeDevTools/chrome-devtools-mcp.git
Expand All @@ -48,6 +48,12 @@ npm ci
npm run build
```

If you're using [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager), you can automatically use the correct version:

```sh
nvm use
```

### Testing with @modelcontextprotocol/inspector

```sh
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,20 +486,20 @@ the browser is closed.

By default, the Chrome DevTools MCP server will start a new Chrome instance with a dedicated profile. This might not be ideal in all situations:

- If you would like to maintain the same application state when alternating between manual site testing and agent-driven testing.
- If you want to maintain the same application state when alternating between manual site testing and agent-driven testing.
- When the MCP needs to sign into a website. Some accounts may prevent sign-in when the browser is controlled via WebDriver (the default launch mechanism for the Chrome DevTools MCP server).
- If you're running your LLM inside a sandboxed environment, but you would like to connect to a Chrome instance that runs outside the sandbox.
- If you're running your LLM inside a sandboxed environment, but you want to connect to a Chrome instance that runs outside the sandbox.

In these cases, start Chrome first and let the Chrome DevTools MCP server connect to it. There are two ways to do so:

- **Automatic connection (available in Chrome 144)**: best for sharing state between manual and agent-driven testing.
- **Manual connection via remote debugging port**: best when running inside a sandboxed environment.
- **Automatic connection (requires Chrome 145+)**: Best for sharing state between manual and agent-driven testing. Requires minimal setup.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not correct, the feature was merged back to the 144 release branch.

- **Manual connection via remote debugging port**: Best when running inside a sandboxed environment or when you need full control over the Chrome instance.

#### Automatically connecting to a running Chrome instance

**Step 1:** Set up remote debugging in Chrome

In Chrome (\>= M144), do the following to set up remote debugging:
In Chrome (>= 145), do the following to set up remote debugging:

1. Navigate to `chrome://inspect/#remote-debugging` to enable remote debugging.
2. Follow the dialog UI to allow or disallow incoming debugging connections.
Expand All @@ -522,8 +522,7 @@ The following code snippet is an example configuration for gemini-cli:
}
```

Note: you have to specify `--channel=beta` until Chrome M144 has reached the
stable channel.
Note: As of December 2024, Chrome 145 is in the stable channel. If you're using an older Chrome version, you may need to specify `--channel=beta` or `--channel=canary` to use a development version that supports this feature.

**Step 3:** Test your setup

Expand Down