POST /hardware/{id}/audit

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

Annotations already declare destructiveHint=true, idempotentHint=false, readOnlyHint=false, openWorldHint=true, so a mutation is signaled structurally. The description adds nothing on top of that: no mention of what the audit records, what irreversible state it changes, or the confirm requirement. It does not contradict annotations, but it contributes zero behavioral context.

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 short, but the second sentence ("Generated from Snipe-IT OpenAPI operation post_audit{id}") carries no actionable information and merely repeats the operation id. Brevity here reflects under-specification rather than efficient structure.

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?

A destructive, non-idempotent write with five parameters, 40% schema coverage, no output schema, and a mandatory confirm gate — yet the definition explains none of it. The agent has no basis for calling this correctly or knowing how it differs from snipeit_audit_hardware.

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 40% (note, id, and location_id are undocumented) and the description contributes no parameter meaning whatsoever. It does not explain note, location_id, or when update_location applies, 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 is just the HTTP route restated: "POST /hardware/{id}/audit. Generated from Snipe-IT OpenAPI operation post_audit{id}." It names a resource and an opaque operation id but never says in plain terms what the tool does (record an audit for an asset, presumably). That is tautology against the title, not a purpose statement.

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?

There is no when-to-use guidance, no prerequisites (e.g., audit permission, SNIPEIT_CONFIRM_WRITES), and no routing to alternatives. In particular it never distinguishes itself from the sibling snipeit_audit_hardware, which appears to do the same thing.

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