Files
msd-core/get-shit-done/workflows/diagnose-issues.md
Lex Christopherson 00208b71af feat(debug): subagent isolation for investigation with checkpoint support
- Debug command now orchestrates: gather symptoms in main context, spawn
  investigation subagent with fresh 200k context
- Subagent template unified for both /gsd:debug (find_and_fix) and
  diagnose-issues (find_root_cause_only) flows via goal flag
- Checkpoint behavior enables subagent to pause for user input
  (human-verify, human-action, decision) with continuation agents
- Structured return formats: ROOT CAUSE FOUND, DEBUG COMPLETE,
  INVESTIGATION INCONCLUSIVE, CHECKPOINT REACHED
- diagnose-issues updated to match new template placeholders and returns

Co-Authored-By: Claude <noreply@anthropic.com>
2026-01-14 10:59:59 -06:00

6.8 KiB

Orchestrate parallel debug agents to investigate UAT issues and find root causes.

After UAT finds issues, spawn one debug agent per issue. Each agent investigates autonomously with symptoms pre-filled from UAT. Collect root causes, update UAT.md, then hand off to plan-fix with actual diagnoses.

Orchestrator stays lean: parse issues, spawn agents, collect results, update UAT.

DEBUG_DIR=.planning/debug

Debug files use the .planning/debug/ path (hidden directory with leading dot).

<core_principle> Diagnose before planning fixes.

UAT tells us WHAT is broken (symptoms). Debug agents find WHY (root cause). Plan-fix then creates targeted fixes based on actual causes, not guesses.

Without diagnosis: "Comment doesn't refresh" → guess at fix → maybe wrong With diagnosis: "Comment doesn't refresh" → "useEffect missing dependency" → precise fix </core_principle>

**Extract issues from UAT.md:**

Read the "Issues for /gsd:plan-fix" section:

- UAT-001: Comment doesn't appear until refresh (major) - Test 2
- UAT-002: Reply button position wrong (minor) - Test 5
- UAT-003: Delete doesn't work (blocker) - Test 6

For each issue, also read the corresponding test from "Tests" section to get:

  • expected: What should happen
  • reported: What user described (verbatim)
  • severity: blocker/major/minor/cosmetic

Build issue list:

issues = [
  {id: "UAT-001", summary: "Comment doesn't appear until refresh", severity: "major", test_num: 2, expected: "...", reported: "..."},
  {id: "UAT-002", summary: "Reply button position wrong", severity: "minor", test_num: 5, expected: "...", reported: "..."},
  ...
]
**Report diagnosis plan to user:**
## Diagnosing {N} Issues

Spawning parallel debug agents to investigate root causes:

| Issue | Summary | Severity |
|-------|---------|----------|
| UAT-001 | Comment doesn't appear until refresh | major |
| UAT-002 | Reply button position wrong | minor |
| UAT-003 | Delete doesn't work | blocker |

Each agent will:
1. Create DEBUG-UAT-{NNN}.md with symptoms pre-filled
2. Investigate autonomously (read code, form hypotheses, test)
3. Return root cause

This runs in parallel - all issues investigated simultaneously.
**Spawn debug agents in parallel:**

For each issue, fill the debug-subagent-prompt template and spawn:

Task(
  prompt=filled_debug_subagent_prompt,
  subagent_type="general-purpose",
  description="Debug UAT-{NNN}"
)

All agents spawn in single message (parallel execution).

Template placeholders:

  • {issue_id}: UAT-001, UAT-002, etc.
  • {issue_summary}: Brief description
  • {expected}: From UAT test
  • {actual}: Verbatim user description (what actually happened)
  • {errors}: Any error messages from UAT (or "None reported")
  • {reproduction}: "Test {test_num} in UAT"
  • {timeline}: "Discovered during UAT"
  • {goal}: find_root_cause_only (UAT flow - plan-fix handles fixes)
  • {slug}: Generated from issue_summary
**Collect root causes from agents:**

Each agent returns with:

## ROOT CAUSE FOUND

**Debug Session:** ${DEBUG_DIR}/{slug}.md

**Root Cause:** {specific cause with evidence}

**Evidence Summary:**
- {key finding 1}
- {key finding 2}
- {key finding 3}

**Files Involved:**
- {file1}: {what's wrong}
- {file2}: {related issue}

**Suggested Fix Direction:** {brief hint for plan-fix}

Parse each return to extract:

  • root_cause: The diagnosed cause
  • files: Files involved
  • debug_path: Path to debug session file
  • suggested_fix: Hint for plan-fix

If agent returns ## INVESTIGATION INCONCLUSIVE:

  • root_cause: "Investigation inconclusive - manual review needed"
  • Note which issue needs manual attention
  • Include remaining possibilities from agent return
**Update UAT.md with root causes:**

For each issue in the Tests section, add root_cause field:

### 2. Create Top-Level Comment
expected: Submit comment via rich text editor, appears in list with author info
result: issue
reported: "works but doesn't show until I refresh the page"
severity: major
root_cause: "useEffect in CommentList.tsx missing commentCount dependency - doesn't re-render when new comment added"
debug_session: ${DEBUG_DIR}/comment-not-refreshing.md

Update the "Issues for /gsd:plan-fix" section with root causes:

## Issues for /gsd:plan-fix

- UAT-001: Comment doesn't appear until refresh (major) - Test 2
  root_cause: useEffect missing dependency in CommentList.tsx

- UAT-002: Reply button position wrong (minor) - Test 5
  root_cause: CSS flex order incorrect in ReplyButton.tsx

- UAT-003: Delete doesn't work (blocker) - Test 6
  root_cause: API endpoint returns 403 - missing auth header

Commit the updated UAT.md:

git add ".planning/phases/XX-name/{phase}-UAT.md"
git commit -m "docs({phase}): add root causes from diagnosis"
**Report diagnosis results:**
## Diagnosis Complete

| Issue | Root Cause | Files |
|-------|------------|-------|
| UAT-001 | useEffect missing dependency | CommentList.tsx |
| UAT-002 | CSS flex order incorrect | ReplyButton.tsx |
| UAT-003 | API missing auth header | api/comments.ts |

Debug sessions saved to ${DEBUG_DIR}/

---

Next steps:
- `/gsd:plan-fix {phase}` — Create fix plan with root causes
- Review debug sessions for details
**Offer plan-fix:**
Root causes identified. Ready to plan fixes?

`/gsd:plan-fix {phase}`

The fix plan will use diagnosed root causes for targeted fixes.

<context_efficiency> Orchestrator context: ~15%

  • Parse UAT.md issues
  • Fill template strings
  • Spawn parallel Task calls
  • Collect results
  • Update UAT.md

Each debug agent: Fresh 200k context

  • Loads full debug workflow
  • Loads debugging references
  • Investigates with full capacity
  • Returns root cause

No symptom gathering. Agents start with symptoms pre-filled from UAT. No fix application. Agents only diagnose - plan-fix handles fixes. </context_efficiency>

<failure_handling> Agent fails to find root cause:

  • Mark issue as "needs manual review"
  • Continue with other issues
  • Report incomplete diagnosis

Agent times out:

  • Check DEBUG-UAT-{NNN}.md for partial progress
  • Can resume with /gsd:debug

All agents fail:

  • Something systemic (permissions, git, etc.)
  • Report for manual investigation
  • Fall back to plan-fix without root causes </failure_handling>

<success_criteria>

  • Issues parsed from UAT.md
  • Debug agents spawned in parallel
  • Root causes collected from all agents
  • UAT.md updated with root causes
  • Debug sessions saved to ${DEBUG_DIR}/
  • User knows next steps (plan-fix) </success_criteria>