Find Broken Links

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

Adds detail beyond annotations: resolution uses whole vault even when scanning a folder, ensuring truly unresolvable links. Annotations already indicate read-only 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?

Two sentences, no wasted words. Front-loaded with the primary action and result. Efficient and clear.

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?

With no output schema, description explains return format (per-source report with link text and line numbers) and total count. Covers scanning scope and resolution behavior. Fully sufficient for a read-only scan tool.

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 covers 100% of parameters with descriptions. Description does not add significant parameter-level detail beyond the schema, but clarifies the folder scope nuance. Baseline 3 is appropriate.

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 scans notes for broken wikilinks and returns a per-source report. Verbs are specific and resource is well-defined. Distinguishes from sibling 'find_orphans' which targets unlinked notes.

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 recommends use after renaming, moving, or deleting notes. Does not explicitly mention alternatives like get_backlinks or search_notes, but the context is clear. Lacks explicit 'when not to use' guidance.

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