|
| 1 | +# superflow-builder |
| 2 | + |
| 3 | +A git-native ([openGAP](https://github.com/open-gitagent/opengap)) agent that writes superflow JSON workflows for the superflow engine. |
| 4 | + |
| 5 | +## What it does |
| 6 | + |
| 7 | +Takes a process description — phase-by-phase blueprint, natural-language sketch, or feature request — and produces a single, executable workflow JSON. Designs against the real executor contracts (parameter shapes, expression semantics, durable-execution constraints) so the output runs end-to-end on the first try. |
| 8 | + |
| 9 | +## What it produces |
| 10 | + |
| 11 | +- The full workflow JSON printed inline in the response (fenced as ` ```json `) — copy-paste straight into your engine, pipe to a file, or hand to a Studio import |
| 12 | +- A short narrative: trigger source, phase-by-phase data flow, what verdict the mock data lands at, and the one-line edits to flip between demo paths |
| 13 | +- File output on request — pass an explicit target path and the agent writes it instead of (or in addition to) the inline JSON |
| 14 | + |
| 15 | +## When to use it |
| 16 | + |
| 17 | +- Building a new workflow from a product spec or process blueprint |
| 18 | +- Adapting an existing workflow when the engine's executors gain new capabilities |
| 19 | +- Debugging a workflow that "passed locally but fails in production" — the agent knows the durable-mode rules cold |
| 20 | +- Writing demo flows for stakeholders where the verdict path must be deterministic |
| 21 | + |
| 22 | +## Key capabilities |
| 23 | + |
| 24 | +- **DAG composition** — fan-out, convergence, sibling parallelism, multi-output routing |
| 25 | +- **Code node semantics** — goja sandbox, last-expression return, input identification by predicate |
| 26 | +- **Expression engine** — `{{ }}` template substitution and the JS reference patterns it supports |
| 27 | +- **HITL approval mechanics** — form schemas, durable awakeables, approval/rejection routing |
| 28 | +- **HTTP body preservation patterns** — echo through body, second-parent edge |
| 29 | +- **Demo mock-data design** — deterministic test inputs that exercise specific verdict paths |
| 30 | + |
| 31 | +## Structure |
| 32 | + |
| 33 | +``` |
| 34 | +superflow-builder/ |
| 35 | +├── agent.yaml # Manifest (model, skills, runtime) |
| 36 | +├── SOUL.md # Identity and collaboration style |
| 37 | +├── RULES.md # Hard constraints (must always / must never) |
| 38 | +├── PROMPT.md # Default task framing and output format |
| 39 | +├── AGENTS.md # Framework-agnostic fallback instructions |
| 40 | +├── README.md |
| 41 | +└── skills/ |
| 42 | + └── superflow/ |
| 43 | + └── SKILL.md # Node-type registry, contracts, patterns, gotchas |
| 44 | +``` |
| 45 | + |
| 46 | +## Compatible runtimes |
| 47 | + |
| 48 | +Any framework that supports openGAP-format agents. Confirmed: Claude Code (via the `superflow` skill loaded into `~/.claude/skills/` or invoked via the Skill tool). The standard's framework-agnostic fallback (`AGENTS.md`) supports OpenAI, LangChain, CrewAI, AutoGen, and others. |
| 49 | + |
| 50 | +## License |
| 51 | + |
| 52 | +MIT |
0 commit comments