Edit

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

No annotations provided, so description carries full burden. Discloses safety intent, batch sequential execution stops on first error, dryRun returns preview without saving. Does not cover reversibility or permissions, but key behaviors are 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?

Single dense paragraph, front-loaded purpose, every sentence adds value. No redundant or filler content.

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 12 parameters, batch mode, and no output schema, description provides a good overview but lacks details on parameter formats and interpretation. References vault://overview for strategy, but standalone completeness is moderate.

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%). Description adds context for overall tool functionality and mentions key patterns (heading/block ID, line/string replace, frontmatter_set), but many parameters like startLine, endLine, searchText, replaceAll lack explanation. Partially compensates but could do more.

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 it edits notes in a general markdown notes vault, with specific operations (AST, line/string replacement, frontmatter_set, batch, dryRun). Differentiates from sibling tools (system, vault, view, workflow) which are not editing-focused.

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?

Describes supported edit modes (by heading, block ID, line/string, frontmatter) and features like batch limits (max 50) and dryRun. Implicitly limits usage to this vault scope. Could explicitly state when not to use or mention alternatives, but provides operational guidance.

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