Create Canvas
canvas.createCreate a new empty Obsidian canvas file at a specified path. Overwrite existing file when needed. Canvas files serve as infinite spatial whiteboards for nodes and edges.
Instructions
Create a new empty Obsidian canvas (.canvas) file at the given path. Fails if the path already exists unless overwrite: true is passed. Canvas files are JSON documents that Obsidian renders as an infinite spatial whiteboard of nodes and edges. Use canvas.edit to add nodes/edges once the file exists.
Operates on the session-active vault (see vault.current — selectable via vault.select) unless an explicit vaultPath argument is passed, which always wins.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filePath | Yes | Path for the new canvas (must end in `.canvas`). | |
| overwrite | No | When true, overwrite an existing canvas at the path. Defaults to false. | |
| vaultPath | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| changed | Yes | True if the tool altered vault state on this call; false if it was a no-op. | |
| target | Yes | The path or identifier the tool acted on. | |
| summary | Yes | Short human-readable summary of what happened. |