coolify_list_deployments

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

Annotations already declare read-only, idempotent, and non-destructive behavior, so the burden is lower. The description adds the 'Newest first' ordering detail, which is not encoded in the schema or annotations. However, it does not disclose return format, pagination, or default behavior when no filters are given.

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 sentence that front-loads the action and resource, lists filters compactly, and includes the sorting order. Every word contributes value, with no redundancy or fluff.

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 simple list operation with strong annotations and full parameter schema, the description covers the essential purpose and ordering. It lacks explicit return structure, but the action 'list' implies a collection of deployments. It is adequate for basic invocation, though a bit more detail on response shape would improve it.

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 100%, with each parameter having a descriptive comment. The tool description merely names the filters without adding any extra meaning, examples, or constraints beyond what the schema already provides. Baseline of 3 applies due to high schema coverage.

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 uses the specific verb 'List' with the resource 'deployments' and enumerates the available filters, making it clear this is a query operation for multiple deployments. It also specifies sorting order ('Newest first'), distinguishing it from single-deployment retrieval or cancellation tools.

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 implies use when a user needs to list or filter deployments, but it does not explicitly reference alternative tools like fetching a single deployment or canceling one, nor does it state when not to use it. There is no comparison to sibling tools or exclusion conditions.

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