Update Console_port_template

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

The description adds value beyond annotations by explaining PATCH semantics (only provided fields changed) and response format options. Annotations already cover idempotent and destructive hints, and the description aligns with them, no contradiction.

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 two concise paragraphs front-loading purpose and usage, with no wasted words.

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 no output schema, the description explains return formats. However, with 8 parameters and low schema coverage, more detail on parameter meanings and constraints would be needed for full completeness.

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 only 25% (only id and response_format have descriptions). The description does not explain the other 6 parameters (name, type, label, etc.) beyond the update behavior. It compensates partially but insufficiently.

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 console_port_template' with PATCH semantics, distinguishing it from sibling update tools for other NetBox objects. It specifies the verb and resource exactly.

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?

It provides clear instructions: supply numeric 'id' and only fields to change. While it doesn't explicitly mention when not to use or alternatives, the sibling tools are for different objects, so the context is implied.

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