List Hyperlinks

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

The annotations include readOnlyHint=true, but the description adds valuable context beyond that: it specifies the return format (JSON with cell, address, display text) and explains default behavior for workbook and sheet. This helps the agent understand what to expect without contradicting the annotations.

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, front-loads the purpose in the first sentence, and then provides essential parameter and return information without any fluff. Every sentence adds value.

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 is complete for a simple read-only list tool. It explains what is returned, the parameter defaults, and the scope. Given the annotations already indicate read-only, there are no missing pieces an agent would need to call this 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?

The input schema has zero description coverage, so the description fully compensates by explaining each parameter: workbook is a name or path, with None meaning active workbook, and sheet similarly defaults to active sheet. This adds essential semantics that the schema alone lacks.

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 action: 'List all hyperlinks on a worksheet.' This is specific about the verb (list) and resource (hyperlinks on a worksheet), and naturally distinguishes from sibling tools like add_hyperlink and remove_hyperlink. The scope is unambiguous.

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 (when you need to see hyperlinks), but it does not explicitly mention alternatives or when not to use it. There is no guidance on choosing this over related tools, but the defaults for workbook and sheet are clarified. The usage context is implied rather than stated.

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