Check a flow
check_flowCompile a flow document (flows-v1) with the same engine the API uses, and run its tests (flow-tests-v1) against in-memory data. Returns diagnostics (with JSON pointers into the document), what the flow reads and writes, and why each failing test failed. Costs nothing and sees no data.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"flow": "<flow>"
},
"name": "check_flow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flow | Yes | The flow document | |
| tests | No | The flow tests: a flow-tests-v1 document, optional | |
| knownLists | No | Path names of lists that exist, so the flow using any other list is warned about |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| diagnostics | Yes |