Read an Obsidian Canvas (parses .canvas JSON)

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Description adds useful behavioral details beyond annotations: output structure with nodes, edges, file_resolved, summary, broken_file_refs. Annotations already declare readonly and idempotent, so description complements well.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Very concise, front-loaded with main purpose, followed by structured details. Every sentence adds value. No fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 1 parameter and no output schema, the description completely covers inputs and outputs. Includes summary and broken refs info. No gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 100% coverage for path parameter. Description adds value by clarifying path is vault-relative and accepts with or without .canvas extension, which is not in schema description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it parses .canvas files into typed nodes and edges. Specific verb (read) and resource (Obsidian Canvas). Distinguishes from siblings like obsidian_read_note and obsidian_read_pdf.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies use for reading canvas structure, but no explicit when-not or alternatives mentioned. Sibling tools exist for other file types, but description does not guide selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.