Developer Architecture
This guide is the local starting point for Flow Agents maintainers who need to understand how this repository coordinates with Flow, Surface, Veritas, and Builder Kit. It describes the architecture from the Flow Agents side only; product-specific runtime details remain in their owning products.
Orientation
Flow Agents is the agent-facing operating layer. It turns a user’s intent into workflow skills, local artifacts, sidecars, checks, and handoffs that a human or another agent can inspect later.
Current state: Flow Agents owns the portable agent bundle, skills, contracts, local workflow artifacts, runtime-specific exports, provider wiring, and validation scripts in this repository.
Future direction: Flow, Surface, Veritas, Builder Kit, and other Kontour products should continue converging on shared resource shapes and gate vocabulary without making this repository the owner of every product’s runtime semantics.
Use these local references when you need more detail:
- Context glossary defines Flow Agents vocabulary.
- Repository Structure is the canonical map for source, generated output, runtime state, packaging, eval, and cleanup boundaries.
- ADR 0003 records the kit and adapter boundary.
- ADR 0005 records the Kontour Resource Contract direction.
- Kontour Resource Contract documents the shared durable record shape.
- Flow Kit Repository Contract documents local kit validation and activation boundaries.
- Veritas Integration Boundary documents optional governance evidence.
Coordination Map
flowchart LR
User[User intent]
Runtime[Agent runtime<br/>Codex, Claude Code, Kiro, CI]
Skills[Flow Agents skills]
Sidecars[Workflow artifacts<br/>and sidecars]
RuntimeAdapters[Runtime adapters<br/>and export]
ProviderAdapters[Provider adapters<br/>GitHub, local files, future providers]
Flow[Flow<br/>workflow semantics]
Builder[Builder Kit<br/>build workflows]
Veritas[Veritas<br/>governance evidence]
Surface[Surface<br/>portable trust state]
User --> Runtime --> Skills --> Sidecars
Skills --> RuntimeAdapters
Skills --> ProviderAdapters
RuntimeAdapters --> Runtime
Sidecars --> ProviderAdapters
Skills -. delegates workflow semantics .-> Flow
Skills -. activates Flow Kit assets .-> Builder
Skills -. records optional evidence .-> Veritas
Skills -. references trust claims .-> Surface
Veritas -. may produce .-> Surface
Builder -. uses Flow definitions .-> Flow
Current state: Flow Agents coordinates local agent workflows with Markdown session artifacts, JSON sidecars, scripts, evals, and local docs. It validates Flow Kit repository shape and activates supported local Flow Definition assets for the implemented codex-local adapter.
Future direction: Flow should own authoritative workflow semantics, route decisions, gate enforcement, and Flow Definition validation. Flow Agents should stay the projection layer that makes those workflows usable inside agent runtimes and provider-backed workspaces.
Ownership Boundaries
| Product | Owns | Flow Agents boundary |
|---|---|---|
| Flow Agents | Agent-facing workflow bundles, skills, sidecars, artifact contracts, evals, runtime export, provider wiring, and local-first docs. | Does not become the core workflow engine for all Kontour products and should not copy product-native rule models into this repo. |
| Flow | Generic workflow semantics, Flow Definitions, gate transitions, attempts, route-back behavior, Flow Runs, and Flow Reports. | Flow Agents may consume or project Flow concepts, but Flow owns enforcement semantics once the Flow surface is available. |
| Builder Kit | The first Kontour-authored Flow Kit for build work: shaping, pickup probes, planning, execution, review, verification, publication, release readiness, and learning workflows. | Flow Agents validates, installs, activates, and routes Builder Kit assets; it does not make every Builder Kit specialization a core Flow Agents concept. |
| Veritas | Repo-local standards, authority settings, policy/rule checks, and native governance reports. | Flow Agents records compact Veritas evidence references when configured; Veritas is optional and not a mandatory dependency for every workflow. |
| Surface | Portable trust state, claims, TrustReports, Trust Snapshots, and user-facing trust surfaces. | Flow Agents can reference Surface-shaped claims for gates, but Surface owns claim models and trust presentation. |
Current state: Builder Kit is the first proof point for extracting out-of-the-box behavior into normal Flow Kits. Veritas integration is documented as optional and adapter-driven. Surface references appear as a trust-state boundary in local Veritas and Builder Kit evidence docs.
Future direction: Flow Agents should support more runtime adapters, provider adapters, and Flow Kits without forcing all users to install Builder Kit, Veritas, Surface, or a specific hosted provider.
Artifact And Evidence Flow
flowchart TB
Idea[Idea or request]
Backlog[Backlog / Work Item]
Probe[Alignment / Pickup Probe]
Plan[Run Plan or Execution Plan]
Execute[Execution]
Review[Review]
Verify[Verification]
Evidence[Evidence Gate]
Release[Release Gate]
Learn[Learning]
Artifacts[(Markdown artifacts)]
Sidecars[(JSON sidecars)]
Providers[(Provider records)]
Governance[(Optional governance evidence)]
Trust[(Optional Surface trust claim)]
Idea --> Backlog --> Probe --> Plan --> Execute --> Review --> Verify --> Evidence --> Release --> Learn
Plan --> Artifacts
Execute --> Artifacts
Review --> Sidecars
Verify --> Sidecars
Evidence --> Sidecars
Release --> Providers
Evidence --> Governance
Governance --> Trust
Trust --> Evidence
Review -->|finding| Execute
Verify -->|gap| Execute
Evidence -->|missing evidence| Plan
Current state: The durable handoff surface is a pair of human-readable Markdown artifacts and machine-readable JSON sidecars under .flow-agents/<slug>/. Verification, critique, release, and learning records are explicit artifacts rather than hidden chat memory.
Future direction: Durable workflow state should converge toward Kontour Resource Contracts with versioned identity, desired state, observed status, and condition summaries. That convergence should preserve local files and provider-backed records as first-class surfaces.
Local Workflow Roles
Flow Agents workflows separate selection, planning, execution, critique, verification, evidence, release, and learning so each stage leaves inspectable state.
Current state:
pull-workselects work, checks WIP and dependency context, and records the pickup decision.plan-workproduces an execution plan with acceptance criteria, scope, risks, and verification expectations.execute-planimplements the approved plan and records modified files.review-workandverify-workproduce report-only critique and evidence.evidence-gate,release-readiness, andlearning-reviewdecide whether the work is trustworthy, acceptable, and worth feeding back into the system.
Future direction: Flow-owned runs and gates should be able to supply the same structure to local agents, CI agents, and hosted control planes without depending on a particular chat runtime.
Resource Contract Alignment
Kontour Resource Contracts provide the shared shape for durable records that cross product or adapter boundaries.
Current state: Flow Agents already uses local workflow artifacts and sidecars as the operational handoff surface. New shared contracts should prefer the Kontour Resource Contract shape unless a product records a specific exception.
Future direction: Active Workflow Runs, Selected Scope, Gate status, provider evidence, Surface claims, and Veritas report pointers should become easier to compare because they use compatible identity, metadata, desired intent, observed status, and condition-style summaries.
Reading Order For Contributors
Start here, then follow the local docs in this order:
- Workflow Usage Guide for the user-facing delivery path.
- Repository Structure for where changes belong and what is generated or runtime-only.
- Skills Map for workflow phase composition.
- Workflow Artifact Lifecycle for what stays local, what gets promoted, and what must not be merged.
- Flow Kit Repository Contract for kit repository validation and activation behavior.
- Veritas Integration Boundary for optional governance evidence.
- Developer Reference for generated repository structure, commands, agents, skills, scripts, and contracts.