Search hardware by free text

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

Annotations already declare readOnly, idempotent, non-destructive, open-world, so the safety profile is covered. The description adds nothing beyond restating the endpoint: no note on search semantics, result caps, or pagination interaction with the `all` parameter, which is the only real behavioral risk here.

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?

It is extremely short and front-loaded, with no wasted words, but the brevity comes at the cost of under-specification rather than efficiency. The single fragment does not earn much on its own.

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 four parameters, low schema coverage, no output schema, and a very dense sibling namespace, the description is far too thin. An agent cannot tell how results are shaped, whether they are paginated, or how this differs from related hardware lookup tools.

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 only 25% — only `all` is documented, while `query`, `limit`, and `offset` have no schema descriptions. The description says nothing about what `query` matches, acceptable `limit` values, or offset behavior, so it fails to compensate for the coverage gap.

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 names the HTTP endpoint GET /hardware?search={query}, which combined with the title 'Search hardware by free text' conveys a search operation over hardware. However, it doesn't state what fields are searched or what is returned, and it does not distinguish this from siblings like snipeit_list_hardware, snipeit_get_hardware_by_serial, or snipeit_get_hardware_by_tag beyond the 'free text' hint.

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 single word 'Convenience' weakly implies this is a shortcut over snipeit_raw_request, but there is no explicit when-to-use guidance and no exclusions. With over 150 siblings including several hardware-lookup tools, an agent gets no routing guidance.

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