insert_hyperlink

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

No annotations are provided, so the description bears the full burden of behavioral disclosure. It says 'Insert a hyperlink' but does not state where the hyperlink is inserted, whether selection/cursor position matters, what direct_insert actually controls, or what effects the insertion has.

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 compact and front-loaded with the core purpose, followed by a structured Args list with no wasted prose. It could be slightly clearer about insertion location, but the formatting is clean and 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?

For a tool with moderate complexity, no annotations, and no schema-level parameter descriptions, the description is incomplete. It omits the insertion target/cursor dependency, the meaning of direct_insert beyond a Boolean-like flag, and any preconditions beyond doc_id. The output schema exists but cannot compensate for missing behavioral context.

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%, and the description compensates by documenting all four parameters. It adds meaning beyond the schema by noting doc_id comes from open_document, text defaults to url, and direct_insert controls direct insertion. However, '1 to insert directly' remains vague about the alternative behavior.

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 states the specific operation 'Insert a hyperlink' with a clear verb and resource. It differentiates implicitly from siblings like hyperlink_jump and insert_bookmark, though it does not explicitly call them out.

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?

There is no guidance on when to use this tool versus alternatives such as hyperlink_jump or insert_text. The Args block gives parameter hints, but no context for when this tool is appropriate or inappropriate.

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