create_version

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

Annotations already state destructiveHint=true. Description adds detail: workspace deletion, creation of new empty workspace, returned path, and error checks. This exceeds annotation-only information.

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?

Well-structured: immediate purpose, bold warning, actionable instructions, then parameter list. Front-loaded with critical info. No unnecessary sentences.

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 all necessary behavioral context for a destructive tool with 5 params. Even though output schema exists, description explains key return aspects (newWorkspacePath, compilerError, syncStatus). Complete enough for safe invocation.

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 0%, so description compensates by explaining all 5 parameters: account_id (numeric or path), container_id (numeric or path), workspace_id (numeric, find via list_workspaces), name and notes (optional). Missing format details but sufficient.

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 specific verb 'snapshots' and resource 'workspace into a new container version'. Distinguishes from siblings like publish_version and list_versions by explaining the lifecycle step.

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?

Explicit warning that the workspace is consumed and alternative path returned. Tells when to use (create version) and when not to publish with errors. Mentions troubleshooting steps for compilerError and syncStatus.

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