read_flow
Read full flow configuration, structure summary, entity lists, quota counts, or simulate a respondent path.
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": {
"survey_id": "<survey_id>"
},
"name": "read_flow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | What to return (default: full flow config) | |
| entity_id | No | Read one entity when entity_kind is set | |
| survey_id | Yes | Survey UUID | |
| entity_kind | No | List or read one entity of this kind | |
| preview_condition_picks | No | Only with view "preview": condition set UUID → the condition (arm) UUID to simulate, both from read_flow entity_kind condition_set. A branch on a set left out follows its first arm. | |
| preview_simulated_answers | No | Only with view "preview": question UUID → simulated answer, used to evaluate Skip Rules. Use the option value for a choice question; separate several picks with |. | |
| preview_simulated_variables | No | Only with view "preview": flow variable UUID (read_flow entity_kind variable) → simulated value, used to evaluate Skip Rules that test variables. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |