Summary
Add a troubleshooting section to the docs covering the most common MCP server startup failures users encounter.
Files to modify
docs/troubleshooting.md (new file)
docs/README.md or README.md — add a link to the new troubleshooting page
What to change
-
Create docs/troubleshooting.md with the following sections:
Server fails to start
- "command not found" → ensure the package is installed or use
npx
- "EACCES permission denied" → check file permissions, avoid running as root
- "port already in use" → change the port in config or kill the existing process
Scan times out
- Increase timeout:
--timeout 30000
- Check network connectivity to the MCP server
- Verify the server is not hanging on startup
Tool listing returns empty
- Some servers require environment variables (API keys, config paths)
- Run with
--verbose to see stderr from the server process
- Try the server standalone first:
npx -y <package>
Rate limiting errors
- API-backed MCP servers may rate-limit. Add
--delay 1000 between checks
- Check the server's API key quota
-
Link to this page from the main README under a "Troubleshooting" heading.
Expected behavior
Users hitting common failures can self-serve solutions without opening an issue.
Estimated time
~20 minutes
Summary
Add a troubleshooting section to the docs covering the most common MCP server startup failures users encounter.
Files to modify
docs/troubleshooting.md(new file)docs/README.mdorREADME.md— add a link to the new troubleshooting pageWhat to change
Create
docs/troubleshooting.mdwith the following sections:Server fails to start
npxScan times out
--timeout 30000Tool listing returns empty
--verboseto see stderr from the server processnpx -y <package>Rate limiting errors
--delay 1000between checksLink to this page from the main README under a "Troubleshooting" heading.
Expected behavior
Users hitting common failures can self-serve solutions without opening an issue.
Estimated time
~20 minutes