set_run_superscript

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

No annotations provided, so the description must disclose behavioral details. It only states the action without mentioning side effects (e.g., overwriting existing alignment), permissions, or return value. Insufficient for an agent to understand implications.

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?

Extremely concise with a clear primary sentence followed by a bulleted argument list. 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?

Lacks context about error conditions, return behavior, and how superscript interacts with existing formatting. With no annotations and an output schema not provided, the description fails to give an agent enough information to use the tool reliably.

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 has 0% coverage, but description adds brief explanations for both parameters: para_id as 'paraId of the target paragraph' and run_idx as 'Zero-based index of the run'. This provides some meaning, though format or constraints are missing.

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?

Clearly states 'Set superscript vertical alignment on a specific run', identifying the verb and resource. However, it does not explicitly differentiate from sibling tools like set_run_subscript, which is a closely related alternative.

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_run_subscript) or what prerequisites are required (e.g., paragraph must exist, valid run index).

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