enquire-mcp API reference - v3.9.0-rc.4
    Preparing search index...

    Function readCanvas

    • Parse a single .canvas file into typed nodes + edges.

      Returns a graph representation the agent can reason about: which notes are pinned where, what's textual vs file-embed vs URL, what edges connect what. File-node references (file: kind) are resolved against the live vault — file_resolved carries the post-findBestMatch path or null on a broken reference. Forward-compatible: unknown type values become kind: "unknown" rather than throwing.

      Parameters

      • vault: Vault

        The vault.

      • args: { path: string }

        path is the vault-relative path to the canvas (with or without .canvas extension).

      Returns Promise<ReadCanvasResult>

      A ReadCanvasResult with nodes, edges, summary, and broken-reference list.

      If path is empty, the file is missing, or the JSON is malformed.

      If path resolves outside the vault.

      const c = await readCanvas(vault, { path: "Whiteboards/research.canvas" });
      console.log("Files:", c.summary.file, "Broken:", c.broken_file_refs);