Update hardware (partial)

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

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered externally and there is no contradiction. The description adds nothing on top of that: it never mentions that omitted fields are preserved, that a 'confirm: YES' string may be required when SNIPEIT_CONFIRM_WRITES is set, or what the destructive aspect actually affects.

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 front-loaded and free of padding, but at two fragments it is under-specified rather than concise. The brevity is a symptom of missing content, not economy of expression.

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 destructive, open-world mutation tool with a free-form nested body, no output schema, and a conditional confirm parameter, the description omits nearly everything an agent needs. Only the annotations carry the risk profile; the mechanics of a correct call are undocumented.

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 only 33% and the critical 'body' parameter is an open object with additionalProperties: {} and no enumerated fields, so the schema gives the agent zero help on what to send. The description does nothing to compensate — it never names a single updatable hardware field, so the agent must guess the payload shape entirely.

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 verb and resource via the HTTP path (PATCH /hardware/{id}) and adds the qualifier 'partial update', which does distinguish it from a full-update sibling. However, it is essentially a restatement of the endpoint and title rather than a statement of intent, and it never says what 'hardware' means in this system or which fields are updatable.

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 guidance on when to choose this over snipeit_gen_hardware_update (full update), snipeit_gen_hardware_partial_update, or snipeit_raw_request. 'Partial update' hints at a use case but the agent is left to infer the selection rule and any prerequisites.

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