Update Contact_role

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

The description explains PATCH semantics, adding value beyond annotations which already indicate idempotentHint=true and destructiveHint=true. It informs the agent that only provided fields change, which is useful 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 four sentences long, front-loaded with purpose and key usage instructions. Every sentence adds value, with no redundant or extraneous information.

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 seven-parameter update tool without an output schema, the description covers the update semantics and return format options. It lacks details on error handling or side effects, but is sufficiently complete for typical use.

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?

With 57% schema description coverage, the description adds meaning for 'id' and 'response_format' but does not elaborate on 'name', 'slug', or 'description'. It implies these are optional, but the schema itself lacks descriptions for some parameters.

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 'Update an existing contact_role in NetBox (PATCH semantics — only provided fields are changed).' This is a specific verb+resource and distinguishes from sibling tools like create or delete.

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 explicitly instructs to supply the numeric 'id' and only the fields to change, and notes that omitting a field leaves it unchanged. This provides clear usage context, though it does not mention when not to use the tool or compare to alternatives.

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