Function listCanvases

listCanvases(
vault: Vault,
args: { folder?: string; limit?: number },
): Promise<CanvasSummary[]>
List Obsidian .canvas files (whiteboards) in the vault.

Canvas is Obsidian's JSON-format whiteboard with positional nodes (text / file embeds / external URLs / groups) and labeled edges. Per the v1.5 competitive audit, no other Obsidian-MCP indexes them; we parse them natively without coupling to the Obsidian app. Malformed JSON canvases surface with node_count: 0 and edge_count: 0 rather than poisoning the listing.
Parameters
- vault: Vault
  The vault to scan.
- args: { folder?: string; limit?: number }
  All optional. folder restricts the scan. limit defaults to 100.
Returns Promise<CanvasSummary[]>
A CanvasSummary array sorted by mtime desc.
Throws
If folder resolves outside the vault.
Example
```
const boards = await listCanvases(vault, { folder: "Whiteboards", limit: 20 });
for (const c of boards) console.log(c.path, c.node_count, "nodes");
```
- Defined in tools/media.ts:52