add_internal_link

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

With no annotations, the description discloses key behaviors: appends at end of paragraph, references bookmarks, and does not add a relationship. However, it lacks details on prerequisites, error conditions, or effects on existing content.

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 followed by a clean bullet list of parameters. No fluff, front-loaded with purpose, easy to scan.

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 3 string parameters and an output schema (not referenced), the description covers the core functionality and parameter roles. It could mention the output or prerequisite of existing bookmarks but is largely complete.

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%, so the description must clarify parameters. It explains para_id as w14:paraId, text as display text, bookmark as bookmark name, adding context beyond schema titles. But baseline is 3 due to minimal added value beyond clarifying types.

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 verb 'Append', the resource 'internal anchor hyperlink', and the location 'at the end of a paragraph', distinguishing it from siblings like add_hyperlink (external links) and add_bookmark (creating bookmarks).

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 mentions that internal links reference bookmarks and do NOT add a relationship, but it does not explicitly state when to use this tool versus alternatives like add_hyperlink or add_bookmark. Usage context is implied but not directly guided.

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