Analyze Link Health

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

Describes as 'Read-only' and explains vault selection precedence (active vault vs vaultPath), adding behavioral context beyond annotations which already mark it as read-only and idempotent.

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 concise sentences front-load the summary and usage, followed by a clear explanation of vault behavior. Every sentence earns its place.

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 an output schema present, the description adequately covers what the tool returns and when to use alternatives, complemented by comprehensive annotations for safety profile.

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?

The single parameter `vaultPath` has no schema description, but the description explains its behavior: 'unless an explicit vaultPath argument is passed, which always wins', adding crucial semantic meaning.

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 'Summarise link health for the whole vault' and lists specific metrics, differentiating it from sibling tools like `links.broken` and `links.orphaned` which provide per-item lists.

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 says 'Use this as a dashboard check' and directs to sibling tools for detailed lists, providing clear when-to-use and 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.