Flow
Back to the MCP tool reference.
flow_config_schema
Explore a bounded root or definition from the version-pinned Flow schema.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
{
"properties": {
"config_type": {
"enum": [
"live",
"batch",
"project"
],
"title": "Config Type",
"type": "string"
},
"definition": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Definition"
}
},
"required": [
"config_type"
],
"title": "flow_config_schemaArguments",
"type": "object"
}Output schema:
flow_config_validate
Validate one canonical .apolo YAML file against its pinned Flow schema.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_config_write
Validate and create one new canonical .apolo YAML file without overwrite.
Operation type: Write
Annotations: read-only false, destructive false, idempotent false, open-world true
Input schema:
Output schema:
flow_live_list
List Flow live jobs within explicit context and local path scope. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_live_get
Resolve one logical Flow job, with a bounded multi-job result. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_live_run
Start a detached Flow live job under the server mutation policy. Set detach: true on the selected job so this operation returns after submission. Monitor it separately with get, logs, and bounded wait. Pre/post raw-ID comparison journals only newly created jobs when upstream startup times out after submission. workspace_path is the Flow project root and must contain a real .apolo directory. flow_live_run reads .apolo/live.yml or .apolo/live.yaml, whose minimum shape is kind: live plus a jobs mapping; job_id selects a key in that mapping. Each plain job needs an image and may define cmd or bash. Set detach: true on jobs started by MCP, then monitor them with separate get, logs, and bounded wait calls. Optional project settings belong in .apolo/project.yml or .apolo/project.yaml.
Operation type: Write
Annotations: read-only false, destructive false, idempotent false, open-world true
Input schema:
Output schema:
flow_live_logs
Read bounded Flow live logs with MCP-side credential redaction. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_live_wait
Wait a bounded time for a Flow live job to terminate. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_live_kill
Kill a Flow live job under the server mutation policy. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Destructive write
Annotations: read-only false, destructive true, idempotent false, open-world true
Input schema:
Output schema:
flow_live_kill_all
Kill all jobs in exactly one explicit Flow context. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Destructive write
Annotations: read-only false, destructive true, idempotent false, open-world true
Input schema:
Output schema:
flow_bake_start
Start a bake only through FlowAPI BatchRunner orchestration. An internal unique correlation tag lets MCP journal a bake even when the upstream runner fails after creating it. workspace_path is the Flow project root and must contain a real .apolo directory. flow_bake_start reads .apolo/.yml or .yaml, whose minimum shape is kind: batch plus a tasks list; batch selects that workflow. Each plain task needs an image and may define cmd or bash. Optional project settings belong in .apolo/project.yml or .apolo/project.yaml.
Operation type: Write
Annotations: read-only false, destructive false, idempotent false, open-world true
Input schema:
Output schema:
flow_bake_list
List bakes and bounded task state in one explicit context. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_bake_get
Get structured bake, attempt, and bounded task state. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_bake_logs
Read bounded bake task logs with MCP-side credential redaction. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_bake_wait
Wait a bounded time for a bake attempt to terminate. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Read-only
Annotations: read-only true, destructive false, idempotent true, open-world true
Input schema:
Output schema:
flow_bake_cancel
Cancel a bake attempt under the server mutation policy. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Destructive write
Annotations: read-only false, destructive true, idempotent false, open-world true
Input schema:
Output schema:
flow_bake_restart
Restart a bake through BatchRunner under the server mutation policy. workspace_path is the Flow project root and must contain a real .apolo directory.
Operation type: Destructive write
Annotations: read-only false, destructive true, idempotent false, open-world true
Input schema:
Output schema:
Last updated
Was this helpful?