snipeit_hardware_get

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only says 'get' without mentioning the return format, whether it's a read-only operation, or any potential errors. The agent is left unaware of what the tool returns or side effects, though 'get' implies a read.

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 a single, efficient sentence that directly states the core action. No wasted words or filler, and it is front-loaded with the key 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?

For a tool with only one parameter and no output schema, the description should at least clarify what the response contains (e.g., full asset details) and how it may differ from by_tag. It fails to compensate for the missing output schema, leaving the agent with insufficient context about the return value.

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 100%, as the single parameter 'id' is described as 'Asset ID' in the schema. The description adds no additional parameter meaning beyond the schema, so a baseline of 3 is appropriate.

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?

States the verb 'get' and the resource 'hardware asset by ID', making the basic purpose clear. It distinguishes from list (multiple) and by_tag (which fetches by tag), but doesn't explicitly name alternatives or clarify the difference between ID and tag-based retrieval.

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?

No guidance on when to use this tool vs the many siblings (e.g., snipeit_hardware_by_tag, snipeit_hardware_list). The description implies use when you have an asset ID, but that is left to inference rather than stated.

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