text_setParagraphRuleAbove

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

No annotations are supplied, so the description carries the full burden. It says 'add or modify' but does not disclose whether ruleOn=false removes the rule, what happens to required-but-unset values, permission needs, or reversibility. For a 10-required-parameter mutation this is a substantial gap.

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?

A single front-loaded sentence with no wasted words; the problem is under-specification rather than verbosity, so its compact form is appropriate even if the content is thin.

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?

With 12 parameters (10 required), no annotations, no output schema, and near-zero schema coverage, the description leaves the agent unable to determine what values to supply or what the call returns. Only the bare purpose is conveyed.

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 description coverage is only 8% — document_id is the sole documented parameter — and the description adds no meaning for ruleOn, ruleWeight, ruleColor, ruleWidth's enum, ruleOffset, or the indent parameters. The ten required parameters are effectively undocumented.

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?

States a concrete verb (add or modify) and a specific resource (the rule above a paragraph), and the word 'above' implicitly distinguishes it from the sibling text_setParagraphRuleBelow. It is clear but never names the alternative or the document-editing context, so it stops short of full sibling differentiation.

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 versus text_setParagraphRuleBelow, nor any prerequisites (document must be open, paragraph must exist). The agent must infer everything about applicability from the name.

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