coolify_get_resource

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered. The description adds value by noting 'Sensitive fields are redacted,' which informs the agent that the response will omit certain information. This goes beyond what annotations provide and is important since there is no output schema.

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 only two sentences, both of which carry meaningful information. It is front-loaded with the core action and includes a crucial transparency note. No wasted words or redundancy.

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 getter with two well-documented parameters and strong annotations, the description is complete. It covers the essential purpose and the redaction behavior. It does not detail the response structure, but with no output schema, that might be expected; still, the lack of guidance on not-found behavior or response format slightly prevents a 5.

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 has 100% description coverage for both parameters, including the enum for type and pattern for uuid. The description only restates 'by UUID and type,' adding no new meaning beyond the schema. Baseline 3 is appropriate since the schema does the heavy lifting.

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's function: 'Get a single resource detail by UUID and type.' This specifies the verb, resource, and method of identification, and distinguishes it from sibling list/get tools by emphasizing 'single' resource. The addition of 'Sensitive fields are redacted' also clarifies a key aspect of the response.

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 when to use the tool (when you have a UUID and type for a specific resource) but does not explicitly mention alternatives or exclusions. For example, it doesn't say 'use list_resources to get all resources.' The guidance is only implied by the tool's purpose, not stated.

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