coolify_get_deployment

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

The description adds value beyond the annotations by disclosing the return content (status, timestamps, commit info, error summary). Annotations already declare readOnly, idempotent, and non-destructive behavior. There is no contradiction, and the added detail is useful for understanding what the tool provides.

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 one concise, front-loaded sentence with a colon introducing the key data points. Every word earns its place, and the structure is clear and scannable.

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 read-only tool with a single parameter, the description is complete. Annotations cover safety, schema covers the parameter, and the description covers return values. No output schema exists, but the listed return fields suffice. The simplicity of the operation does not require more.

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 schema covers 100% of the parameter (deployment_uuid) with a clear description. The tool description only reiterates 'by UUID', adding no new meaning. With full schema coverage, the baseline of 3 applies.

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 states the tool gets a deployment detail by UUID, listing the specific data points (status, timestamps, commit info, error summary). It uses a specific verb ('Get'), identifies the resource ('deployment detail'), and distinguishes from siblings like coolify_list_deployments by specifying a single deployment lookup.

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 makes it clear this is for retrieving a single deployment by UUID, implying it is for specific deployment details rather than listing or mutating. However, it does not explicitly mention alternatives or when not to use it, though sibling tool names provide context.

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