get_survey_version

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

Beyond the readOnlyHint annotation, the description adds important behavioral context: the QSF export may not be accepted unchanged by the import API. This informs the agent of a potential limitation not captured in annotations.

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 exceptionally concise—only two sentences. The first sentence states the core purpose, and the second adds a critical caveat. No unnecessary 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?

For a simple retrieval tool with annotations and full schema coverage, the description covers the main purpose and a key behavioral nuance. It does not mention return format or error conditions, but given the lack of output schema, the description is reasonably complete. Minor missing detail: how to obtain the versionId.

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?

The input schema already describes all parameters with 100% coverage. The description adds context about the format parameter (explicitly naming JSON and QSF) but does not provide additional semantic details beyond the schema's enum and descriptions.

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 action 'Get' and the resource 'saved survey version', and specifies the available formats (JSON or QSF). It distinguishes from sibling tools like create_survey_version and list_survey_versions by focusing on retrieval of a specific saved version.

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 implies when to use this tool (to retrieve a saved survey version) but does not explicitly state when not to use it or mention alternatives. The caveat about QSF not being guaranteed for import is helpful but doesn't provide guidance on choosing between get_survey_version and other tools like list_survey_versions or import_survey_qsf.

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