Files
get-shit-done/docs/adr/0003-model-catalog-module.md
Tom Boucher 96806003c5 fix(#3229): shared model catalog source of truth for agent profiles + runtime tier defaults (#3230)
* docs(adr): add ADR-0003 model catalog module

* fix(#3229): add shared model catalog as source of truth for agent profiles and runtime tier defaults

Research / design (ADR-0003):
- Existing drift came from 4 independent model truths:
  1. CJS model-profiles.cjs
  2. SDK config-query.ts stale copy (18 agents)
  3. settings-advanced.md runtime tier table
  4. session-runner Claude-only profile map
- New design: one machine-readable Model Catalog Module in sdk/shared/
  that both packages ship and consume.

Implementation:
- sdk/shared/model-catalog.json — canonical source of truth for:
  - full 33-agent registry
  - per-agent golden (quality) alias + balanced/budget aliases
  - adaptive derivation from routingTier
  - agent→phaseType map
  - agent→dynamic-routing default tier map
  - runtime tier defaults for all supported runtimes
- get-shit-done/bin/lib/model-catalog.cjs — CJS adapter over the catalog
- sdk/src/model-catalog.ts — SDK adapter over the same catalog
- CJS model-profiles.cjs now re-exports derived data from model-catalog.cjs
- SDK config-query.ts now re-exports MODEL_PROFILES/VALID_PROFILES from
  model-catalog.ts instead of maintaining its own list
- sdk/src/query/helpers.ts runtime list now comes from the catalog (fixes hermes drift)
- sdk/src/session-runner.ts Claude profile→model-id mapping now resolves via catalog
- docs/CONFIGURATION.md + settings-advanced.md runtime tables updated to match catalog

Behavior changes:
- resolve-model now covers every shipped agent file on disk (33 agents)
- unknown-agent fallback is profile-semantic, not hardcoded sonnet:
  quality→opus, budget→haiku, balanced/adaptive→sonnet, inherit→inherit
- Group B runtimes remain known runtimes but do not get built-in tier defaults

Tests (RED→GREEN):
- root tests: shipped agent files must equal MODEL_PROFILES keys
- sdk tests: shipped agent files must equal MODEL_PROFILES keys
- direct fix assertion: gsd-code-reviewer resolves to opus under quality with no unknown_agent
- runtime defaults parity test: settings-advanced.md + CONFIGURATION.md tables must match catalog
- helper tests: hermes included in SUPPORTED_RUNTIMES and getRuntimeConfigDir()

Closes #3229

* chore(changeset): update #3229 changeset pr field to 3230

* fix(ci): update inherit fallback expectations and inventory parity for model catalog
2026-05-08 21:25:37 -04:00

2.7 KiB

Model Catalog Module as single source of truth for agent profiles and runtime tier defaults

  • Status: Accepted
  • Date: 2026-05-07

We decided to centralize model-selection data in one Model Catalog Module so the SDK, the CLI/CJS layer, and the docs do not maintain separate agent lists, profile maps, or runtime tier defaults.

Problem

Before this ADR there were four drifting sources:

  1. get-shit-done/bin/lib/model-profiles.cjs — agent → profile alias map, phase-type map, dynamic-routing default tiers
  2. sdk/src/query/config-query.ts — stale 18-agent copy of MODEL_PROFILES
  3. get-shit-done/workflows/settings-advanced.md — runtime → built-in model-id table
  4. sdk/src/session-runner.ts — hardcoded Claude-only profile → model-id map

This caused issue #3229: the SDK knew only 18 agents while 33 agent files existed on disk, so ~15 agents silently fell back to Sonnet with unknown_agent: true.

Decision

Create one machine-readable catalog and derive everything else from it.

The catalog owns:

  • supported runtime names
  • runtime tier defaults (opus / sonnet / haiku) and runtime capabilities (e.g. reasoning_effort support)
  • the full agent registry for model resolution
  • the canonical per-agent golden alias (quality intent)
  • derived profile aliases for balanced, budget, and adaptive
  • agent → phase-type mapping
  • agent → dynamic-routing default tier mapping

The canonical file lives in a location both packages ship:

  • repo root package (get-shit-done-cc) includes it
  • standalone SDK package (@gsd-build/sdk) includes it

Both CJS and SDK load this exact file. Neither package keeps its own independent list.

Golden profile

The catalog stores a golden alias per agent. quality is defined as the golden profile exactly. Other profiles (balanced, budget, adaptive) are explicit views over the same agent registry. This keeps the highest-quality intent in one place while allowing lower-cost profiles to differ per agent where needed.

Consequences

  • resolve-model in SDK and CJS read the same registry, so missing-agent drift disappears
  • settings-advanced.md runtime tier table must stay in parity with the catalog (enforced by test)
  • sdk/src/query/helpers.ts runtime list comes from the catalog, fixing drift like the missing hermes runtime
  • sdk/src/session-runner.ts uses the catalog's Claude runtime tier defaults instead of a private hardcoded profile map
  • tests validate:
    • every agents/gsd-*.md file exists in the catalog
    • SDK and CJS resolve the same aliases for all known agents
    • unknown-agent fallback follows profile semantics (qualityopus, budgethaiku, etc.), not a hardcoded sonnet
    • docs/runtime tables stay aligned with the catalog