Update Role

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

Annotations already indicate idempotent and destructive hints. Description adds PATCH semantics and response format details. However, it does not clarify the destructiveHint: true implication (e.g., clearing fields) or permissions.

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?

Two sentences plus a returns note, front-loaded with purpose. Every sentence adds value with no verbosity.

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?

Explains return formats (Markdown/JSON) and PATCH behavior. Lacks explanation of destructive side effects (e.g., clearing fields) and does not differentiate from other update tools. Output schema absent, but response format described.

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 has 50% description coverage. The description reiterates that only provided fields change but adds no individual parameter details beyond what schema provides. No compensation for undocumented 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 role in NetBox (PATCH semantics)', specifying the verb (update), resource (role), and method. It distinguishes from create/delete sibling 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?

Instructs to 'Supply the numeric id and only the fields you want to change. Omitting a field leaves it unchanged.' This provides clear when-to-use guidance for partial updates, though no explicit alternatives or when-not-to scenarios.

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