restore_agent_version

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

No annotations provided, but the description discloses key behaviors: it operates only on the draft, snapshots the current draft making the operation undoable, and does not affect the live version until approved. Covers the main safety aspects.

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 sentences, each adding essential information. Front-loaded with the action and resource. No wasted or redundant words.

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 3 required parameters with schema descriptions, the explanation of behavior and parameter specifics is sufficient. Lacks description of return values, but output schema is absent, so this is acceptable.

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?

Adds meaning beyond the input schema by clarifying that versionId is a UUID from list_agent_versions, and expectedVersion is the last read draft version with a 409 if stale. This helps the agent select and invoke correctly.

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 specific action ('Roll a agent's DRAFT back to an earlier version') and resource, distinguishing it from sibling tools like 'restore_agent' which restores the entire agent.

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?

Provides explicit guidance that the versionId must be a UUID from list_agent_versions, not the checkpoint number. Also mentions the current draft is snapshotted first, implying safety. Lacks explicit when-not-to-use or alternative tools, but the context is clear.

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