豆豆友情提示:这是一个非官方 GitHub 代理镜像,主要用于网络测试或访问加速。请勿在此进行登录、注册或处理任何敏感信息。进行这些操作请务必访问官方网站 github.com。 Raw 内容也通过此代理提供。
Skip to content

Commit 7273f16

Browse files
authored
feat: Add skill which helps with onboarding of the mcp server (#1083)
- **feat: add troubleshooting skill definition and expand documentation with details on autoConnect timeouts and extension debugging conflicts.** - **docs: Simplify troubleshooting skill instructions by removing explicit tool mentions and updating the troubleshooting guide link.** - **docs: Update troubleshooting guide to recommend and correct usage of `--logFile` for capturing debug logs.** - **docs: Enhance troubleshooting guide with 'Tool not found' error, `--autoConnect` Chrome 144+ requirement, and `startup_timeout_ms` tip for Windows.** - **docs: Clarify that Chrome 144+ must be running for `--autoConnect` and add a verification step for remote debugging.** - **feat: Add an initial troubleshooting step to read and interpret MCP configuration, renumbering subsequent steps.** - **docs: Add detailed troubleshooting steps for `Could not find DevToolsActivePort` and other common connection errors.** - **docs: Add troubleshooting guidance for empty profile creation due to typos or misconfiguration.**
1 parent b5b9a77 commit 7273f16

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed

docs/troubleshooting.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
auto-accept installation prompt.
99
- Find a specific error in the output of the `chrome-devtools-mcp` server.
1010
Usually, if your client is an IDE, logs would be in the Output pane.
11+
- Search the [GitHub repository issues and discussions](https://github.com/ChromeDevTools/chrome-devtools-mcp) for help or existing similar problems.
1112

1213
## Debugging
1314

@@ -98,3 +99,12 @@ Possible workarounds include:
9899
`npx chrome-devtools-mcp --browser-url http://127.0.0.1:9222`
99100

100101
- **Use Powershell or Git Bash** instead of WSL.
102+
103+
### Connection timeouts with `--autoConnect`
104+
105+
If you are using the `--autoConnect` flag and tools like `list_pages`, `new_page`, or `navigate_page` fail with a timeout (e.g., `ProtocolError: Network.enable timed out` or `The socket connection was closed unexpectedly`), this usually means the MCP server cannot handshake with the running Chrome instance correctly. Ensure:
106+
107+
1. Chrome 144+ is **already** running.
108+
2. Remote debugging is enabled in Chrome via `chrome://inspect/#remote-debugging`.
109+
3. You have allowed the remote debugging connection prompt in the browser.
110+
4. There is no other MCP server or tool trying to connect to the same debugging port.

skills/troubleshooting/SKILL.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
name: troubleshooting
3+
description: Uses Chrome DevTools MCP and documentation to troubleshoot connection and target issues. Trigger this skill when list_pages, new_page, or navigate_page fail, or when the server initialization fails.
4+
---
5+
6+
## Troubleshooting Wizard
7+
8+
You are acting as a troubleshooting wizard to help the user configure and fix their Chrome DevTools MCP server setup. When this skill is triggered (e.g., because `list_pages`, `new_page`, or `navigate_page` failed, or the server wouldn't start), follow this step-by-step diagnostic process:
9+
10+
### Step 1: Find and Read Configuration
11+
12+
Your first action should be to locate and read the MCP configuration file. Search for the following files in the user's workspace: `.mcp.json`, `gemini-extension.json`, `.claude/settings.json`, `.vscode/launch.json`, or `.gemini/settings.json`.
13+
14+
If you find a configuration file, read and interpret it to identify potential issues such as:
15+
16+
- Incorrect arguments or flags.
17+
- Missing environment variables.
18+
- Usage of `--autoConnect` in incompatible environments.
19+
20+
If you cannot find any of these files, only then should you ask the user to provide their configuration file content.
21+
22+
### Step 2: Triage Common Connection Errors
23+
24+
Before reading documentation or suggesting configuration changes, check if the error message matches one of the following common patterns.
25+
26+
#### Error: `Could not find DevToolsActivePort`
27+
28+
This error is highly specific to the `--autoConnect` feature. It means the MCP server cannot find the file created by a running, debuggable Chrome instance. This is not a generic connection failure.
29+
30+
Your primary goal is to guide the user to ensure Chrome is running and properly configured. Do not immediately suggest switching to `--browserUrl`. Follow this exact sequence:
31+
32+
1. **Ask the user to confirm that the correct Chrome version** (e.g., "Chrome Canary" if the error mentions it) is currently running.
33+
2. **If the user confirms it is running, instruct them to enable remote debugging.** Be very specific about the URL and the action: "Please open a new tab in Chrome, navigate to `chrome://inspect/#remote-debugging`, and make sure the 'Enable remote debugging' checkbox is checked."
34+
3. **Once the user confirms both steps, your only next action should be to call the `list_pages` tool.** This is the simplest and safest way to verify if the connection is now successful. Do not retry the original, more complex command yet.
35+
4. **If `list_pages` succeeds, the problem is resolved.** If it still fails with the same error, then you can proceed to the more advanced steps like suggesting `--browserUrl` or checking for sandboxing issues.
36+
37+
#### Symptom: Server starts but creates a new empty profile
38+
39+
If the server starts successfully but `list_pages` returns an empty list or creates a new profile instead of connecting to the existing Chrome instance, check for typos in the arguments.
40+
41+
- **Check for flag typos:** For example, `--autoBronnect` instead of `--autoConnect`.
42+
- **Verify the configuration:** Ensure the arguments match the expected flags exactly.
43+
44+
#### Other Common Errors
45+
46+
Identify other error messages from the failed tool call or the MCP initialization logs:
47+
48+
- `Target closed`
49+
- "Tool not found" (check if they are using `--slim` which only enables navigation and screenshot tools).
50+
- `ProtocolError: Network.enable timed out` or `The socket connection was closed unexpectedly`
51+
- `Error [ERR_MODULE_NOT_FOUND]: Cannot find module`
52+
- Any sandboxing or host validation errors.
53+
54+
### Step 3: Read Known Issues
55+
56+
Read the contents of https://github.com/ChromeDevTools/chrome-devtools-mcp/blob/main/docs/troubleshooting.md to map the error to a known issue. Pay close attention to:
57+
58+
- Sandboxing restrictions (macOS Seatbelt, Linux containers).
59+
- WSL requirements.
60+
- `--autoConnect` handshakes, timeouts, and requirements (requires **running** Chrome 144+).
61+
62+
### Step 4: Formulate a Configuration
63+
64+
Based on the exact error and the user's environment (OS, MCP client), formulate the correct MCP configuration snippet. Check if they need to:
65+
66+
- Pass `--browser-url=http://127.0.0.1:9222` instead of `--autoConnect` (e.g. if they are in a sandboxed environment like Claude Desktop).
67+
- Enable remote debugging in Chrome (`chrome://inspect/#remote-debugging`) and accept the connection prompt. **Ask the user to verify this is enabled if using `--autoConnect`.**
68+
- Add `--logFile <absolute_path_to_log_file>` to capture debug logs for analysis.
69+
- Increase `startup_timeout_ms` (e.g. to 20000) if using Codex on Windows.
70+
71+
_If you are unsure of the user's configuration, ask the user to provide their current MCP server JSON configuration._
72+
73+
### Step 5: Run Diagnostic Commands
74+
75+
If the issue is still unclear, run diagnostic commands to test the server directly:
76+
77+
- Run `npx chrome-devtools-mcp@latest --help` to verify the installation and Node.js environment.
78+
- If you need more information, run `DEBUG=* npx chrome-devtools-mcp@latest --logFile=/tmp/cdm-test.log` to capture verbose logs. Analyze the output for errors.
79+
80+
### Step 6: Check GitHub for Existing Issues
81+
82+
If https://github.com/ChromeDevTools/chrome-devtools-mcp/blob/main/docs/troubleshooting.md does not cover the specific error, check if the `gh` (GitHub CLI) tool is available in the environment. If so, search the GitHub repository for similar issues:
83+
`gh issue list --repo ChromeDevTools/chrome-devtools-mcp --search "<error snippet>" --state all`
84+
85+
Alternatively, you can recommend that the user checks https://github.com/ChromeDevTools/chrome-devtools-mcp/issues and https://github.com/ChromeDevTools/chrome-devtools-mcp/discussions for help.

0 commit comments

Comments
 (0)