read_note

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

Discloses return structure (content, bytes returned, total note size) and behavior of includeFrontmatter. Without annotations, the description carries the full burden and does well, but could explicitly state that it's a read-only operation with no side effects.

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?

Three efficient sentences: purpose, return value context, usage guidance. No redundant or vague phrasing. Front-loads key information.

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?

Covers all user needs: what the tool does, how to use it (prerequisite tools), and what it returns. Given no output schema, the description adequately explains return values. Handles all 5 parameters and nested object implicitly.

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 coverage is 100%, so baseline is 3. The description adds value by explaining the return payload's purpose (measurable savings) and usage advice for selecting parameters, but does not repeat schema details unnecessarily.

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 the action (read a note or span) and the specific ways to specify a span (heading, block, line range). Distinguishes from siblings by advising to use search or outline_note first, which are sibling tools.

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?

Explicitly advises when to use this tool ('Use search or outline_note first to find the right path and section names'), setting expectations for prerequisite steps. Also describes the return format, helping the agent decide if this tool is appropriate.

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