For AI agents: the complete documentation index is available at https://flow.jig.md/llms.txt, the full documentation bundle is available at https://flow.jig.md/llms-full.txt, and this page is available as Markdown at https://flow.jig.md/spec/run-protocol.md.
DocumentationSpecificationPrerelease

#FLOW Run/1

View Markdown

Status: prerelease specification candidate.

Run/1 is the finite executable boundary for a FLOW package. It deliberately does not expose a host's durable records, resolver, authority evidence, graph model, provider identities, or application ontology.

Invocation and cancellation use:

host -> component       flow/run
component -> host       flow/run-child
component -> host       capability/call
either direction        request/cancel

The channel extension adds component-to-host channel/create, channel/subscribe, channel/send, channel/next, channel/close, and channel/release. Channels carry bounded JSON values during work; they do not start work, authorize control operations, or replace invocation results.

flow/run supplies the complete context to an already selected component. flow/run-child asks the host to resolve an admitted child slot and construct another invocation. They have distinct parameter shapes, not an overloaded method selected by direction. The method name grants no authority; the host enforces the caller's existing invocation authority before child dispatch.

The end-to-end operation is Flow A running Flow B through the host:

host   -> Flow A: flow/run        (context for A)
Flow A -> host:   flow/run-child  (slot, operation identity, input)
host   -> Flow B: flow/run        (context for B)

A child is an invocation relationship, not a different kind of Flow package. Every component receives the same flow/run entry request.

#1. Process and framing

One component process handles exactly one root flow/run request. The channel is full-duplex JSON-RPC 2.0 over stdio. Here "root" means the owner request on this component's channel, including when the host launched it as a child:

stdin     protocol frames only
stdout    protocol frames only
stderr    unstructured diagnostics only

Each stdin or stdout frame is one JSON object encoded as UTF-8 and terminated by one LF byte. The LF is not part of the frame payload. A frame has at most 16,777,216 bytes before LF. Empty frames, JSON-RPC batches, a BOM, invalid UTF-8, duplicate object members, lone Unicode surrogates, and values outside FLOW JSON/1 are invalid. EOF after nonempty bytes without LF is an incomplete frame.

Both peers keep their reader active while awaiting responses. Writes are serialized and flushed. A component may have at most 64 component-originated requests awaiting responses at once; an SDK may queue additional calls rather than put them on the wire. A host sends exactly one flow/run request.

Request IDs are 1–128 byte ASCII tokens matching:

[A-Za-z0-9][A-Za-z0-9._:/-]*

Each sender chooses its own ID namespace and never reuses an ID during one channel incarnation, including after the request settles. Opposite directions may coincidentally use the same spelling. IDs correlate wire messages only; they are not durable Run or operation identities. Numeric and null request IDs are invalid in Run/1.

Each sender may originate at most 65,536 request-form messages during one channel incarnation. Settled and cancelled requests still consume this lifetime budget; responses and notifications do not. A request with a fresh, structurally valid ID consumes the budget before method dispatch, including when its method is unknown or its method params are invalid. A conforming SDK rejects an attempted 65,537th outbound request locally with RESOURCE_EXHAUSTED and emits no frame, so its root handler may recover. A receiver which observes a 65,537th request records a fatal PROTOCOL_ERROR and closes without relying on another response. This fixed lifetime bound is separate from the limit of 64 unresolved component requests on the wire.

Channel implementations reserve at least one simultaneous request slot and enough remaining request IDs to close/release already allocated endpoints and pending allocations. Ordinary admission stops before consuming these reserves. Repeated failed settlement attempts cannot consume unlimited reserved capacity. Cancellation, host revocation and fencing never depend on a free ordinary slot.

Whenever a request or notification includes params, that member must be a JSON object or array. null and scalar params make the complete JSON-RPC envelope invalid; they are not method-level invalid parameters.

An unknown well-formed request method receives JSON-RPC -32601. A recognized request with invalid params receives -32602. Unknown notifications are ignored. The direction restrictions in this specification are part of method validity.

For a complete, bounded, LF-terminated, valid-UTF-8 frame which fails JSON/1, a peer should best-effort send -32700 with id: null, flush, and close. This includes JSON syntax errors, a BOM, duplicate members, lone surrogates, and out-of-domain JSON/1 numbers or value bounds. For a parsed batch, non-object, or invalid JSON-RPC envelope it should best-effort send -32600 with id: null or an unambiguous valid ID, then close. Invalid UTF-8, an oversized or incomplete frame, an unknown/duplicate response, reuse of a request ID, and a failed write close the channel without relying on another frame.

Every fatal close stops admission, cancels owned work, and fails local pending calls under this exact split:

  • PROTOCOL_ERROR means a detected framing, JSON/1, envelope, correlation, or protocol-state violation by the peer;
  • CHANNEL_LOST means EOF, read/write failure, or transport loss without a detected peer-protocol violation.

A valid standard JSON-RPC error received in response to a correctly emitted Run/1 request proves that the peers disagree about the fixed protocol. It is a fatal PROTOCOL_ERROR, not a per-call OperationError. A peer must never rely on a best-effort error frame arriving over a corrupted channel.

State-dependent request handling is fixed as follows:

InputReceiver behavior
Request-form method unavailable in this direction, including request-form request/cancelRespond -32601; the channel may continue.
Notification other than a valid request/cancel, including notification-form request methodsIgnore it.
Recognized method with invalid paramsRespond -32602. An invalid root request then ends the one-Run component process.
Second flow/runBest-effort -32600, then fatal PROTOCOL_ERROR.
flow/run-child or capability/call without a pending root ownerRespond OWNER_CLOSED; do not dispatch.
65th simultaneously pending component requestRespond RESOURCE_EXHAUSTED to that request; do not dispatch it.
65,537th request originated by one peer during the channel lifetimeFatal PROTOCOL_ERROR; do not dispatch it or rely on a response.
Component frame after its root terminal responseFatal PROTOCOL_ERROR; any buffered success is invalidated.

After sending its root terminal response, a component may immediately stop reading and exit. A host which sends later traffic is itself nonconforming and cannot require a response.

#2. Shared names and values

slot, method, declared effect-error name, and Run outcome use the Package/1 LocalName grammar:

[a-z0-9]+(?:-[a-z0-9]+)*

Their length is 1–64 ASCII characters. Whether an outcome is done or one of the package's declared custom outcomes is checked against the exact package, not inferred from this wire grammar.

operationId uses the request-ID token grammar and limit. It is stable semantic identity chosen by component code, not a transport ID generated by an SDK.

All input, output, settings, effect values, error data, and error details are bounded JSON/1 values. settings is always an object. Output and declared effect-error data are required; use null when no more meaningful value exists.

deadlineUnixMs is a nonnegative JSON/1 safe integer containing the host-authoritative UTC Unix epoch deadline in milliseconds. It is advisory to component cleanup; the host remains responsible for cancellation and enforced termination. Child Flow and effect calls inherit the remaining root deadline and cannot supply or widen one.

#3. flow/run

The host's only request is:

{
  "jsonrpc": "2.0",
  "id": "host:1",
  "method": "flow/run",
  "params": {
    "protocol": "run/1",
    "input": {},
    "settings": {},
    "attachments": {
      "source": {
        "path": "/workspace/source",
        "access": "read"
      }
    },
    "scratch": "/workspace/scratch",
    "deadlineUnixMs": 1787558400000
  }
}

params has these required fields and optional channels:

FieldMeaning
protocolExact literal run/1; a cheap activation-mismatch guard, not negotiation.
inputActual invocation input.
settingsComplete invocation-stable configured settings object.
attachmentsMap from LocalName to one sandbox-local root and access mode.
scratchNonempty sandbox-local private read-write root path.
deadlineUnixMsFinite host-enforced root deadline.

channels, when present, maps at most 256 LocalName entries to distinct host-granted endpoints defined below. Absence means an empty map.

Each attachment has exactly:

{
  "path": "/sandbox/path",
  "access": "read"
}

path is a nonempty runtime-native path inside the already prepared sandbox. access is exactly read or read-write. The outer execution envelope, not an SDK path helper, enforces the view. One Run has at most 256 named attachments.

There is no Run ID, parent ID, trigger field, correlation field, provider identity, slot inventory, enforcement receipt, or negotiated limit object in Run/1. A triggering fact belongs in input; lifecycle and authority evidence remain host-side.

A successful result is exactly:

{
  "outcome": "done",
  "output": null
}

Protocol, execution, cancellation, deadline, provider, or uncertainty failures are JSON-RPC failures. They never masquerade as package outcomes.

#4. flow/run-child

While its root request is pending, the component may issue child Flow requests:

{
  "jsonrpc": "2.0",
  "id": "component:1",
  "method": "flow/run-child",
  "params": {
    "operationId": "research:1",
    "slot": "research",
    "intent": "Find and justify a suitable comparison target.",
    "input": {}
  }
}

operationId, slot, and input are required. Here slot is the consumer-local name of one child-Flow resolution slot admitted by the host. It is not a capability slot and is not declared in FLOW.md uses; child-Flow targets and candidate sets are host configuration outside Package/1. intent is an optional 1–16,384 scalar string. It describes the requested work for that already admitted slot; it does not name candidates, configure a resolver, grant catalogue access, or widen authority. Exact host binding still wins, and an absent intent never means catalogue-wide discovery. It is not delivered to the child unless component code also includes that information in input. Optional channels maps the callee's declared channel names to held endpoint reference strings.

Success returns the same complete { outcome, output } value as flow/run. Run/1 carries bounded JSON/1 input and explicitly mapped channel rights into the requested operation and returns its complete JSON/1 Run result. It does not define how a host selects or configures the admitted child. Nested execution is a host operation, not graph merging or implicit settings, attachment, or authority inheritance. Hosts may impose smaller concurrency or retained-result budgets and report RESOURCE_EXHAUSTED; the Run/1 identity, replay, cancellation, and lifetime rules still apply.

#5. capability/call

While its root request is pending, the component may call one method through a bound capability slot. Unlike a flow/run-child slot, this slot is a capability dependency declared by the package's FLOW.md uses entry:

{
  "jsonrpc": "2.0",
  "id": "component:2",
  "method": "capability/call",
  "params": {
    "operationId": "artifact-write:1",
    "slot": "artifacts",
    "method": "write",
    "input": {}
  }
}

The params have the four shown fields and optional channels, using the same endpoint-reference mapping as child calls. A successful capability method returns exactly one of:

{ "value": null }
{
  "error": {
    "name": "not-found",
    "data": {}
  }
}

The second form is an application error declared by the exact capability contract, not a JSON-RPC error. Both value and error, neither member, an unknown member, or missing error data is invalid.

#5.1 Channels

This extension supports finite, single-writer JSON/1 sequences. A direct source has one receiver; a broadcast source has independently bounded subscriptions. Arbitrary byte transports, persistent streams and continuing Agent control are not part of this extension.

An endpoint grant is a closed object:

FieldMeaning
endpointOpaque reference using the request-ID token grammar, bound to the receiving invocation
directionsend or receive
deliverydirect or broadcast
contractOptional exact {id, version, digest} Channel Contract/1 source identity
startSequenceRequired positive JSON/1 integer for receivers; 1 for direct delivery; absent for senders

Endpoint possession grants only the indicated communication right. It is not portable JSON authority: a string copied into ordinary input grants nothing. The creating Run owns the source's lifetime. An unused endpoint may transfer through an exact child or capability call; its cleanup owner does not change. First local use claims a right. Inspecting metadata does not claim it.

Broadcast creation also grants subscription authority to the creating invocation only. Its opaque source reference uses the endpoint token grammar but is not an endpoint and cannot be transferred in a call map. Moving a writer does not move subscription authority. Each successful subscription allocates a distinct reader starting at the next accepted sequence. Late subscriptions receive no history; preallocated readers may lag even before their first read. Source sealing or failure prevents new subscriptions. All allocations count over the owner's lifetime; releasing one does not replenish that allowance.

Before dispatch, the host atomically validates all mapped rights, declaration requirements, contracts, provider support, delivery, queued-prefix constraints and capacity, then moves the rights and constructs the callee's grants. Rejected admission changes no rights. Exact operation joins precede moved-right rejection; changed mappings conflict. An SDK offer or failed final result does not establish whether rights moved. The host retains authoritative ownership. No cross-root connection, ambient lookup or late injection into an ungranted running participant is implied.

Disposing a receiver does not revoke its peer's unused send right. While the source owner remains live and the source is neither failed nor sealed, that sender remains transferable under the same checks, even after receiver disposal. For direct delivery, its sends and close still fail DISCONNECTED; transfer cannot revive delivery. Broadcast delivery continues for other readers and permits later subscriptions while the source remains open. A disposed receiver is not transferable. Required ports require a grant, not a guarantee that the peer remains available. This keeps observation disposal independent of whether producer admission wins or loses that race.

RequestClosed parametersSuccessful result
channel/createOptional delivery: "direct" or "broadcast"; optional schema or package-local contract, mutually exclusiveDirect: {send: grant, receive: grant}; broadcast: {send: grant, source: opaqueReference}
channel/subscribe{source: opaqueReference}One broadcast receive grant owned by the creating invocation
channel/send{endpoint, value}null: validated, snapshotted host acceptance, not processing or durability
channel/next{endpoint}{item: {sequence, value}} or {end: {lastSequence}}
channel/close{endpoint}null: writer sealed
channel/release{endpoint}{status: "released"}, {status: "ended", lastSequence}, or {status: "failed", code, details?}

Creation defaults to direct delivery and generic JSON/1. Schemas use Schema/1; named references resolve only against the invoking package. Unsupported valid requests fail operationally before allocation or dispatch. Invalid RPC shapes retain the ordinary incompatibility rules.

The host assigns accepted sequences starting at one. Receivers validate a contiguous interval from their immutable startSequence; a clean end equals the last delivered sequence (startSequence - 1 for an empty interval). There is one outstanding read and no SDK prefetch. Direct full queues exert bounded sender pressure; receiver disposal rejects pending and future sends with DISCONNECTED.

Broadcast acceptance does not wait for readers. A reader exceeding its capacity fails with sticky LAGGED, independently of the writer and other readers. A reader-schema failure likewise affects only that subscription. With no readers, accepted values advance sequence and source byte budget but are not retained. Source-invalid or oversized values instead fail the entire source before acceptance. Source/writer constraints apply before per-reader validation; adding a reader never adds its validator to a broadcast source. Connection admission still rejects known conflicting nontrivial writer/reader schemas in either binding order, including all staged mappings and existing live subscribers. The host bounds queues, retained/in-flight payload, pending sends, parser/writer buffers and lifetime allocations. A committed but unread response consumes receiver capacity until the next read releases its credit.

Writer close rejects while sends remain unaccepted; otherwise it seals without waiting for the receiver or execution result. Accepted data can drain while the source owner lives. Failure before sealing aborts the source. Previously explicitly sealed intervals remain sealed despite subsequent producer failure; neither sealing nor receiver EOF establishes execution success.

Failure discards only uncommitted queued values. A committed read response may still arrive; the next read or release reports the sticky cause. Revocation and clean-end commitment are atomically ordered by the host. Local read cancellation may win before SDK end exposure. Root cancellation independently prevents execution success.

Cancelling an active read disposes its receiver. The SDK retains and drains the original read response and disposal response; it cannot restart iteration after silently skipping a committed item. Cancelling a send retracts only an unaccepted pending value, never an accepted value or permission to replay it. Cancelling a close/release wait retains its settlement action.

Cancelling a creation or subscription wait does not prove that no allocation occurred. The SDK retains the wire response and disposes any late grants before completion; it cannot lose or replay an uncertain allocation. A newly allocated broadcast receiver is active owned work even if never read. Its holder must finish or dispose it; finalization cannot silently turn abandonment into success.

Uncancelled receiver disposal waits for its response and all prior reads. It exposes a previously unexposed terminal failure even if a read waiter was cancelled before that failure arrived. An internally known cause is not exposed until a public operation rejects/raises with it. Repeated disposal joins the same action and does not rethrow an already exposed cause. Disposal that wins before an earlier source failure means deliberate incomplete delivery, not a new failure. Observation cancellation does not cancel producer execution.

Independent readers/writers must remain serviced while operations are pending. A blocked transport cannot prevent other participants' progress or host fencing. Control has priority only between complete frames; no delivery is promised over a broken or persistently blocked pipe.

#6. Operation identity

operationId is scoped to the one root Run. For observable Run/1 behavior:

same operationId + same canonical method/params
    joins or returns the same operation result

same operationId + different canonical method/params
    OPERATION_CONFLICT before another dispatch

The canonical comparison includes flow/run-child or capability/call, slot, method when present, intent and channel mappings when present, and input. Transport IDs and wait timing are not semantic input. The host chooses its persistence strategy; Run/1 does not standardize a ledger schema, activation digest, internal lifetime IDs, or recovery database.

Each transport request is one waiter even when several requests join the same operation. Cancelling one request settles or removes only that waiter; it does not cancel another waiter. The receiver may request cancellation of shared underlying work only after no live waiter remains. A terminal operation result which won the receiver's atomic race may still settle a concurrent cancellation; otherwise the cancelled waiter receives CANCELLED while other waiters remain attached.

An operation is never automatically replayed after unprovable dispatch. Uncertain completion is returned as UNCERTAIN. A deliberate new attempt uses a new operationId.

#7. Errors

Run/1 uses standard JSON-RPC -32700, -32600, -32601, -32602, and -32603 with their standard meanings. Operational failures use numeric code -32000 and this exact data shape:

{
  "code": "UNAVAILABLE",
  "details": null
}

details is optional bounded JSON/1 diagnostic data. message is required by JSON-RPC, contains 1–1,024 Unicode scalar values, and is non-normative human text. The closed wire-visible code set is:

CodeNormative meaning
CANCELLEDCooperative cancellation won the terminal race.
DEADLINE_EXCEEDEDThe host-authoritative deadline won the terminal race.
OWNER_CLOSEDThe root stopped admitting owned work before this operation could be admitted or settled.
OPERATION_CONFLICTThe operation ID was already used with different canonical method or params.
UNAVAILABLENo admitted target or provider was callable for this operation.
PERMISSION_DENIEDHost authority policy refused the requested operation.
RESOURCE_EXHAUSTEDA declared protocol or host capacity bound prevented admission or completion.
INVALID_INPUTApplication input failed the selected Flow or capability's declared validation after the Run/1 envelope was valid.
INVALID_RESULTA component, child Flow, or capability produced an invalid declared result.
UNCERTAINDispatch may have occurred, but a trustworthy terminal result cannot be proved.
EXECUTION_FAILEDAdmitted application work failed and no narrower code above applies.
LAGGEDChannel delivery failed because its bounded observation capacity was exceeded.
DISCONNECTEDThe connected receiver was disposed or its communication right ended.

JSON-RPC -32602 means the Run/1 method params themselves are invalid; INVALID_INPUT is downstream application validation. JSON-RPC -32603 means the peer failed while processing the protocol; EXECUTION_FAILED means the admitted application work failed.

Every request has one atomic terminal decision. A committed result or error wins a later cancellation or deadline observation. Otherwise the first recorded cancellation/deadline terminal condition determines CANCELLED or DEADLINE_EXCEEDED; no peer sends two terminal responses.

That decision fixes the request-level result or error. Overall Run acceptance also requires the clean process completion described in Section 9.

Host-internal distinctions such as which host binding, provider, runtime selection, or execution envelope was unavailable belong in durable host diagnostics, not the portable error taxonomy. Activation failures which occur before a channel exists are not Run/1 errors.

PROTOCOL_ERROR and CHANNEL_LOST are local terminal classifications, not -32000 values sent over a channel which can no longer be trusted. The machine-readable registry is run-1-errors.json.

#8. Cancellation

The originator of a pending request may send this notification:

{
  "jsonrpc": "2.0",
  "method": "request/cancel",
  "params": {
    "requestId": "component:1"
  }
}

It has no id and receives no response. A valid target must have been originated by the notifier on this channel. Duplicate, stale, already-terminal, unknown, and opposite-direction targets are harmless no-ops because response and cancellation may race. A malformed cancellation notification is fatal: the sender cannot safely assume it requested cancellation.

Cancellation closes new work for that request and asks the receiver to stop. It does not prove that dispatched external work was undone. The original request still receives at most one eventual result or error if the channel survives.

Root cancellation applies to the complete component-owned subtree. An SDK must propagate it to the handler and cancel its pending outbound waits. The host enforces the deadline and terminates an uncooperative process after its private grace policy.

#9. Completion and exit

The component admits outbound calls only while flow/run is pending. It must settle every outbound request before returning the root result or error. Calls cannot be detached, reparented, or transferred. A normal root response with outstanding owned work cannot become success.

Recoverable settled failures use ordinary language recovery; there is no error acknowledgement or global settled-failure ledger. An ignored, already-settled recoverable failure may escape detection. Fatal loss of this invocation's transport, root cancellation, unresolved ownership or failed cleanup still prevent success. A child that is conclusively fenced and cleaned may instead return a recoverable parent-local operational error; fatality follows the affected owner, not a word in an error message.

Before implicit writer sealing, account for handler error or invalid result, fatal/cancellation state, abandoned live work and active unfinished receivers. Capture abandonment at handler settlement; cleanup does not erase it. Resolve retained cancellation/disposal accounting and recheck eligibility. The host, which knows actual endpoint transfers and source state, seals only healthy held writers after eligibility; a known disqualifier aborts unsealed sources. A wholly unused unconnected pair can be released automatically. An activated receiver must reach end, terminal failure or explicit disposal. Recheck fatal and cancellation state before accepting the execution terminal.

The host must keep the component's stdin open while the root request is pending. After receiving and validating the complete root terminal response, it may close that sending half immediately. The component must tolerate this causally later half-close.

Component stdin and stdout are independent byte streams; Run/1 infers no physical wall-clock ordering between them. The component locally linearizes a terminal response by claiming publication immediately before its serialized transport write begins. An stdin EOF, framing failure, or fatal protocol condition prevents the root response only when the component's protocol state machine atomically claims it before that publication claim. Once publication has started, later stdin state cannot overturn it: the complete write and runtime-buffer flush wins, while a write failure is CHANNEL_LOST. Flush is not fsync, a peer acknowledgement, or proof that the host received the frame. Kernel or runtime buffering does not establish cross-pipe order; bytes merely read or queued by the transport have no priority. After publication starts, the component may stop reading; unread or subsequently observed host input has no response guarantee.

After receiving a root response, the host continues draining component stdout and awaits process termination. It accepts the Run only when the response is valid and correlated, no component-originated request remains pending, stdout ends on a frame boundary with no trailing bytes or frames, and the process exits zero. The supervising host classifies premature termination deterministically:

  • a host-enforced kill after a recorded cancellation or deadline is CANCELLED or DEADLINE_EXCEEDED respectively, unless a terminal response had already won;
  • a detected peer-protocol violation is PROTOCOL_ERROR;
  • a nonzero process exit without either condition is EXECUTION_FAILED;
  • component-stdout EOF, transport loss, or a zero exit before a complete response is CHANNEL_LOST.

A response fixes the request decision but does not by itself satisfy those acceptance conditions. A nonzero exit, pending owned work, invalid output, trailing component bytes or frames, or a post-response shutdown kill prevents overall success. A post-response shutdown kill is an EXECUTION_FAILED lifecycle failure rather than a later cancellation or request deadline winning the already-fixed request decision. Cleanup failure must surface through process exit; there is no hidden cleanup-acknowledgement protocol.

#10. Machine interface and SDK projection

The closed message schema is run-1.json. Direction and response correlation remain protocol state and cannot be proven by a context-free JSON Schema document. Framing and JSON/1 validation happen before schema validation.

The TypeScript package @jigging/flow and Python distribution/import jiggy-flow/jiggy.flow expose the same semantic surface:

handle(handler)
RunContext
RunResult
runChildFlow / run_child_flow
callCapability / call_capability
channel / channels and directional endpoint types
OperationError
CapabilityError
JSON value types

They do not expose JSON-RPC envelopes, transport IDs, pending tables, resolution, host bindings, providers, schema loading, sandboxes, administration controls, Services, Agents, or graph types. operationId remains caller-supplied.

The exact language projections and their cancellation/error behavior are closed in Run SDK/1.

The corpus under conformance/run-1/ provides executable evidence for this candidate through separately implemented TypeScript and Python participants. Passing that repository corpus is not a certification of a third-party implementation.