Create Role

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

Annotations already indicate this is a non-read-only, non-destructive mutation. The description adds that it 'adds a new row', reinforcing creation. However, it does not disclose error behavior (e.g., if role already exists) or idempotency details, leaving gaps beyond the 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?

The description is concise: two sentences for purpose/safety and a clear 'Returns:' line for output. Every sentence is relevant, and critical information (dry-run caution) is front-loaded. No filler or redundancy.

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 creation tool with 7 parameters and no output schema, the description covers the return format (Markdown or JSON) and a key safety note. However, it lacks explanation of what a role is in NetBox, relationships to other objects, or error handling, leaving some gaps for an unfamiliar agent.

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 86% schema coverage, the input schema already documents parameters well. The description adds no additional meaning to parameters (e.g., no explanation of slug pattern or weight default), so it provides no extra value beyond the schema baseline.

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 'Create a new role in NetBox' and 'adds a new row', providing a specific verb and resource. It distinguishes from sibling tools (e.g., netbox_list_roles, netbox_update_role) by focusing on creation. The mention of 'dry-run' adds context for the action.

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 only usage guideline is 'Ask before calling if the user wanted a dry-run', which is a safety instruction but does not explain when to use this tool versus alternatives like update_role or list_roles. No context is given for prerequisites or scenarios where creation is appropriate.

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