get_version

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

Beyond the readOnlyHint annotation, the description discloses that returned contents are slimmed to avoid large outputs and that other get functions read the workspace draft. It adds meaningful context about what the tool does and does not do, though it could mention potential error cases.

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 extremely concise with no redundant sentences. It front-loads the main purpose, then adds necessary context and alternative guidance in a well-structured paragraph, making efficient use of space.

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 read-only nature and existence of an output schema, the description covers the key behavioral aspects: what is returned, why it's slimmed, and alternative tools. It could mention error handling for missing version or invalid IDs, but overall it's sufficiently complete.

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?

With 0% schema description coverage, the description provides basic parameter clarification: each can be numeric ID or full resource path, and version_id can be found via list_versions. However, it lacks specifics on resource path format or examples, leaving some ambiguity.

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 explicitly states the tool retrieves a single container version with metadata and slimmed contents, using clear verb 'Gets' and specific resource. It distinguishes from siblings like get_live_version and get_tag by noting the scope and the slimmed nature.

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 guidance on when to use alternatives (get_tag/get_trigger/get_variable) and notes their difference (reads workspace draft vs this version). It also advises finding version_id via list_versions, which is helpful for the agent.

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