Skip to main content
Glama

read_versions

Read-onlyIdempotent

List a survey's saved version snapshots (Version History), newest first, or read one version's full snapshot of blocks, questions, and Flow by version_id.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "survey_id": "<survey_id>"
    },
    "name": "read_versions"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMost recent versions to list (default 20, max 100)
survey_idYesSurvey UUID
version_idNoWhen set, returns this version's full snapshot instead of the list

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and a closed world, so the safety profile is fully covered. The description adds ordering information ('newest first') and clarifies that version_id switches mode rather than filters. It does not discuss pagination beyond the limit parameter or what happens when a version_id is invalid; with a rich output schema, return shape is not a required burden.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence that presents the primary listing behavior first and the secondary single-version mode second. No filler, no repetition of annotation or schema content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With full annotation coverage, a complete input schema, and an output schema handling return values, almost nothing is missing. The only residual gap is that the description does not mention behavior for an unknown version_id or whether the list mode is truncated silently at the limit — minor against an otherwise complete definition.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description goes slightly beyond by explaining what the version_id lookup actually yields — the full snapshot of blocks, questions, and Flow — which the schema only summarizes as 'full snapshot'. It does not add detail on the limit semantics, but the schema already states default 20 and max 100.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource — list a survey's saved version snapshots — and adds a second mode that reads one version's full snapshot of blocks, questions, and Flow by version_id. That is concrete and unambiguous. It stops short of naming a sibling (e.g., create_survey_from_version for restoring a snapshot), so differentiation is implied rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the two modes: omit version_id to get history, supply it to read one snapshot. However, there is no explicit when-to-use framing against alternatives, no statement about when to prefer create_survey_from_version, and no note on when version history is the right source versus read_survey.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources