get_document_hyperlinks

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

No annotations are provided, so the description must disclose behavioral traits. It states the tool gets hyperlinks but does not mention whether it is read-only, any side effects, performance implications, or how the result is structured. The parameter descriptions in the schema hint at filtering, but the description itself adds minimal behavioral context.

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 a single, concise sentence that conveys the core functionality without any superfluous words. Every element earns its place.

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?

This is a query tool with no output schema. The description fails to give any detail about what is returned (e.g., list of hyperlinks with properties, links to destinations?). Without this, the agent cannot anticipate the response format, which is a significant gap.

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 100%: both parameters have descriptions in the input schema (e.g., 'Include link destinations', 'Include link sources'). The tool description adds no additional meaning beyond what the schema already provides, so baseline 3 is appropriate.

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 'Get all hyperlinks in the document' uses a specific verb ('Get') and resource ('hyperlinks in the document'), clearly distinguishing it from siblings like 'create_document_hyperlink' which creates 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?

The description implies usage (when you need hyperlinks from a document) but provides no explicit guidance on when to use this tool vs alternatives or when not to use it. There are no direct competing siblings, but the lack of exclusions lowers the score.

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