text_setHyphenation

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

No annotations are provided, so the description carries the full behavioral burden. 'Set' implies mutation of existing paragraph formatting, but the description says nothing about whether other paragraph attributes are affected, what permissions are required, or how the frame/paragraph addressing resolves. For a mutating 9-parameter tool, 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 filler, which is structurally sound. It is terse to the point of under-specification rather than wasteful, but it commits no verbosity or ordering errors.

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 mutating tool with 9 parameters, 4 required, 11% schema coverage, no annotations and no output schema, the description supplies almost nothing an agent needs. The one bit of information beyond the name – that the target is a paragraph – is insufficient to call the tool correctly.

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 11% – only document_id is documented in the schema. Eight parameters (pageIndex, frameIndex, paragraphIndex, hyphenation, wordSpacing, letterSpacing, minWordLength, maxConsecutiveHyphens) are undocumented in both schema and description, and the description adds no semantics for any of them, not even units or valid relationships between spacing values.

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 specific verb and resource ('Set hyphenation settings') and scopes it to a paragraph, which is enough to distinguish it from unrelated siblings like table_setCell or image_place. It does not, however, distinguish itself from the many sibling text_set* formatting tools (text_setDropCap, text_setKeepOptions, text_setTabs), so it lands at 4 rather than 5.

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 gives no when-to-use context, no prerequisites, and no exclusions. An agent cannot tell from this text when hyphenation settings should be applied versus left alone, or how the tool relates to text_applyParagraphStyle and the other paragraph-formatting siblings.

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