ship_site

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

Discloses error handling (api_ok: false, never fakes success) and return values (deploy_id, preview_url). No annotations exist, so description carries burden. Could mention permissions or idempotency, but sufficient for core behavior.

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?

Three focused sentences, front-loaded with purpose, then returns, then error behavior. No redundancy.

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 main actions, error handling, and returns. Could mention preconditions (folder must exist, domain valid) or duration, but adequate for typical use.

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 covers 100% of parameters with descriptions. Overall description does not add meaning beyond schema for individual params; baseline 3 applies.

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?

Clearly states the verb (upload), resource (built site folder to Krexel), and process (zips, stages, POSTs). Distinguishes from sibling tools like edit_file or rollback by its deploy-focused action.

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?

Implies usage for deploying a built folder, but no explicit when-not-to-use or alternatives. Sibling context helps, but description lacks direct guidance.

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