Files
msd-core/docs/how-to/recover-and-troubleshoot.md
Jakub Zych a9a7a328e6 refactor: hard-fork GSD -> MSD (Make Software Done)
Mechanical rename produced by scripts/msd-rename.cjs: gsd/Gsd/GSD -> msd/Msd/MSD
across contents and paths, upstream package/repo coordinates -> @golem15/msd-core
and golem15com/msd-core. Deep links into upstream history, sibling upstream
packages, the GSD-2 import feature, CHANGELOG.md and .changeset/ are kept as-is.

Hand edits on top: MSD block-letter banner and logos, LICENSE copyright line,
package/plugin identity, regenerated lockfile, install-tree fixtures, derived
registries and benchmark baseline; migration checksum baseline re-locked
(MSD keeps its own install state, so no install had applied the old sums);
sort-order and regex-escaped expectations in tests adjusted.
2026-10-06 01:47:40 +02:00

15 KiB
Raw Permalink Blame History

How to recover and troubleshoot

Goal: Identify and fix common problems — from lost context and corrupted state to installation failures and permission errors — using a conditional recipe structure.

Prerequisites: MSD Core is installed. For install problems specifically, see Install on your runtime.


Context and session problems

If you have lost track of where you are

/msd-progress

Reads all state files and tells you exactly where you are and what to do next.

To automatically advance to the correct next step:

/msd-progress --next

If you are starting a new session and need to restore context

/msd-resume-work

Restores your full session context from the last handoff, including current phase, planning decisions, and where work stopped.

If quality is dropping during a long session

Clear your context window between major commands:

/clear

Then restore state:

/msd-resume-work

MSD is designed around fresh contexts. Every subagent already gets a clean 200k window. The main session degrades over time — clearing it and resuming is the correct remedy, not pushing on.

If you want to save context before stopping

/msd-pause-work

Creates .planning/HANDOFF.json with your current position. Add --report to also write a post-session summary to .planning/reports/:

/msd-pause-work --report

Planning integrity problems

If .planning/ integrity is uncertain

/msd-health

Reports status across errors, warnings, and informational notes:

Status Meaning
HEALTHY All expected artefacts present and well-formed
DEGRADED Warnings that should be addressed but work can continue
BROKEN Critical errors that will block execution

Common auto-repairable issues (errors E004, E005; warnings W003, W008):

/msd-health --repair

This recreates missing STATE.md, resets a corrupt config.json to defaults, and adds any missing configuration keys. It will not overwrite PROJECT.md or ROADMAP.md.

If STATE.md references a phase that does not exist

This produces warning W002. Use the state CLI to diagnose and repair:

node "$HOME/.claude/msd-core/bin/msd-tools.cjs" state validate

Preview what a sync would change without writing:

node "$HOME/.claude/msd-core/bin/msd-tools.cjs" state sync --verify

Apply the sync:

node "$HOME/.claude/msd-core/bin/msd-tools.cjs" state sync

These commands reconstruct STATE.md from actual project state on disk. They replace manual STATE.md editing.

If you see "Project already initialised"

.planning/PROJECT.md already exists. /msd-new-project is a safety check. If you genuinely want to start over, delete the .planning/ directory first:

rm -rf .planning/

Then re-run /msd-new-project.

If context-window utilisation is high

/msd-health --context

Probes the context-window utilisation guard. Warns at 60 %, critical at 70 %. If you are above the warning threshold, run /clear followed by /msd-resume-work before starting the next major command.


Execution problems

If an executor gets "Permission denied" on Bash commands

MSD's msd-executor subagents need write-capable Bash access. Add the required patterns to ~/.claude/settings.json under permissions.allow. At minimum:

"Bash(git add:*)",
"Bash(git commit:*)",
"Bash(git merge:*)",
"Bash(git checkout:*)"

For stack-specific patterns (Rails, Python, Node, Rust), see the full table in docs/USER-GUIDE.md under "Executor Subagent Gets Permission denied".

Per-project alternative: add the same block to .claude/settings.local.json in your project root.

If execution fails or produces stubs

Check whether the plan is too ambitious. Plans should have two or three tasks at most. If tasks are too large they exceed what a single context window can produce reliably. Re-plan the phase with smaller scope:

/msd-plan-phase 1

For systematic diagnosis of what went wrong, see Debug a failed execution.

If you see "FATAL: worktree base mismatch" or the exit-42 warning

This happens when your current branch is ahead of the repository's default branch (for example, an unmerged milestone or feature branch). Claude Code forks executor worktrees from origin/HEAD, not your HEAD, so plan files that exist only on your branch are absent inside the worktree.

Since the fix landed, MSD automatically degrades to sequential execution on the main working tree and prints a one-line warning — the phase will complete without any action from you. To restore parallel execution permanently, run:

node "$HOME/.claude/msd-core/bin/msd-tools.cjs" worktree set-baseref

For a full explanation and all available options, see Fix the worktree base-mismatch (exit 42) error.

If parallel execution causes build lock errors or pre-commit hook failures

This is caused by multiple agents triggering build tools simultaneously. MSD handles this automatically since v1.26. If you are on an older version, or still seeing contention, disable parallel execution:

/msd-settings

Set parallelization.enabled to false.

If a subagent appears to fail but commits were made

Check git log before concluding something broke:

git log --oneline -10

A known Claude Code classification bug can report failure while work succeeded. MSD's orchestrators spot-check actual output, but if you see a mismatch, the commits are the ground truth.


Plan and phase problems

If plans seem wrong or misaligned with your intent

Run /msd-discuss-phase N before planning. Most plan quality issues come from assumptions that CONTEXT.md would have prevented:

/msd-discuss-phase 1

To see what assumptions MSD is currently making without starting a full session:

/msd-discuss-phase 3 --assumptions

If you need to change something after execution

Do not re-run /msd-execute-phase. Use /msd-quick for targeted fixes:

/msd-quick "Fix the login button not responding on mobile Safari"

Or use /msd-verify-work N to systematically identify and fix issues through UAT.

If a command appears frozen at "Spawning…"

Wait. MSD subagents run in a separate context window. Their work is invisible to the parent session while in progress. The liveness note on the spawn line confirms this is expected. Research and planning agents routinely take 1–5 minutes; verification agents can take longer on large phases.

Do not interrupt the session. Killing it discards in-progress subagent work.

If it has been more than 10 minutes, check whether the agent task still shows as active in the Claude Code sidebar.


Workflow state problems

If the workflow seems corrupted or state is inconsistent

/msd-forensics

Or with a description:

/msd-forensics "Phase 3 execution stalled after wave 1"

/msd-forensics runs a post-mortem investigation: git history anomalies, artefact integrity, STATE.md consistency, uncommitted work, and orphaned worktrees. It writes a report to .planning/forensics/ and surfaces recommended remediation steps. It is read-only and never modifies your project files.

If you need to roll back a phase or plan

/msd-undo --phase 03          # Roll back all commits for phase 3
/msd-undo --plan 03-02        # Roll back commits for plan 02 of phase 3
/msd-undo --last 5            # Pick interactively from the 5 most recent MSD commits

/msd-undo checks dependent phases before reverting and always shows a confirmation gate.


Install and update problems

If MSD is not recognised after install

Restart your runtime. MSD installs slash commands into your runtime's command directory (for example ~/.claude/commands/msd/). Most runtimes discover new commands only at startup.

If the problem persists, verify the install:

npx @golem15/msd-core@latest --claude --local

For runtime-specific install paths and troubleshooting, see Install on your runtime.

If an install or uninstall was interrupted

Nothing to do — finish the interrupted command by running it again.

MSD deletes and rebuilds whole directories while installing, and some files in them are yours rather than MSD's: USER-PROFILE.md (written by /msd-profile-user) and dev-preferences.md. Before anything is deleted, MSD copies those to a staging area under your runtime's config directory, at .msd-staging/user-artifacts/. The copy is committed to disk before the delete begins, so pressing Ctrl+C, a crash, or a machine losing power cannot leave you without them.

The next install or uninstall looks for staged copies left behind by an interrupted run and restores them before doing anything else. It will not overwrite a file that is already there — a file present on disk was never lost — and it leaves alone any staging belonging to another install still running.

To confirm your profile came back:

ls ~/.claude/msd-core/USER-PROFILE.md

If the file is missing but .msd-staging/user-artifacts/ still contains an entry, run the install again; recovery happens at the start of the next run, not in the background. If you are curious what is staged, each entry holds a record.json naming the directory it came from and the files it holds — those are ordinary files you can inspect or copy out by hand.

If Codex agents fail to spawn with a 400 about an unsupported model

Symptom — a typed agent (msd-planner, msd-executor, …) fails to start and the whole plan/execute flow falls back to a generic agent:

400 invalid_request_error: "The 'sonnet' model is not supported when using Codex with a ChatGPT account."

This means an installed ~/.codex/agents/<agent>.toml still pins a model your Codex session cannot serve. Installs made before the passive model posture landed embedded a per-tier model; a ChatGPT-account session exposes only its own model, so the pin fails the request outright (ADR-2313).

Check which agents are affected:

node msd-tools.cjs validate agents

The codex_posture section reports one violation per offending agent, naming the file and the offending value. Two things it flags:

  • anthropic_flavored_model — the .toml pins a MSD tier alias (opus, sonnet, haiku, fable) or a claude-* id. Codex rejects all of these.
  • orphaned_reasoning_effort — a model_reasoning_effort with no model, which leaves the model following your Codex session while the effort follows MSD.

An empty violations list means every regular .toml in the directory is posture-clean, so the 400 is coming from somewhere else — check that your Codex session itself is healthy.

One thing the check deliberately does not inspect: an agent file that is a symlink is skipped rather than followed, matching how the effort sync treats them. If you symlink your agent configs, verify those targets by hand.

Fix — repair in place, without a reinstall. Preview what would change:

node msd-tools.cjs effort sync

That is a dry run; it writes nothing. When the reported changes look right, apply them:

node msd-tools.cjs effort sync --apply

It removes only the offending model / model_reasoning_effort lines. Everything else — your line endings, comments, key order, and any keys you added by hand — is preserved byte-for-byte, so the result is a two-line diff rather than a reformatted file. An explicit real-Codex pin is left alone, and a file it cannot parse is refused and reported rather than partially rewritten.

Or re-run the installer, which rewrites the agent files wholesale. Current versions write no model at all, so agents inherit the session model:

npx @golem15/msd-core@latest --codex --global

Prefer the sync if you have hand-edited your .toml files — a reinstall regenerates them.

If you are on an API-key account and genuinely want a pinned model, name a real Codex model id per agent instead — see How to configure model profiles.

The check is read-only. It reports what is wrong and does not edit your files.

If an update overwrote your local changes

Since v1.17, the installer backs up locally modified files to msd-local-patches/. Reapply your changes:

/msd-update --reapply

If you cannot update via npm

If npx @golem15/msd-core fails due to npm outages or network restrictions, see docs/manual-update.md for a step-by-step manual update procedure that works without npm access.

For routine updates, see Update MSD.


Cost problems

If model costs are too high

Switch to the budget profile:

/msd-config --profile budget

Disable research and plan-check agents via settings if the domain is familiar:

/msd-settings

Also audit which MCP servers are enabled. Every enabled MCP server injects its tool schema into every turn. Browser and platform-specific tools can cost 20k+ tokens each. Disable any that the current phase does not need in .claude/settings.json:

{
  "disabledMcpjsonServers": ["playwright", "mac-tools"]
}

Recovery quick reference

Problem Solution
Lost context or new session /msd-resume-work or /msd-progress
Don't know what step is next /msd-progress --next
Phase went wrong /msd-undo --phase NN, then re-plan
Something broke /msd-debug "description" (add --diagnose for analysis without fixes)
STATE.md out of sync state validate then state sync
.planning/ integrity uncertain /msd-health, then /msd-health --repair
Workflow state seems corrupted /msd-forensics
Quick targeted fix /msd-quick
Plan doesn't match your vision /msd-discuss-phase N then re-plan
Costs running high /msd-config --profile budget and /msd-settings to toggle agents off
Update broke local changes /msd-update --reapply
Want session summary /msd-pause-work --report
Parallel execution build errors Update MSD or set parallelization.enabled: false
Worktree base mismatch / exit 42 Auto-degraded to sequential (no action needed); run worktree set-baseref to restore parallelism