promote_snapshot

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

The description explicitly labels the operation as 'MUTATING' and 'Async operation', which adds valuable context beyond the annotations (readOnlyHint=false). It also explains the dry-run option for validation, enhancing agent understanding of 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?

The description is two concise sentences with no wasted words. It front-loads the purpose and then adds critical behavioral details, achieving high efficiency.

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 description covers purpose, usage context, mutation, and asynchronicity well. However, it does not specify what the agent should expect after invocation (e.g., returns a task ID or download link directly) or reference related tools for polling. Given no output schema, slightly more detail would benefit completeness.

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 the baseline is 3. The description adds minimal extra meaning beyond the schema by highlighting the dryRun parameter's role. No additional detail is provided for other parameters.

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 the tool promotes a snapshot by packaging it and generating a download link, with a specific use case of preparing for environment transfer. This distinguishes it from siblings like package_snapshot and create_snapshot_download_link.

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 advises using this tool to prepare a snapshot for transfer to another environment, providing clear context. However, it does not explicitly exclude alternatives or specify when not to use it, leaving room for improvement.

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