update_all_numbers

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

With no annotations, the description carries the full burden of disclosing behavioral traits. It only states that the tool updates numbers, but does not mention side effects, required permissions, whether the modification is destructive, or what happens if the book is not open. The word 'update' implies mutation, but more detail is needed.

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?

The description is a single sentence that efficiently conveys the action and the items affected. It is front-loaded and contains no unnecessary words or repetition.

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?

For a simple tool with one parameter and no output schema, the description is minimally adequate but lacks important context such as when to use it, preconditions, and expected outcomes. Given the presence of similar sibling tools, more guidance would enhance completeness.

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 input schema has 100% description coverage for the single parameter 'bookPath', with a description 'Path to the book file'. The tool description adds no additional meaning or format constraints beyond what the schema already provides, so it meets the baseline but does not exceed.

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 the verb (Update) and resource (all numbers in a book), specifying page, chapter, and paragraph numbers. This distinguishes it from the sibling tool 'update_chapter_and_paragraph_numbers' which updates only those types, and 'update_all_cross_references' which updates references.

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?

No guidance is provided on when to use this tool versus alternatives, such as the similar 'update_chapter_and_paragraph_numbers' or 'update_all_cross_references'. There are no mentions of prerequisites, exclusions, or best practices.

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