Workflow Engine Protocol

Workflow Engine Protocol

Prepares, runs, and operates workflow executables for the workflow control plane.

Field	Value
Protocol ID	aster.workflow-engine
Version	2.0.0
Compatibility range	^2.0.0
Requirement helper	aster.workflow-engine.require(settings?) via the protocol module
Provider helper	Not available until the protocol module declares a runtime service tag.

Settings

DefaultProtocolSettingsSchema (Record<string, unknown> | null).

Operations

Operation	Summary	Request	Response
prepare	Compile a workflow definition into an executable.	Effect Schema (Objects)	Effect Schema (Objects)
run	Run a prepared workflow executable.	Effect Schema (Objects)	Effect Schema (Objects)
cancel	Cancel a running workflow at a frontier boundary.	Effect Schema (Objects)	Effect Schema (Objects)
cleanupAuthoringScratch	Delete one exact authoring_scratch runtime tree and its scratch-only indexes.	Effect Schema (Objects)	Effect Schema (Objects)
deliverEvent	Deliver an external event to a running workflow.	Effect Schema (Objects)	Effect Schema (Objects)
invokeOperation	Invoke an engine-defined operation on a workflow.	Effect Schema (Objects)	Effect Schema (Objects)
view	Project the current state of a workflow run.	Effect Schema (Objects)	Effect Schema (Objects)
composeCapsule	Compose a workflow capsule manifest.	Effect Schema (Objects)	Effect Schema (Objects)

Conformance Expectations

• Register with aster.workflow-engine at 2.0.0 inside ^2.0.0.
• Implement every operation: prepare, run, cancel, cleanupAuthoringScratch, deliverEvent, invokeOperation, view, composeCapsule.
• Decode requests and responses against the operation schemas listed above.
• Run the protocol conformance kit where one exists: No named kit yet; providers are still expected to satisfy the registry schemas..

Declared Authority

[
  {
    "kind": "child_run_spawn"
  },
  {
    "kind": "model_spend"
  }
]