get_deployments

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

No annotations provided, so description must carry full burden. Discloses compact vs full detail, filter operators, and examples. However, does not state idempotence, read-only nature, or pagination behavior beyond limit parameter. Adequate but not comprehensive.

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?

Description is succinct and front-loaded with key behavior ('Get deployments with optional filters'). Filter operators are listed in a structured, easy-to-read format. Could be slightly shorter, but effective.

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?

Given 3 parameters and an output schema, description covers filter usage well and explains return detail differences. Missing mention of what happens with large result sets (though limit is present) and default behavior when no filter is applied. Overall sufficient.

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?

Extensive explanation of filter operators with examples (any_, all_, like_, etc.) and how to use them. Adds significant meaning beyond the schema's terse description of the filter object. Limit and workspace_id are also clarified in schema, but filter gets rich 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?

Clear verb 'get' and resource 'deployments'. Distinguishes from siblings by specifying it retrieves deployment objects, while siblings target other entities (flows, runs, etc.). Examples and filter details reinforce purpose.

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?

Describes when to use filters and how to get full detail vs compact summaries. Provides explicit examples. Lacks when-not-to-use guidance, but the tool's scope is clear enough.

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