Skip to content

Commit a9fc863

Browse files
OrKoNsebastianbenz
andauthored
docs: add troubleshooting.md (#226)
starting a doc with troubleshooting tips --------- Co-authored-by: Sebastian Benz <[email protected]>
1 parent 1649336 commit a9fc863

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ control and inspect a live Chrome browser. It acts as a Model-Context-Protocol
77
(MCP) server, giving your AI coding assistant access to the full power of
88
Chrome DevTools for reliable automation, in-depth debugging, and performance analysis.
99

10+
## [Tool reference](./docs/tool-reference.md) | [Changelog](./CHANGELOG.md) | [Contributing](./CONTRIBUTING.md) | [Troubleshooting](./docs/troubleshooting.md)
11+
1012
## Key features
1113

1214
- **Get performance insights**: Uses [Chrome
@@ -198,6 +200,8 @@ Your MCP client should open the browser and record a performance trace.
198200
199201
## Tools
200202

203+
If you run into any issues, checkout our [troubleshooting guide](./docs/troubleshooting.md).
204+
201205
<!-- BEGIN AUTO GENERATED TOOLS -->
202206

203207
- **Input automation** (7 tools)

docs/troubleshooting.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Troubleshooting
2+
3+
## General tips
4+
5+
- Run `npx chrome-devtools-mcp@latest --help` to test if the MCP server runs on your machine.
6+
- Make sure that your MCP client uses the same npm and node version as your terminal.
7+
- When configuring your MCP client, try using the `--yes` argument to `npx` to
8+
auto-accept installation prompt.
9+
- Find a specific error in the output of the `chrome-devtools-mcp` server.
10+
Usually, if you client is an IDE, logs would be in the Output pane.
11+
12+
## Specific problems
13+
14+
### `Error [ERR_MODULE_NOT_FOUND]: Cannot find module ...`
15+
16+
This usually indicates either a non-supported Node version is in use or that the
17+
`npm`/`npx` cache is corrupted. Try clearing the cache, uninstalling
18+
`chrome-devtools-mcp` and installing it again. Clear the cache by running:
19+
20+
```sh
21+
rm -rf ~/.npm/_npx # NOTE: this might remove other installed npx executables.
22+
npm cache clean --force
23+
```
24+
25+
### `Target closed` error
26+
27+
This indicates that the browser could not be started. Make sure that no Chrome
28+
instances are running or close them. Make sure you have the latest stable Chrome
29+
installed and that [your system is able to run Chrome](https://support.google.com/chrome/a/answer/7100626?hl=en).

0 commit comments

Comments
 (0)