netbox_get_device

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

No annotations provided, so the description must cover behavioral traits. The '[READ]' prefix indicates a read-only operation, which is helpful. However, it does not disclose what fields are returned, error handling (e.g., device not found), or any side effects, leaving gaps for the agent.

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 extremely concise with two clear sentences. The first sentence states the action and result, and the second explains the parameter with a useful cross-reference. 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 the tool's simplicity (single required parameter, no output schema), the description adequately covers its purpose and parameter. It could mention the return format or error behavior, but as a single-device lookup, it is sufficiently complete for most agents.

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?

With 0% schema description coverage, the description adds meaningful guidance: the parameter must be an exact device name, not partial. It also references the list tool for discovery, which enhances understanding beyond the schema's bare type definition.

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 the tool returns a single NetBox device by exact name, using the verb 'Return' and specifying the resource. It distinguishes from the sibling tool 'netbox_list_devices' by noting the exact name requirement and cross-referencing the list tool.

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?

The description provides clear context: use when you have an exact device name. It references netbox_list_devices for finding names, implying a usage flow. However, it does not explicitly exclude alternative use cases or mention when not to use this tool.

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