deployado_deploy

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

Goes well beyond annotations by disclosing the four-stage pipeline, immediate return with release_id, background execution, and the status state machine (queued → pending → building → ready or failed). Annotations already cover safety profile; the description adds workflow semantics an agent needs.

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?

Front-loaded with the core action plus async note, then a compact pipeline diagram, then a bulleted follow-up guide. Slight redundancy with the schema on branch/commit_sha defaults, but overall tight and scannable.

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?

Covers mutation semantics, async build lifecycle, error/recovery paths, and downstream tool chaining. No output schema exists, and the description compensates by naming the returned release_id and its follow-up uses.

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 coverage is 100%, so baseline is 3. The description adds resolution logic for commit_sha absent from the schema itself ('latest commit from the configured branch'), which meaningfully augments parameter behavior.

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?

States a specific verb and resource ('Trigger a new deployment for an app') and immediately clarifies synchronous-vs-asynchronous behavior. Distinguishable from siblings like deployado_deploy_blueprint or deployado_rollback.

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?

Explicitly routes the agent post-call: use deployado_get_release for build status, deployado_get_build_logs on failure, deployado_get_logs for runtime logs. Also explains commit_sha default via 'if omitted, the latest commit from the configured branch is used'.

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