Get Backlinks

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds valuable context: supports two link syntaxes, the includeContext parameter returns context snippets, and vault selection behavior. It confirms read-only nature without contradiction.

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?

The description is two paragraphs long, front-loaded with the core purpose. Every sentence serves a purpose: purpose, syntax support, context parameter explanation, sibling reference, and vault handling. No redundancy or 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?

Given the presence of an output schema, the description does not need to detail return values. It covers the tool's purpose, usage guidelines, key parameters, vault context, and link syntax. The description is complete for an agent to use this tool correctly.

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?

With schema description coverage at 75%, the description compensates by explaining the vaultPath parameter's role (overrides session-active vault) and elaborating on includeContext/contextLength behavior (context snippets). This adds meaning beyond the schema, though the basic parameter purposes are already clear.

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?

The description clearly states the tool finds inbound references (notes linking TO a target note) and explicitly distinguishes from the sibling tool 'links.outgoing' for outbound links. The verb 'find' and resource 'inbound references' are specific, and the mention of supported link syntaxes adds precision.

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?

The description directs agents to use 'links.outgoing' for outbound links, providing a clear alternative. It also explains vault selection behavior (session-active vault vs. explicit vaultPath override), guiding when to use the vaultPath parameter.

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