List canvas documents
list_canvasRetrieve canvas documents in a workflow run or across all runs when run_id is omitted to find collaborative markdown files agents edit in parallel. Read-only.
Instructions
List canvas documents in a workflow run. Canvas documents are collaborative markdown files that multiple agents can edit in parallel. Omit run_id to list documents across all runs. Read-only. Use read_canvas for content and get_canvas_toc for section IDs. There is no get_run; list_runs returns run records. Pass playbook_id as the UUID or GUID of the playbook this call should target.
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": {
"playbook_id": "<playbook_id>"
},
"name": "list_canvas"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_id | No | Workflow run UUID. Omit to list documents across all runs. | |
| playbook_id | Yes | UUID or GUID of the target playbook |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documents | Yes |