remove_hyperlink

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

With no annotations, the description carries the burden of behavioral disclosure. It reveals that the hyperlink element is unwrapped and text runs are preserved, but it omits details on edge cases (e.g., hyperlink not found, invalid para_id) and whether the tool modifies the document in-place. The transparency is adequate but not thorough.

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 exceptionally concise: two sentences plus an args list. It is front-loaded with the primary action and includes only essential details. No extraneous information exists, making it efficient for an agent to parse.

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 the low complexity (2 parameters, no enums, no output schema), the description covers the core purpose and parameters. However, it lacks information about the return value or success/failure behavior. With no output schema, the description should ideally clarify what the agent can expect after calling the tool.

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 0% description coverage, but the tool's description explains both parameters: para_id as the paragraph identifier and url_or_anchor as the URL or bookmark to match. This adds significant meaning beyond the schema's bare titles, helping the agent understand required inputs.

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 removes a hyperlink wrapper while preserving text runs. The verb 'remove' and resource 'hyperlink' are specific, and the explanation of unwrapping distinguishes it from siblings like 'update_hyperlink' or 'add_hyperlink'.

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 does not provide guidance on when to use this tool versus alternatives like 'update_hyperlink'. There is no mention of prerequisites or scenarios where removal is appropriate versus modification. The context signals show sibling hyperlink tools, but no comparative guidance is given.

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