Get Console_port_template

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

Annotations already note read-only, idempotent, non-destructive. Description adds that the response includes nested references and supports markdown/json format. No contradictions. Provides additional behavioral insight without redundancy.

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?

Extremely concise: two sentences plus a bullet. Front-loaded with primary purpose. Every sentence adds genuine value with zero waste.

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, description explains return format (markdown/json) and content (full object with nested references). Sufficient for a simple get tool with rich sibling context.

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 covers both parameters (100% coverage). Description reinforces 'numeric id' and adds guidance on response_format for chaining tool calls, going beyond 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?

Clearly states it retrieves a single console_port_template by numeric id. Distinguishes from list tool and other get tools. Verb+resource is specific.

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 using after netbox_list_console_port_templates or when id is known. Implicitly excludes usage without id. Could be more explicit about when not to use, but sufficient.

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