delete_note

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

No annotations provided, but description fully compensates by detailing soft-delete (file moved to .trash/, indexer skips dot-prefixed, ≤5 min propagation, user cleans up), permanent delete (os.unlink, no recovery), and backlinks handling. Extremely transparent.

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?

Well-structured with paragraphs and an args section. Each sentence adds useful detail. Slightly verbose but not excessively; could be trimmed slightly but still effective.

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 relevant aspects: soft-delete mechanics, permanent delete, indexer interaction, backlinks, and links to related tools (get_backlinks, find_orphans, get_vault_guide). Output schema exists (not shown) so return details are likely handled there. Complete for a tool with this complexity.

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?

Input schema has two parameters with no descriptions (0% coverage). Description adds full semantics: 'path: Vault-relative path to the note' and 'permanent: If True, unlink instead of soft-deleting'. Clearly explains meaning 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?

Clearly states 'Delete a note from the vault' with specific verb and resource. Distinguishes from sibling tools like create_note, edit_note, move_note by focusing on deletion and soft-delete vs permanent behavior.

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?

Explains default soft-delete and permanent option, including implications for recovery (backups needed). Mentions related tools (get_backlinks, find_orphans, get_vault_guide) for post-delete actions. Could be more explicit about when NOT to use this tool, but overall provides solid guidance.

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