get_backlinks

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

Discloses that it uses a pre-built index for fast lookups, mentions sort order (source path ascending), and indicates output includes source line and optional excerpt. No annotations, but description covers key behavioral traits for a read tool.

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 succinct sentences with no fluff. Front-loaded with purpose and additional details efficiently.

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?

No output schema, but description explains return format (source line, optional excerpt). Covers speed, sort order, and what is returned. Complete for a straightforward read tool with 3 parameters.

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. Description adds value by specifying sort order and mentioning optional excerpt (linked to includeContext parameter implicitly), providing context beyond schema.

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?

Description clearly states the tool returns all notes linking to a target note with source line and optional excerpt. Distinguishes from siblings like get_links (which likely gets outgoing links) and search.

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?

Implied usage from description: fast index lookup for reverse links of a target note. Does not explicitly state when not to use or provide alternatives, but context clues from sibling tools help.

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