snipeit_gen_hardware_by_idFetch detailed information for a specific Snipe-IT hardware asset using its numeric ID; use this to inspect asset metadata when you have the ID rather than the asset tag.
GET /hardware/{id}: Get the details of a specific asset. Generated from Snipe-IT OpenAPI operation hardware-by-id.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id (not the asset tag) of the asset you'd like to query |
Changes observed during successful MCP inspections.
v0.2.2Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only, idempotent, open-world, non-destructive behavior. The description adds almost no behavioral context beyond restating the GET operation and noting it is OpenAPI-generated; it does not mention error behavior, auth, or response characteristics.
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 short and front-loaded with the operation. The second sentence about OpenAPI generation is low-value, but the overall structure is efficient.
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 simple single-parameter read operation with rich annotations and full schema coverage, this is minimally adequate. However, it lacks sibling differentiation and does not describe response or error behavior, leaving some context gaps.
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%, and the schema itself clarifies that the id is not the asset tag. The description does not add parameter meaning beyond that, so the 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 a clear verb and resource: retrieves details for a specific hardware asset by ID via GET /hardware/{id}. It is understandable, but it does not distinguish itself from sibling tools like snipeit_get_hardware_by_id, get_hardware_by_tag, or get_hardware_by_serial.
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?
Provides no explicit when-to-use guidance or comparison to alternatives. The endpoint implies lookup by ID, but the description does not tell the agent when to choose this over by-tag, by-serial, list, or search tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.