Get Console_server_port_template

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

Description adds behavioral detail beyond annotations by specifying return format options (markdown and JSON) and their use cases. Annotations already indicate read-only, idempotent, and non-destructive behavior, so the description complements them well.

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?

Three short paragraphs are highly concise and front-loaded: purpose first, then usage context, then return details. Every sentence adds value with no 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?

Description covers purpose, usage sequence, and return format. While it doesn't detail error handling, it is adequate for a simple read tool with annotations. No output schema is needed since format is 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 coverage is 100% with clear descriptions for both parameters. The description adds usage guidance for the response_format parameter, explaining when to use JSON for chaining follow-up calls, which goes beyond the schema.

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?

Description clearly states 'Get a single console_server_port_template from NetBox by numeric id.' It uses a specific verb and resource, and distinguishes from the list sibling by explicitly mentioning the list tool for prior location.

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?

Explicitly advises 'Use after netbox_list_console_server_port_templates has located the object, or when you already have the id.' This provides clear context for when to use this tool versus alternatives, though it doesn't explicitly list when not to use it.

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