Update Contact_assignment

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

Annotations already provide destructive and read-only hints. Description adds PATCH semantics, non-destructive partial updates, and return format details. No contradiction with annotations.

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?

Three crisp sentences: purpose, usage instruction, return description. No wasted words, front-loaded with key 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?

Covers operation semantics and return format, but lacks explanations for many parameters (role, contact, priority, etc.) and custom_fields usage. Adequate for a simple update but not fully complete given parameter count.

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 coverage is 44%. Description adds PATCH behavior but does not explain individual parameter meanings beyond what schema provides. Adequate but not compensatory for missing schema descriptions.

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?

Clearly states 'Update an existing contact_assignment in NetBox (PATCH semantics)'. The verb 'update' and resource are explicit, and it distinguishes from sibling create_ and delete_ tools.

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?

Explains when to use (to update an existing assignment) and provides guidance: supply id and only fields to change. Does not explicitly exclude alternatives, but the context is clear given siblings.

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