Create Contact_role

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

Annotations already indicate this is a write operation (readOnlyHint: false) and not destructive (destructiveHint: false). The description adds 'This adds a new row to NetBox' but that's largely redundant. The mention of return format and dry-run consideration provides some additional context, but overall depth is moderate.

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 extremely concise with two short paragraphs. The main action is front-loaded, and every sentence adds value (e.g., dry-run instruction, return format). No wasteful wording.

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 tool's moderate complexity (6 parameters, create operation, no output schema), the description covers the main purpose and return format but lacks details on prerequisites, error handling, or post-creation behavior. It is adequate but not comprehensive.

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 83%, so schema already explains most parameters. The description does not add any parameter-specific information beyond the schema; it only explains the return format via the response_format parameter. Thus, value added is minimal.

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 'Create a new contact_role in NetBox' and the resource. It immediately distinguishes from sibling tools like netbox_get_contact_role, netbox_update_contact_role, etc.

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?

Provides a specific guideline to ask the user before calling if a dry-run is desired, which aids safe usage. However, it does not explicitly state when not to use this tool or mention alternative tools for related operations.

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