PATCH /maintenances/{id}

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

Annotations already declare destructiveHint=true, idempotentHint=true, openWorldHint=true and readOnlyHint=false, so the safety profile is covered. The description adds only the mild implication of partial-update semantics via "selected fields" and says nothing about what the destructive write affects or what the confirm gate means in practice.

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?

Two sentences, front-loaded with the operation, which is good. The second sentence is codegen boilerplate that conveys no invocation value, and the whole thing is arguably too terse for a destructive nested-body mutation.

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 PATCH with a nested required body, a synthesized id parameter, and a conditional confirm gate, the description provides only the HTTP verb and resource. It leaves the agent to discover required fields and write-confirmation behavior entirely from the schema.

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 67% and routed through a nested body object, so the description needs to compensate for the remainder. It instead names zero parameters and never mentions the required asset_maintenance_type field, the id path parameter, or the confirm write gate.

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 verb+resource pair ("Update selected fields in an existing maintenance") is clear enough on its own, but it does nothing to separate this tool from the many near-identical maintenance siblings (snipeit_gen_maintenances, snipeit_gen_maintenances_1, snipeit_gen_maintenances_copy, snipeit_gen_maintenancesid). "Selected fields" is also vague about which fields are actually 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 use this versus the other maintenance endpoints, no prerequisites, and no note that the body requires asset_maintenance_type. The trailing "Generated from Snipe-IT OpenAPI operation maintenances-copy-1" is provenance metadata, not usage guidance.

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