add_hyperlink

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

No annotations are provided, so the description must carry behavioral transparency. It describes the internal XML changes (creating relationship entry and hyperlink element), which is helpful. However, it does not disclose side effects, error conditions (e.g., missing paragraph), or permissions needed. Adequate but not comprehensive.

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 four sentences long, with the primary purpose in the first sentence. It provides necessary internal details without excessive verbosity. Could be slightly tighter, but overall efficient.

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 no annotations but an output schema exists, the description need not explain return values. It covers parameters adequately and describes internal behavior. Missing some edge-case details, but overall complete for typical usage.

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 0%, meaning the schema only provides parameter titles without descriptions. The tool description adds crucial meaning: para_id is 'w14:paraId of the target paragraph', text is 'Display text for the hyperlink', and url is 'The URL the hyperlink points to'. This fully compensates for the schema gap.

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 'Append an external hyperlink at the end of a paragraph.' It specifies the action (append), the target (paragraph), and the type (external hyperlink). It also details internal mechanics (creating relationship entry and hyperlink element), distinguishing it from siblings like add_internal_link.

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 external hyperlinks by specifying 'external' and mentioning URL, but it does not explicitly state when to use this tool versus alternatives like add_internal_link or add_bookmark. No when-not or alternative guidance is provided.

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