docs: consolidated diagnostics guide + doctor cross-links (#423, part 2) - #436
Merged
Conversation
docs/diagnostics.md gathers what was previously scattered across nine per-language READMEs, CLAUDE.md, and dev docs: the doctor command's usage and exit-code contract, per-language prerequisites with install commands and env-var overrides, symptom/cause/fix tables (mined from skills/debugging/references/), Yama ptrace_scope semantics, container workspace-mount checks, dryRunSpawn/DAP_TRACE/log locations, and the first complete environment-variable reference (setup-guide's table was missing RUBY_PATH, RDBG_PATH, CODELLDB_PATH, and five others, and listed DLV_PATH which the Go adapter never honored — it searches GOBIN/GOPATH/PATH). Links: README documentation list, troubleshooting.md pointer, setup-guide canonical reference, ROADMAP theme marked shipped, and the launchUnavailable error now suggests running doctor (existing tests assert the message prefix only, verified green). Closes #423 (together with the doctor command PR). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part 2 of #423 (part 1, the
doctorcommand, merged as #434). Closes #423.docs/diagnostics.mdOne consolidated reference for what was previously scattered across nine per-language READMEs, CLAUDE.md, and dev docs:
mcp-debugger doctor— usage, real sample output,--json, the exit-code contract (doctor <languages...>gates; no positionals = informational), and the documented divergence from the server's fail-open behavior (probe.failed/probe.timedOut).CODELLDB_PATH→ platform package) that doctor's backend column attributes.skills/debugging/references/*.mdso hints match what the tools actually print.MCP_CONTAINER/MCP_WORKSPACE_ROOTand the two mount-failure modes doctor catches.dryRunSpawn,DAP_TRACE/DAP_TRACE_FILE, and log-file locations promoted out of CLAUDE.md/dev docs into user-facing docs for the first time.RUBY_PATH,RDBG_PATH,CODELLDB_PATH,DEBUG_MCP_DISABLE_LANGUAGES,MCP_WORKSPACE_ROOT,MCP_CPP_ALLOW_PREBUILT,CPP_MSVC_BEHAVIOR,DEBUG_MCP_NO_REDACT, and listedDLV_PATH, which the Go adapter never honored — it searchesGOBIN→GOPATH/bin→ PATH).Cross-links
docs/troubleshooting.md(which stays as the narrative FAQ).docs/development/setup-guide.mdnow points here as the canonical env-var reference, and itsDLV_PATHrow is corrected toGOBIN.ErrorMessages.launchUnavailablenow suggests runningmcp-debugger doctor <language>on the server host (existing tests assert the message prefix only — verified green).🤖 Generated with Claude Code