Get Contact

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

Adds return format details (Markdown or JSON) and mentions nested references. Annotations already indicate readOnly, idempotent, non-destructive, so the description adds moderate behavioral context beyond them.

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?

Five concise lines in three short blocks, front-loaded with purpose and usage. No redundant information.

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?

Complete for a simple get tool: covers purpose, usage, parameters, return format. No output schema exists, but description sufficiently describes the outcome.

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 already provides full descriptions for both parameters (100% coverage). The description does not add significant new meaning beyond summarizing the response format use case.

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 'Get a single contact from NetBox by numeric id,' using a specific verb and resource. It distinguishes this tool from siblings like netbox_list_contacts (which lists many) and netbox_create_contact.

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_contacts or when the id is known, providing clear when-to-use guidance. Implicitly excludes use when id is unknown.

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