Get deployment

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

With no annotations provided, the description must disclose behavioral traits. It only says 'get', implying a safe read operation, but provides no details on return format, error handling, or whether logs are truncated or paginated. This minimal disclosure does not meaningfully exceed the schema's information.

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 concise sentence with no filler. It front-loads the action and resource, making it easy to parse.

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 simple with one parameter and no output schema, and the description names the return content ('status and logs'). However, it lacks guidance on when to use this versus related tools, and doesn't explain edge cases like missing UUIDs or the structure of logs. It is minimally viable but not complete.

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 description coverage is 0%, so the description must add meaning. The phrase 'by UUID' clarifies that the lone required parameter 'uuid' is the deployment identifier, which is helpful but not substantial. It doesn't mention format, length, or how to find the UUID.

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 verb 'get', the resource 'deployment', and the specific data returned ('status and logs'). It distinguishes from sibling tools like getLogs by scoping to deployment and including status, and requires a UUID.

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 explicit guidance on when to use this tool versus alternatives such as getLogs or listDeployments. The description implies you need a deployment UUID but doesn't state the context or exclusions, leaving the agent to infer usage.

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