update_private_link

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 only states 'Update,' implying mutation, but does not explain whether the update is partial or full, whether it requires specific authorization, or whether the operation is reversible. The description adds no details beyond the verb itself.

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 sentence with no fluff, but it is too brief to be fully helpful given the tool's complexity (3 required params, no annotations). It earns its place but could include a bit more context without becoming verbose.

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?

Despite having a 100% schema coverage and an output schema (unknown richness), the description does not explain the behavior of the 'fields' parameter (e.g., whether it merges or replaces), nor does it clarify enterprise-specific constraints. Sibling tools provide context, but the description alone is insufficient for an agent to confidently invoke this 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?

Schema description coverage is 100% (all three parameters have descriptions in the schema). The tool description does not add any additional meaning beyond what the schema provides. Baseline of 3 is appropriate because the schema already explains each parameter's role.

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 ('Update') and the resource ('private booking link') with an enterprise qualifier. It distinguishes the tool from siblings like create_private_link, delete_private_link, and list_private_links. However, it does not elaborate on the scope of updates, e.g., which fields beyond the schema example are modifiable.

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?

No instructions are provided on when to use this tool versus alternatives, such as when a partial update is needed vs. using create_private_link anew. There is no mention of prerequisites (e.g., user must have enterprise permissions) or exclusions.

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