* 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
71 lines
2.5 KiB
TypeScript
71 lines
2.5 KiB
TypeScript
import { readFileSync } from 'node:fs';
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
interface RuntimeTierEntry {
|
|
model: string;
|
|
reasoning_effort?: string;
|
|
}
|
|
|
|
type RuntimeTierTable = Record<string, Record<string, RuntimeTierEntry | null>>;
|
|
|
|
interface AgentCatalogEntry {
|
|
golden: 'opus' | 'sonnet' | 'haiku';
|
|
balanced: 'opus' | 'sonnet' | 'haiku';
|
|
budget: 'opus' | 'sonnet' | 'haiku';
|
|
phaseType: string;
|
|
routingTier: 'light' | 'standard' | 'heavy';
|
|
}
|
|
|
|
interface ModelCatalog {
|
|
profiles: string[];
|
|
phaseTypes: string[];
|
|
adaptiveTierMap: Record<'light' | 'standard' | 'heavy', 'opus' | 'sonnet' | 'haiku'>;
|
|
runtimeTierDefaults: RuntimeTierTable;
|
|
agents: Record<string, AgentCatalogEntry>;
|
|
}
|
|
|
|
const CATALOG_PATH = new URL('../shared/model-catalog.json', import.meta.url);
|
|
export const catalog: ModelCatalog = JSON.parse(readFileSync(fileURLToPath(CATALOG_PATH), 'utf-8'));
|
|
|
|
export const VALID_PROFILES: string[] = [...catalog.profiles];
|
|
export const SUPPORTED_RUNTIMES = Object.keys(catalog.runtimeTierDefaults);
|
|
export type Runtime = (typeof SUPPORTED_RUNTIMES)[number];
|
|
|
|
export const MODEL_PROFILES: Record<string, Record<string, string>> = Object.fromEntries(
|
|
Object.entries(catalog.agents).map(([agent, meta]) => [agent, {
|
|
quality: meta.golden,
|
|
balanced: meta.balanced,
|
|
budget: meta.budget,
|
|
adaptive: catalog.adaptiveTierMap[meta.routingTier],
|
|
}])
|
|
);
|
|
|
|
export const AGENT_TO_PHASE_TYPE: Record<string, string> = Object.fromEntries(
|
|
Object.entries(catalog.agents).map(([agent, meta]) => [agent, meta.phaseType])
|
|
);
|
|
|
|
export const AGENT_DEFAULT_TIERS: Record<string, string> = Object.fromEntries(
|
|
Object.entries(catalog.agents).map(([agent, meta]) => [agent, meta.routingTier])
|
|
);
|
|
|
|
export function getAgentToModelMapForProfile(normalizedProfile: string): Record<string, string> {
|
|
const profile = VALID_PROFILES.includes(normalizedProfile) ? normalizedProfile : 'balanced';
|
|
const out: Record<string, string> = {};
|
|
for (const [agent, profiles] of Object.entries(MODEL_PROFILES)) {
|
|
out[agent] = profile === 'inherit' ? 'inherit' : profiles[profile] ?? profiles.balanced;
|
|
}
|
|
return out;
|
|
}
|
|
|
|
export function resolveRuntimeTierDefault(runtime: string, alias: 'opus' | 'sonnet' | 'haiku'): RuntimeTierEntry | null {
|
|
return catalog.runtimeTierDefaults[runtime]?.[alias] ?? null;
|
|
}
|
|
|
|
export function runtimesWithReasoningEffort(): Set<string> {
|
|
return new Set(
|
|
Object.entries(catalog.runtimeTierDefaults)
|
|
.filter(([, tiers]) => Object.values(tiers).some((entry) => entry && entry.reasoning_effort))
|
|
.map(([runtime]) => runtime)
|
|
);
|
|
}
|