qui_list_automations

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

The readOnlyHint annotation already indicates a safe read operation, and the description's mention of GET aligns with that. However, no additional behavioral details are disclosed, such as whether it returns all automations, supports pagination, or has any rate limits.

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 a single, efficiently worded sentence that front-loads the endpoint and method. Every word contributes to explaining the request structure, with no redundancy or filler.

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?

The tool is a simple GET request, but the description omits explicit mention of the required instanceID path parameter (though implied in the URL) and doesn't mention what the response contains. Given the low schema coverage, this is a noticeable gap, though the output schema partially compensates.

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 generic with no parameter details, but the description adds a structural convention: path variables go in arguments, query values in arguments.params, and body in arguments.body. This helps, but it doesn't specify the required instanceID or any available query parameters, leaving the agent to guess.

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 specifies the HTTP method (GET) and endpoint (/instances/{instanceID}/automations/), clearly indicating a read operation to retrieve automations. However, it doesn't explicitly state 'list' or describe what the automations represent, and it doesn't differentiate from sibling tools like qui_list_automation_activity.

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?

No guidance is provided on when to use this tool versus alternatives such as qui_list_automation_activity or qui_create_automation. The description only explains request mechanics, not use cases or context.

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