Start Flow (Async)
start_flowExecute a Maestro flow by name to navigate to a specific area of your app for incremental changes before verification. Returns a task ID to track progress.
Instructions
Execute a named Maestro flow (resolves /.yaml and merges manifest param defaults with caller params). Use to navigate to the area of an incremental change before verifying it. Returns a taskId; poll_task_status streams output, get_task_result returns final pass/fail. With MCA_FLOW_PAUSE_RESUME=on, pauses any active recording for the run and auto-resumes; otherwise errors if a session is active. cancel_task interrupts mid-flow.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Flow name (the filename without the .yaml suffix) | |
| params | No | Parameters forwarded to Maestro as environment variables (-e KEY=VALUE). Referenced inside the flow YAML as ${KEY}. Manifest-declared params with defaults are applied automatically when omitted. | |
| flowsDir | No | Directory containing flow .yaml files (default: ./flows) | |
| platform | No | Target platform (default: ios) | |
| stubsDir | No | Optional WireMock stubs root directory. If provided, a stub server is started for the flow run. | |
| debugOutput | No | Path where Maestro should dump debug output (screenshots, hierarchies, logs) | |
| stubServerPort | No | Port for the optional stub server (default: auto-select) | |
| driverCooldownMs | No | iOS-only: pause after uninstalling the XCTest driver to let port 7001 drain (default: 3000). Only applies on the uninstall path — a healthy driver is reused without cooldown. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| status | Yes | ||
| taskId | Yes | ||
| startedAt | Yes |