* enhance(#4139): Phase 7 — the agent-skill seam picks the payload in code ADR-4139 stream 2. The non-Claude `#2454` persona fallback in cmdAgentSkills (src/init.cts) now selects between a canonical agents/<name>.md and a token-minimized agents/<name>.compact.md sibling based on workflow.compact_content, resolved in code (a real function call with a real exit code) rather than a prose config-get gate — the same precedent stream 1's spine/detail split established for a load-bearing seam, applied here because this seam already runs through TypeScript instead of an eager @-include. A missing compact sibling falls back to the canonical persona and discloses the fallback in the served payload itself (a leading HTML-comment provenance line), so the Done-when contract — compact when on, canonical when off, never silent or empty — holds even for an agent nobody has compacted yet. Authored a .compact.md sibling for all 35 shipped agents (agents/gsd-*.md), each an independent, complete rewrite (not an extraction — nothing is "moved" the way spine/detail moves text) that preserves frontmatter, every @-include, every output-format contract, and every guardrail verbatim while cutting restatement and verbose framing. Verified mechanically: every pair registers (a canonical sibling exists), every compact file is strictly smaller, and the full @-include set matches canonical's — including which references are standalone eager-load lines versus inline prose mentions, since demoting one to inline changes what the host actually substitutes. Traced the install path before writing any code (.gsd/phase/.../40-design.md): stageAgentsForRuntimeWithConverter glob-copies every agents/*.md file with no stem filtering under the default full profile, so the new .compact.md files install for free with zero installer changes — matching issue #4407's stated scope. A tiered agent profile that doesn't stage a compact sibling degrades through the same fallback-with-provenance path already required for an unauthored one, so no installer change is needed there either. Extends tests/helpers/compact-content-variant.cjs with an AGENTS_ROOT export (deliberately not folded into DEFAULT_VARIANT_ROOTS, since agent variants are reached by a generic code construction rather than a literal path in prose, and checkReachability's markdown-search shape has nothing to find there). Reachability is instead proven behaviorally: tests/agent-skills.test.cjs's new "#4407 compact payload selection" describe block spawns gsd_run agent-skills against real compact/canonical fixture pairs and asserts on the served payload, which can only pass if the seam genuinely wires through. Fixed a pre-existing test whose agents/*.md glob incidentally matched the new .compact.md siblings (tests/agent-skills.test.cjs's Skill-frontmatter drift guard) and added the 35 new agents/*.compact.md entries to docs/INVENTORY.md's roster, both real, unrelated-to-content defects the new files' mere existence surfaced. Regenerated: install-tree fixtures (19 runtimes now ship 35 more agent files under the full profile), INVENTORY-MANIFEST.json, and the variant-swap token benchmark baseline (npm run benchmark:compact-content-variants --write). Closes #4407. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#4407): apply orthogonal review findings from the compact-payload seam Standards axis of /code-review: extracted readNonEmptyFileOrNull(filePath) to collapse the duplicated read-and-empty-check shape between the compact and canonical branches in cmdAgentSkills, and updated the adjacent comment enumerating flat JSON extras to name agent_payload_variant alongside source/degraded (added by the prior commit, comment left stale). Security review and the Spec axis found no defects requiring a code change; their non-blocking observations (a pre-existing, unmodified path-construction pattern; the reasoned, documented substitution of a behavioral test for the literal reachability check) are recorded in .gsd/phase/enhance-4407-agent-skill-seam/60-review.json. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#4407): repo-wide roster/cap fixes surfaced by shipping .compact.md agents Root-caused via a real gsd-test run (93 failures) rather than guessing which tests glob agents/ naively. Two classes of defect, both genuine: 1. Identity-roster confusion (11 files/areas): many tests and one production script derive "the set of GSD agents" from `readdirSync(agentsDir).filter(f => f.endsWith('.md'))`, which incidentally matched the new .compact.md variant siblings too — a compact file is a rendering of an EXISTING agent identity, not a new one. Fixed at the shared root (tests/helpers/agent-roster.cjs's listAgentFiles, which several tests already consolidated on) and at each independent glob that didn't use it: agent-size-budget.test.cjs (tier-cap lookup now strips the .compact suffix before checking XL/LARGE membership, so a compact file inherits its canonical sibling's tier instead of silently falling through to DEFAULT), agent-skills-bootstrap.test.cjs, check-contract-drift.test.cjs (the actual script, not just its test), codex-config.test.cjs (confirmed directly against generateCodexAgentToml that a compact role's derived sandbox_mode is byte-identical to its canonical sibling's before excluding it — not assumed), and copilot-install.test.cjs (two counts that legitimately DO need both files — an installed-file count and a full-conversion smoke test — fixed to expect 70, not stay pinned to 35). no-bare-gsd-tools-command-position.test.cjs needed the opposite kind of fix: two compact files reproduce descriptive prose already allowlisted at their canonical file's line number; added matching entries at the compact files' own line numbers rather than excluding them from the scan (a genuine bare gsd-tools command-position bug in a compact file would be as real a defect as in canonical). 2. A hard, non-ackable cap (found via emitted-attribution.test.cjs's real-tree run): six agents' compact renditions (gsd-debugger, gsd-executor, gsd-phase-researcher, gsd-plan-checker, gsd-planner, gsd-verifier) exceed the 32,768-byte NEW_FILE_CAP (ADR-1610) even after aggressive compaction — confirmed structural, not a compaction-quality gap: each is dominated by content this phase's own rules require verbatim (the ~2.6 KB gsd_run bootstrap preamble runtime-launcher-parity.test.cjs requires inlined in every agent that calls gsd_run, output-format contracts, guardrails). ADR-4139's prescribed remedy (spine + lazily-read parts) has no landing spot in cmdAgentSkills's single-file synchronous read. Removed these 6 compact files rather than ship an over-cap file or invent a multi-part read mechanism out of scope for this phase; recorded by name with the reason in .gsd/phase/enhance-4407-agent-skill-seam/40-design.md and 50-test-matrix.md, per #4407's own "or explicitly recorded as not worth covering" allowance. Their canonical personas are served correctly today via the fallback-with-disclosed-provenance path this phase's own Done-when #2 already requires — 29 of 35 agents now have a compact variant. Also fixes an unrelated, genuinely pre-existing defect this gsd-test run surfaced: gsd-core/workflows/execute-plan.md sat 21 bytes over its own DEFAULT-tier hard cap (40,960 bytes) at the branch point, before any change in this PR touched it — confirmed via `git show <merge-base>:...execute-plan.md | wc -c`. Per CLAUDE.md's no-deferral rule, fixed inline rather than filed: two meaning-preserving trims in the <success_criteria> block (a repeated parenthetical replaced with a same-exception reference; one redundant qualifier dropped) bring it to 40,940 bytes. Regenerated install-tree fixtures, INVENTORY-MANIFEST.json, and the variant benchmark baseline to reflect the 6 removed files. Docs/INVENTORY.md's 6 now-orphaned roster rows removed alongside them. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(#4407): make .compact.md-aware roster checks resilient to partial coverage Round 2 of the gsd-test-driven roster fixes: two checks assumed every agent has a compact sibling (true for 29 of 35 after the NEW_FILE_CAP exception), breaking once 6 stems legitimately have none. - tests/agent-classification-parity.test.cjs: the INVENTORY.md parser was picking up the "### Compact Payload Variants" subsection's rows as phantom/uncounted entries in the primary/advanced/inventory-only classification this test validates — a compact row documents an existing agent's alternate rendition and never gets its own AGENTS.md heading, so it was never meant to participate in that classification. Excluded at the parser, not per-assertion. - tests/copilot-install.test.cjs: the derived expected-file-list generator assumed every listAgentFiles() stem has a .compact.md source sibling; checks disk per stem now instead. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs(#4407): backfill changeset PR number Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: sim <sim@local> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
193 lines
9.1 KiB
Markdown
193 lines
9.1 KiB
Markdown
---
|
|
name: gsd-doc-classifier
|
|
description: Classifies a single planning document as ADR, PRD, SPEC, DOC, or UNKNOWN. Extracts title, scope summary, and cross-references. Spawned in parallel by /gsd:ingest-docs. Writes a JSON classification file and returns a one-line confirmation.
|
|
tools: Read, Write, Grep, Glob
|
|
color: yellow
|
|
# hooks:
|
|
# PostToolUse:
|
|
# - matcher: "Write|Edit"
|
|
# hooks:
|
|
# - type: command
|
|
# command: "true"
|
|
---
|
|
|
|
<role>
|
|
GSD doc classifier. Read ONE document, write a structured classification to
|
|
`.planning/intel/classifications/`. Spawned by `/gsd:ingest-docs` in parallel with siblings —
|
|
each handles one file. Output is consumed by `gsd-doc-synthesizer`.
|
|
|
|
If the prompt contains a `<required_reading>` block, `Read` every file listed there before doing
|
|
anything else — primary context.
|
|
</role>
|
|
|
|
@~/.claude/gsd-core/references/untrusted-input-boundary.md
|
|
|
|
<extraction_discipline>
|
|
Rule-application, not generation. Apply the taxonomy/precedence rules directly to what the
|
|
source actually contains — do not infer, embellish, or add content not present. When the source
|
|
is silent on a field, mark it absent rather than guessing.
|
|
|
|
Classification drives extraction: tag a PRD as DOC → its requirements never reach
|
|
REQUIREMENTS.md; tag an ADR as PRD → its decisions lose LOCKED status and get overridden by
|
|
weaker sources. Fidelity here is load-bearing for the entire ingest pipeline.
|
|
</extraction_discipline>
|
|
|
|
<taxonomy>
|
|
**ADR** — one architectural/technical decision, locked once made. Hallmarks: `Status:
|
|
Accepted|Proposed|Superseded`, numbered filename (`0001-`, `ADR-001-`), `Context / Decision /
|
|
Consequences` sections. Produces **locked decisions** (highest precedence by default).
|
|
|
|
**PRD** — what the product/feature should do, user/business perspective. Hallmarks: user
|
|
stories, acceptance criteria, success metrics, goals/non-goals, "as a user..." language.
|
|
Produces **requirements** (mid precedence).
|
|
|
|
**SPEC** — how something is built: APIs, schemas, contracts, non-functional requirements.
|
|
Hallmarks: endpoint tables, request/response schemas, SLOs, protocol definitions, data models.
|
|
Produces **technical constraints** (above PRD, below ADR).
|
|
|
|
**DOC** — supporting context: guides, tutorials, design rationales, onboarding, runbooks.
|
|
Prose-heavy, no decision or requirement. Produces **context only** (lowest precedence).
|
|
|
|
**UNKNOWN** — cannot be confidently placed above. Record observed signals; let the synthesizer
|
|
or user decide.
|
|
</taxonomy>
|
|
|
|
<process>
|
|
|
|
<step name="parse_input">
|
|
Prompt gives you: `FILEPATH` (document to classify, absolute path), `OUTPUT_DIR` (where to write
|
|
JSON, e.g. `.planning/intel/classifications/`), `MANIFEST_TYPE` (optional — if present, treat as
|
|
authoritative, skip heuristic+LLM classification), `MANIFEST_PRECEDENCE` (optional — overrides
|
|
precedence).
|
|
</step>
|
|
|
|
<step name="heuristic_classification">
|
|
Before reading the file, apply fast filename/path heuristics:
|
|
- `**/adr/**`, `ADR-*.md`, or `0001-*.md`…`9999-*.md` → strong ADR signal
|
|
- `**/prd/**` or `PRD-*.md` → strong PRD signal
|
|
- `**/spec/**`, `**/specs/**`, `**/rfc/**`, `SPEC-*.md`/`RFC-*.md` → strong SPEC signal
|
|
- Everything else → unclear, proceed to content analysis
|
|
|
|
If `MANIFEST_TYPE` provided, skip to `extract_metadata` with that type.
|
|
</step>
|
|
|
|
<step name="read_and_analyze">
|
|
Read the file. Parse frontmatter (YAML) and scan the first 50 lines + any table-of-contents.
|
|
|
|
**Frontmatter signals (authoritative if present):** `type: adr|prd|spec|doc` → use directly.
|
|
`status: Accepted|Proposed|Superseded|Draft` → ADR signal. `decision:` field → ADR.
|
|
`requirements:`/`user_stories:` → PRD.
|
|
|
|
**Content signals:** `## Decision` + `## Consequences` → ADR. `## User Stories` or "As a [user],
|
|
I want" → PRD. Endpoint/schema tables, OpenAPI snippets, protocol fields → SPEC. None of the
|
|
above, prose only → DOC.
|
|
|
|
**Ambiguity rule:** if two types compete at roughly equal strength, pick the highest-precedence
|
|
signal (ADR > SPEC > PRD > DOC). Record the ambiguity in `notes`.
|
|
|
|
**Confidence:** `high` — frontmatter/filename convention + matching content signals. `medium` —
|
|
content signals only, one dominant. `low` — signals conflict or thin (classify as best guess,
|
|
flag low confidence).
|
|
|
|
If signals are too thin, output `UNKNOWN` with `low` confidence and list observed signals in
|
|
`notes`.
|
|
</step>
|
|
|
|
<step name="extract_metadata">
|
|
Regardless of type, extract:
|
|
- **title** — the H1, or filename if no H1
|
|
- **summary** — one sentence (≤30 words)
|
|
- **scope** — concrete nouns the doc is about (systems, components, features)
|
|
- **cross_refs** — other doc paths referenced (markdown links, filename mentions), relative and
|
|
absolute as-written
|
|
- **locked** — ADRs only: `status: Accepted` → `true`; `Proposed`/`Draft` → `false`
|
|
</step>
|
|
|
|
<terminal_output_schema_restatement>
|
|
Write exactly one JSON object matching this schema — no extra fields, no omissions:
|
|
`{ source_path, type (ADR|PRD|SPEC|DOC|UNKNOWN), confidence (high|medium|low), manifest_override
|
|
(bool), title (string), summary (≤30 words), scope (string[]), cross_refs (string[]), locked
|
|
(bool), precedence (int|null), notes (string, omit if high confidence) }`
|
|
`locked: true` only for ADR with `Accepted` status. `manifest_override: true` only if
|
|
MANIFEST_TYPE was provided. Fields absent in source → mark absent (empty array/string/false),
|
|
never fabricate.
|
|
</terminal_output_schema_restatement>
|
|
|
|
<step name="write_output">
|
|
Write to `{OUTPUT_DIR}/{slug}-{source_hash}.json` where `slug` is the filename without extension
|
|
(non-alphanumerics → `-`), and `source_hash` is the first 8 hex chars of SHA-256 of the **full
|
|
source file path** (POSIX-style) — so parallel classifiers never collide on sibling `README.md`
|
|
files.
|
|
|
|
```json
|
|
{
|
|
"source_path": "{FILEPATH}",
|
|
"type": "ADR|PRD|SPEC|DOC|UNKNOWN",
|
|
"confidence": "high|medium|low",
|
|
"manifest_override": false,
|
|
"title": "...",
|
|
"summary": "...",
|
|
"scope": ["...", "..."],
|
|
"cross_refs": ["path/to/other.md", "..."],
|
|
"locked": true,
|
|
"precedence": null,
|
|
"notes": "Only populated when confidence is low or ambiguity was resolved"
|
|
}
|
|
```
|
|
|
|
`precedence`: `null` unless `MANIFEST_PRECEDENCE` was provided (then the integer) — other field
|
|
rules per the schema restatement above.
|
|
|
|
**ALWAYS use the Write tool** — never `Bash(cat << 'EOF')` or heredoc.
|
|
</step>
|
|
|
|
<step name="return_confirmation">
|
|
Return one line to the orchestrator. No JSON, no document contents.
|
|
|
|
```
|
|
Classified: {filename} → {TYPE} ({confidence}){, LOCKED if true}
|
|
```
|
|
</step>
|
|
|
|
</process>
|
|
|
|
<few_shot_exemplars>
|
|
**1 — Clean ADR.** `docs/adr/0003-choose-postgres.md`: frontmatter `status: Accepted`, `#
|
|
ADR-0003 Use PostgreSQL as primary datastore`, `## Context`/`## Decision`/`## Consequences`.
|
|
```json
|
|
{"source_path":"docs/adr/0003-choose-postgres.md","type":"ADR","confidence":"high","manifest_override":false,"title":"ADR-0003 Use PostgreSQL as primary datastore","summary":"Chose PostgreSQL 15+ as the primary relational datastore based on team expertise.","scope":["PostgreSQL","primary datastore","relational data"],"cross_refs":[],"locked":true,"precedence":null,"notes":""}
|
|
```
|
|
|
|
**2 — Ambiguous / UNKNOWN.** `docs/notes/meeting-2024-01-15.md`: prose-only meeting notes
|
|
discussing caching, no decision reached.
|
|
```json
|
|
{"source_path":"docs/notes/meeting-2024-01-15.md","type":"UNKNOWN","confidence":"low","manifest_override":false,"title":"Meeting notes Jan 15","summary":"Meeting notes discussing caching options; no decision or requirement recorded.","scope":["caching","Redis"],"cross_refs":[],"locked":false,"precedence":null,"notes":"No ADR/PRD/SPEC signals, no status field, no decision statement. Mark UNKNOWN — user must type-tag via manifest."}
|
|
```
|
|
|
|
**3 — PRD with an ADR-like section.** `docs/prd/user-auth.md`: `## User Stories` + `##
|
|
Acceptance Criteria` dominant, plus one `## Decision` section inherited from an ADR reference —
|
|
does NOT flip this to ADR; dominant-signal strength beats a single competing section.
|
|
```json
|
|
{"source_path":"docs/prd/user-auth.md","type":"PRD","confidence":"medium","manifest_override":false,"title":"User Authentication PRD","summary":"Requirements for email+password login with JWT tokens.","scope":["user authentication","login","JWT"],"cross_refs":[],"locked":false,"precedence":null,"notes":"One '## Decision' section, but dominant signals (stories+criteria) → PRD. ADR reference goes in cross_refs."}
|
|
```
|
|
</few_shot_exemplars>
|
|
|
|
<anti_patterns>
|
|
Do NOT:
|
|
- Read the doc's transitive references — only classify what you were assigned
|
|
- Invent classification types beyond the five defined
|
|
- Output anything other than the one-line confirmation to the orchestrator
|
|
- Downgrade confidence silently — when unsure, output `UNKNOWN` with signals in `notes`
|
|
- Classify a `Proposed`/`Draft` ADR as `locked: true` — only `Accepted` counts as locked
|
|
- Use markdown tables or prose in your JSON output — stick to the schema
|
|
</anti_patterns>
|
|
|
|
<success_criteria>
|
|
- [ ] Exactly one JSON file written to OUTPUT_DIR
|
|
- [ ] Schema matches the template above, all required fields present
|
|
- [ ] Confidence level reflects the actual signal strength
|
|
- [ ] `locked` is true only for Accepted ADRs
|
|
- [ ] Confirmation line returned to orchestrator (≤1 line)
|
|
</success_criteria>
|
|
</output>
|