flow-execute
Runs a saved flow of device actions from the project's .argent/flows/ directory. Returns step results, including images, or fails with an error if a step breaks.
Instructions
Run a saved flow from the .argent/flows/ directory.
Each step is executed in order: tool calls are dispatched through the registry,
echo steps print a message. A tool step may carry delayMs: <ms> to sleep
that long before the step runs. Returns the result of every step, including images.
Use when you want to replay a recorded flow or run a scripted sequence of device actions.
Fails if the flow file does not exist or a step tool raises an error (execution stops at that step).
An await-ui-element step whose condition is not met before its timeout also stops the flow there
(its later steps were recorded assuming the condition held), so use one to gate a step on a screen transition.
If the flow has an execution prerequisite and prerequisiteAcknowledged is not set to true, the tool returns a notice with the prerequisite instead of running. Use flow-read-prerequisite to inspect the prerequisite beforehand.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the flow to run (e.g. "settings-explore") | |
| flow_file | No | Path to the flow .yaml as readable by the tool-server. Internal — the argent client derives it from project_root and name automatically; leave unset. | |
| project_root | Yes | Absolute path to the project root directory that contains `.argent/flows/<name>.yaml`. | |
| prerequisiteAcknowledged | No | Set to true to confirm the execution prerequisite has been met. Required when the flow defines an executionPrerequisite. |