Skip to main content
Glama

Preview Survey

preview_survey
Read-onlyIdempotent

Render an interactive respondent-style preview of a survey or a single question, with demo-only answer controls for supported question types. The full-survey view supports block tabs; the question view isolates one question with prev/next navigation.

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": "preview_survey"
  }
}

Input Schema

NameRequiredDescriptionDefault
viewNo'survey' (default) shows the full block with all its questions. 'question' isolates a single question with Prev/Next question navigation across the whole survey — use this when the user wants to see just one question at a time. Defaults to 'question' if question_id is set, otherwise 'survey'.
block_idNoBlock UUID to open the preview on (default: first block). Ignored if question_id is set.
survey_idYesSurvey UUID
question_idNoQuestion UUID to open on. In the default 'survey' view this scrolls to and highlights the question within its block; in 'question' view (the default when question_id is set) it opens directly on just that question.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The phrase 'demo-only answer controls' usefully signals the answers are not persisted, but it is left implicit rather than stated, and 'supported question types' flags a limitation without saying which types are unsupported.

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

Conciseness4/5

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

Two sentences, front-loaded with the core action and followed by the mode distinction; nothing is padded. Slight redundancy with the view parameter documentation, but no wasted wording.

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?

An output schema exists, so return values need not be explained, and the annotations carry the read-only safety story. Combined with full schema coverage, the description is nearly complete; the only real gap is not clarifying that demo answers are discarded and which question types are previewable.

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

Parameters3/5

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

Schema description coverage is 100%, and the description largely restates what the schema already documents (survey view with block tabs, question view with prev/next). No additional format, constraint, or edge-case detail about view, block_id, or question_id is added beyond the schema.

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?

States a specific verb and resource ('Render an interactive respondent-style preview of a survey or a single question') and adds a scope qualifier ('demo-only answer controls'). It implicitly separates itself from read_survey/read_question by being a rendering preview rather than a data read, but it never names or contrasts with those siblings explicitly.

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?

The description distinguishes the two view modes and says what each supports (block tabs vs. prev/next navigation), which implies when to pick each. However, it gives no guidance on when to use this instead of read_survey, read_question, or edit_survey, and no prerequisites or exclusions are stated.

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