update_paragraph

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

With no annotations, the description must disclose behavioral traits fully. It mentions that empty strings leave parameters unchanged, but does not address permission requirements, error behavior, reversibility, or side effects of updating a paragraph.

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 well-structured with a clear first sentence stating purpose, followed by parameter details. It is concise but could be slightly tighter by removing redundant phrasing like 'paraId of the paragraph to update'.

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 the output schema exists, return values are covered. The description adequately covers the core behavior and parameter nuances. It lacks information on error cases and preconditions, which would improve completeness for a mutation tool.

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 description adds significant meaning beyond the schema by explaining each parameter's purpose and default behavior (e.g., 'Empty string leaves text unchanged'). Schema coverage was 0%, so the description fully compensates.

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 it updates the text and/or style of an existing paragraph, which is a specific verb+resource pair. It distinguishes from siblings like insert_paragraph (create) and delete_paragraph (delete) by focusing on modification.

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 implies usage for updating an existing paragraph's text/style but provides no explicit guidance on when to use this tool versus alternatives (e.g., set_paragraph_border, set_run_font). No exclusions or when-not-to-use information.

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