query_canvas
Find nodes matching criteria across one or more .canvas files (defaults to all canvases under the vault root).
| Domain | structured |
| Scopes | read:canvas |
| Access | read |
| Tags | read-only, domain:structured |
| Profile | full only |
Annotations
Section titled “Annotations”| Annotation | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | no |
| Accepts an idempotency key | no |
Idempotent is the advisory MCP idempotentHint. Destructive is also yes for a tool that
asks for confirmation only on some calls.
Confirmation (human in the loop)
Section titled “Confirmation (human in the loop)”No human confirmation is required to call this tool.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
vault |
string |
— | Vault id. May be omitted when only one vault is available. length 1–64; pattern ^[a-z0-9_-]+$ |
|
paths |
string[] |
— | — | |
root |
string |
— | length 1–1024 | |
filter |
object |
{} |
— | |
filter.type |
enum |
— | One of: "text", "file", "link", "group" |
|
filter.color |
string |
— | — | |
filter.file_path_contains |
string |
— | — | |
filter.text_contains |
string |
— | — | |
filter.has_edge_to |
string |
— | — | |
limit |
integer |
— | range 1–1000 | |
cursor |
string |
— | — |
Output
Section titled “Output”| Field | Type | Always present | Description |
|---|---|---|---|
vault |
string |
yes | — |
total |
integer |
yes | range ≥ -9007199254740991 |
items |
object[] |
yes | — |
items[].canvas_path |
string |
yes | — |
items[].node_id |
string |
yes | — |
items[].type |
string |
yes | — |
items[].snippet |
string |
— | |
canvases_scanned |
integer |
yes | range ≥ -9007199254740991 |
errors |
object[] |
yes | — |
errors[].path |
string |
yes | — |
errors[].code |
string |
yes | — |
next_cursor |
string |
— |
Related tools
Section titled “Related tools”Other tools in the structured domain: add_kanban_card, create_base, create_canvas, create_excalidraw, format_table, insert_table_column, insert_table_row, list_kanban_boards, move_kanban_card, query_base, read_base, read_canvas, read_excalidraw, read_kanban_board, sort_table_by_column, update_base, update_canvas, update_excalidraw.
Back to the tool catalog.