qui_update_orphan_scan_settings

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

With no annotations, the description carries the full burden of disclosing side effects. It merely says to call the endpoint without mentioning that this mutates settings, may require permissions, or could overwrite existing configuration. The PUT method implies a write operation, but this is not explicitly stated.

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 two sentences, front-loaded with the endpoint, and contains no filler. Every word contributes to explaining how to invoke the tool.

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?

Despite having an output schema, the tool is under-specified on input. The description explains the argument packing convention but not the structure of the JSON body or the required fields. An agent would still not know what settings to send in the request.

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?

The input schema is a generic catch-all object with 0% field coverage. The description adds structural guidance on how to pass path variables, query values, and the request body, but it does not enumerate the actual settings fields or explicitly state that instanceID is required. This is syntactic help rather than semantic parameter meaning.

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 clearly identifies the exact endpoint (PUT /instances/{instanceID}/orphan-scan/settings) and HTTP method, which conveys that this tool updates orphan scan settings. This is specific and distinguishes it from sibling tools like qui_get_orphan_scan_settings.

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 description provides no guidance on when to use this tool versus alternatives, such as retrieving settings first or using a different update path. It only explains how to call the endpoint, not the context or prerequisites.

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