Struct DynamicWorkflowTool 

pub struct DynamicWorkflowTool { /* private fields */ }

Model-visible tool that executes a dynamic workflow through A3S Flow.

Implementations

impl DynamicWorkflowTool

pub fn new(registry: Arc<ToolRegistry>) -> Self

pub fn health(&self) -> DynamicWorkflowHealthSnapshot

Return bounded cumulative worker-claim diagnostics for this tool instance. Durable per-run attempt state remains in the Flow ledger.

pub fn with_graph_observer(self, observer: FlowGraphObserver) -> Self

Project committed Flow events into an optional reactive state graph. A3S Flow remains the workflow execution source of truth.

pub fn with_flow_event_store(self, store: Arc<dyn FlowEventStore>) -> Self

Use a host-owned Flow event store for workflow history and control.

This is the extension point for remote or database-backed hosts. The store must provide its own durable append/sequence contract; Code does not mirror its events into a second journal or cache. When omitted, local workspaces use CrossProcessFlowEventStore and non-local contexts use a process-local in-memory store for compatibility.

pub fn with_task_scheduler( self, scheduler: Arc<TaskScheduler>, admit_steps_globally: bool, ) -> Self

Configure optional global admission for direct script-backed Flow steps. Session-bound registrations should leave this disabled because the enclosing session operation already owns the global lease.

pub fn with_runtime_build_compatibility( self, compatibility: RuntimeBuildCompatibility, ) -> Self

Fence new and resumed runs to an explicit runtime-build compatibility set. By default the tool pins new runs to DYNAMIC_WORKFLOW_RUNTIME_BUILD_ID and temporarily accepts legacy unpinned histories; hosts that can replay older builds should add them to this compatibility set explicitly.

pub fn with_continuation_lease_ledger( self, ledger: Arc<dyn FlowDecisionLedger>, lease_ms: u64, ) -> Self

Use a caller-owned durable lease ledger for worker admission.

The ledger stores only claim metadata and digests; A3S Flow’s event store remains the workflow source of truth. Hosts that run multiple workers should provide a shared ledger (for example a FileFlowDecisionLedger) and choose a lease long enough for one heartbeat interval. Without an explicit ledger, local workspaces use a sidecar file ledger and remote/in-memory contexts use a tool-scoped memory ledger.

pub fn with_continuation_lease_ms(self, lease_ms: u64) -> Self

Change the default worker lease while retaining automatic ledger selection.

pub fn control( &self, run_id: impl Into<String>, source: impl Into<String>, input: Value, ctx: &ToolContext, ) -> Result<DynamicWorkflowControl>

Bind a host control handle to one durable run and its replay inputs.

The handle is intentionally separate from the model-visible tool call: a host must provide the exact source and initial input before it can inspect, drive, or cancel a run. No operation is performed until a method on the returned handle is awaited.

Trait Implementations

impl Tool for DynamicWorkflowTool

fn name(&self) -> &str

Tool name (must be unique within registry)

fn description(&self) -> &str

Human-readable description for LLM

fn parameters(&self) -> Value

JSON Schema for tool parameters

fn execute<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, args: &'life1 Value, ctx: &'life2 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute the tool with given arguments

fn definition(&self) -> ToolDefinition

Complete model-facing definition for this tool.

fn is_model_visible(&self) -> bool

Whether this tool definition should be sent to the model.

fn capabilities(&self, _args: &Value) -> ToolCapabilities

Scheduling and result capabilities for this specific invocation.

fn requires_confirmation(&self, _args: &Value) -> bool

Whether tool-owned metadata requires this invocation to pass through HITL even when the host permission policy would otherwise allow it.