akb_edit

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

Despite no annotations, description discloses error behavior (fails if not found or multiple occurrences) and the replace_all flag's effect. Lacks details on permissions or reversibility, but sufficiently transparent for a mutation 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, each dense with information. Main action in first sentence, constraints in second, alternative in third. No redundancy or filler.

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 no output schema and no annotations, description covers core behavior, error conditions, and provides a clear alternative. Sufficient for an agent to decide to invoke the tool correctly.

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%, but description adds valuable context: old_string must be unique unless replace_all, new_string can be empty to delete, and suggests including surrounding context for uniqueness.

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 verb 'Edit' and resource 'a single document' with specific action 'replacing exact text'. It distinguishes from sibling akb_grep by specifying scope (one document vs many).

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 provides when to use (single document, exact text replacement) and when not to use (many documents: use akb_grep instead). Also details constraints like old_string uniqueness and replace_all behavior.

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