Update Asset

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

Discloses PATCH semantics and return format options (Markdown/JSON). Annotations already indicate write operation and idempotency; description aligns and adds output format context. No contradictions.

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 return-format line, all front-loaded. No wasted words; each sentence adds value.

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 27 parameters and no output schema, the description is too brief. Lacks information on parameter meanings, error handling, prerequisites, and behavioral details beyond PATCH semantics. Does not cover important aspects like required permissions or identifier lookup.

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 only 19%; description does not explain the many undocumented parameters beyond the general guidance to provide only desired fields. Only adds meaning for response_format. Insufficient compensation for low coverage.

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 specifies 'Update an existing asset in NetBox' with explicit mention of PATCH semantics. Distinguishes from create/delete siblings by its name and description.

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 explicit instructions: supply numeric 'id' and only fields to change; omitting a field leaves it unchanged. Does not explicitly state when not to use or compare to alternatives, but the naming convention makes the choice clear.

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