add_hyperlink

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

With no annotations, the description carries the burden of transparency. It discloses internal mechanics (creating relationship entry and w:hyperlink element), but lacks details on idempotency, error handling (e.g., invalid para_id), and whether it overwrites existing hyperlinks.

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 concise with a clear purpose sentence, technical note, and structured Args section. No unnecessary verbiage.

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?

The description covers the tool's purpose, parameters, and internal behavior. While it lacks edge case handling and return value details, the presence of an output schema reduces the need for explicit return documentation. Reasonably complete for the tool's complexity.

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 meaning for all three parameters beyond the schema: para_id as 'w14:paraId of the target paragraph', text as 'Display text', url as 'The URL'. This is valuable given 0% schema description coverage.

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 appends an external hyperlink at the end of a paragraph, using specific verb and resource. It distinguishes itself from siblings like 'add_internal_link' and 'remove_hyperlink' by focusing on external hyperlinks.

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 is provided on when to use this tool versus alternatives like 'add_internal_link' or 'update_hyperlink'. There is no mention of prerequisites, such as requiring an existing paragraph with a valid para_id.

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