Skip to main content
Glama

run_pipeline

Chains verified design tools in dependency order to turn a netlist and product spec into a flashable HAL skeleton and machine-checked acceptance spec, collecting unresolved gaps for build/verify.

Instructions

Spec-to-silicon capstone (Pillar G): run the whole deterministic DESIGN half in one call. Chains the existing, individually verified tools in dependency order -- import_netlist? -> import_spec? -> design_framework -> solve_clock_tree? -> solve_timer? -> render_framework -> synthesize_acceptance -- turning a netlist plus a product spec into a flashable HAL skeleton and a machine-checked acceptance spec, then hands off to the build/verify loop. Optional stages (marked ?) run only when their input is present. Honest by construction: it GUESSES NOTHING -- it sequences verified tools and aggregates every stage's own unresolved/conflict gaps into one 'human decisions / data still needed' list. A required-stage hard error (no board, invalid input) stops with pipeline_status=blocked at that stage; expected gaps (an AF needing a pin DB, an unmodelled clock) surface as complete_with_unresolved; a clean run is complete. Operates on the session's board unless netlist= is supplied.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
specNoProduct spec object to import and design from (import_spec).
styleNoRender style for the framework skeleton (default hal).
af_mapNoAlternate-function map for GPIO AF resolution {line_or_family: {port_pin: {'PERIPH_SIG': af}}}.
designNoPeripheral config overrides merged into the design {PERIPH: {..}}.
sourceNoClock source for solve_clock_tree (e.g. hse/hsi).
db_pathNoPath to a pin-capability DB for AF resolution (else STM32_GDB_MCP_PIN_DB).
irq_mapNoIRQ-number map for NVIC acceptance checks {line_or_family: {irq_name: number}}.
netlistNoNetlist to import first: {path|text, format?}. Omit to use the board already in this session.
sessionNoOptional debug-session name. Omit for the default target.
gpio_mapNoGPIO base-address map for pin acceptance checks {line_or_family: {port_letter: base_address}}.
source_hzNoClock source frequency in Hz for solve_clock_tree.
sysclk_hzNoTarget SYSCLK in Hz; presence enables the solve_clock_tree stage.
need_48mhzNoRequire a 48 MHz domain (USB/SDMMC) in the clock solve.
stopped_atNoSymbol the acceptance spec should assert the core halts at.
synthesizeNoSet false to stop after render_framework and skip acceptance synthesis (default true).
register_mapNoClock-enable register map for acceptance placement {line_or_family: {clock: {address, bit}}}.
acceptance_nameNoName for the derived acceptance spec.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.15.1

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only cover safety flags (readOnlyHint=false, destructiveHint=false, idempotentHint=false). The description adds substantial behavior beyond them: the status outcomes (pipeline_status=blocked, complete_with_unresolved, complete), the error-vs-gap distinction, and the guarantee that it 'GUESSES NOTHING' and aggregates unresolved gaps into one human-decision list.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the chained-tool sequence are front-loaded, and every sentence carries operational content. It is dense rather than padded, though the 'Honest by construction' framing is slightly rhetorical and the run is long for a single description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 17-parameter, no-output-schema capstone tool, the description supplies what is otherwise missing: the stage order, the fallback behavior of netlist=, and the terminal status values an agent must interpret. Nothing critical to invoking or reading results is absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3; the description adds conditional semantics by explaining that optional stages ('?') run only when their input is present and that omitting netlist= falls back to the session board. It does not go further into per-parameter interaction, so it sits just above baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('run the whole deterministic DESIGN half in one call') and explicitly enumerates the chained stages, so an agent can distinguish it from the individually-verified siblings (import_netlist, design_framework, render_framework, synthesize_acceptance). It also names the output ('a flashable HAL skeleton and a machine-checked acceptance spec').

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear context for when to use this over the individual tools ('run the whole deterministic DESIGN half in one call') and explains that optional stages run only when their input is present, plus the netlist= override for the session board. It stops short of explicitly naming when NOT to use it (e.g., when you only need one stage).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.