Edit

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

No annotations are present. The description discloses that batch mode is sequential and stops on first error, and that dryRun previews without writing. However, it does not explicitly state that normal execution writes changes to disk, which would be expected for an edit 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?

Three sentences that efficiently cover the core purpose, the two modes, operation types, and dryRun preview. No unnecessary words; each sentence adds value.

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, the description covers modes and operations well but does not describe the return value for normal (non-dryRun) edits. Missing a statement about what the tool returns on success or error.

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 low (42%), but the description groups operations into 'AST ops' (append/prepend/replace targeting headings or block IDs) and 'freeform ops' (line_replace/string_replace) with detailed behavior, and explains frontmatter_set. This adds significant meaning beyond the 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?

The description starts with 'Edit notes', establishing the verb and resource. It then details two modes (single and batch) and lists specific operations, clearly distinguishing this tool from siblings like system, vault, view, workflow.

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 explains when to use single mode versus batch mode ('provide path, operation, content' vs 'operations array'), but does not explicitly state when not to use the tool or provide alternatives. Context is clear for a note-editing tool.

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