suppress_numbering

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

The description discloses the behavioral change (setting numId to 0) but lacks details on side effects (e.g., affecting parent list, reversibility, failure modes for invalid para_id). With no annotations, this minimal disclosure leaves significant gaps.

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, efficient sentence that communicates the core action and mechanism without extraneous words. It is well front-loaded with the verb and purpose.

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 an output schema, the description is adequate but leaves open questions about input validation and error handling. The presence of an output schema partially compensates for missing return value details.

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 parameter para_id has no description in the schema (0% coverage). The tool description does not clarify its meaning, format, or how to obtain it (e.g., from a previous get_paragraph call), failing to compensate for the schema's lack of information.

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 tool's function: 'Remove list numbering from a paragraph' using a specific mechanism. This distinguishes it from sibling tools like promote_list_item or demote_list_item, which adjust numbering rather than remove it.

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 (e.g., when to remove numbering vs. promoting/demoting). It does not mention context such as whether the paragraph must currently be numbered or how to revert the action.

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