deploy_list

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

With no annotations provided, the description carries the full burden. It explains the return data, pagination mechanism, and the requirement for project_id being 'apikey-gated'. It does not explicitly state read-only, but 'list' implies safe operation. Additional details on rate limits or side effects would be helpful but are not required for a list operation.

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 concise with two sentences. The first sentence front-loads the purpose and return fields, and the second sentence adds usage guidance and parameter hints. No unnecessary words.

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 the tool's complexity (three parameters, no output schema, no annotations), the description covers purpose, return fields, usage scenarios, and parameter behavior (limit, cursor). It is effectively complete for a list 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?

The input schema already covers all three parameters with descriptions. The description adds value by explaining the usage of limit (bound result set) and cursor (pagination) beyond the schema's definitions, and clarifies the context for project_id. However, it does not elaborate on the format of cursor or limit beyond what is in the schema.

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 it lists recent deploy operations for a project, specifies the fields returned (operation_id, status, release_id, timestamps), and directly distinguishes from sibling tools like deploy_resume and deploy_events by explaining how the output can be used with them.

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 provides explicit use cases (building deploy-history UIs, finding operation_id for other tools) and gives guidance on using limit and cursor for pagination. It does not include explicit when-not-to-use statements, but the context is clear enough.

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