list_deployments

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the semantic that a deployment represents an execution of infrastructure, which provides useful domain context but does not disclose additional behavioral traits like auth requirements, rate limits, or pagination. Given the annotations, the description adds some value but not rich behavioral disclosure.

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?

Two sentences with zero waste. The main action ('List all deployments') is front-loaded, the optional filter is mentioned, and the domain definition is added in a second sentence. No redundant phrasing.

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 (list with optional filter), has an output schema to cover return values, and annotations cover safety. The description provides the purpose, the optional filter, and the meaning of a deployment, making it complete for an agent to correctly invoke the tool.

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 100% and the parameter 'stackId' is already described as 'Filter deployments by stack ID'. The description repeats this with 'Optionally filter by stackId' without adding new meaning or format details. Baseline of 3 is appropriate when the schema carries the parameter documentation.

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 states a specific verb ('List') and resource ('deployments'), and distinguishes itself from siblings like get_deployment, create_deployment, and start_deployment by clearly indicating it lists all deployments. It also adds domain context ('Each deployment represents one execution of a stack's infrastructure') that clarifies what is being listed.

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 clearly indicates that this tool lists all deployments with an optional filter by stackId, which provides clear context for when to use it. However, it does not explicitly mention when not to use it or name alternatives (e.g., 'use get_deployment for a single deployment'), so it lacks explicit exclusions but is otherwise clear.

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