update_paragraph

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'update' without describing side effects (e.g., impact on tracked changes, behavior if para_id is invalid, whether it preserves other formatting). Minimal disclosure beyond the basic operation.

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?

Very concise: one sentence for purpose, then structured Args section. Every sentence is necessary. No fluff. Front-loaded with the core action.

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?

Adequate for a straightforward update operation with output schema available. However, lacks explanation of error handling, output, or constraints (e.g., does require existing paragraph?). Could be more complete given no annotations.

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 an 'Args' block that explains each parameter: para_id is required, text empty leaves unchanged, style empty leaves unchanged. This is valuable since schema coverage is 0% (no description in schema). It clarifies default behavior meaningfully.

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 updates the text and/or style of an existing paragraph. This distinguishes it from sibling tools like delete_paragraph, insert_paragraph, or set_paragraph_* formatting tools. Specific verb+resource+scope.

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 on when to use this tool versus alternatives (e.g., set_paragraph_indentation, set_paragraph_border, etc.). The description does not clarify prerequisites or scenarios where this tool is preferred over other paragraph manipulation tools.

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