Skip to main content
Glama

Pause Survey

pause_survey
Idempotent

Pauses a survey: a RUNNING survey stops accepting NEW responses. HIGH-CONSEQUENCE action on a live survey — get the user's EXPLICIT consent before calling with confirm:true; call WITHOUT confirm first, which is a read-only PREVIEW with zero side effects (live state, response counts, concurrency slots), and show the user what pausing means. Pausing is REVERSIBLE — publish_survey re-starts the SAME publication and collection resumes into the SAME dataset (PublicationID unchanged, nothing deleted). Respondents currently mid-response will finish and be saved — only NEW entries are closed; a new visit to the share link sees the survey-closed page. Pausing frees one of the concurrent-survey slots. Guards: a never-published survey is refused ('there is nothing to pause'); pausing an already stopped survey (including one that auto-closed) is idempotent success with wasAlreadyStopped. The paused state is verified server-side by re-reading the publication before success is reported.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYesSurvey publication code — the 8-character code from the survey's public link (e.g. 1a2b3c4d). Returned by list_surveys.
confirmNoOmit or false → read-only preview of what pausing would do, NO change is made. true → actually pause the survey (only after the user explicitly agreed).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNoWhat the call did, verified, refused or previewed — the complete human-readable outcome.
previewNotrue when the call was a preview (confirm not passed): nothing was changed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Goes well past the annotations: it discloses that mid-response respondents are saved while only new entries close, that the share link shows a survey-closed page, that a concurrency slot is freed, that a never-published survey is refused, that double-pausing is idempotent success with wasAlreadyStopped, and that the paused state is re-read server-side before success. That is exactly the behavioral depth a high-consequence mutation needs, and it is consistent with idempotentHint=true and destructiveHint=false.

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?

Front-loaded with the action and the consent warning, and nearly every sentence carries non-redundant information (reversibility, guards, mid-response behavior). It is dense and heavily ALL-CAPS-emphatic, which costs a little readability, but there is essentially no filler.

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

Completeness5/5

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

For a two-parameter, high-consequence mutation with an output schema already covering return values, the description supplies everything an agent needs: side effects, reversibility path, consent protocol, guard conditions, and idempotency. Nothing material is left to inference.

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 coverage is 100% and both params are described there in detail, so the baseline is 3. The description earns an extra point by tying confirm:true to a consent precondition and clarifying that the no-confirm path is a preview reading live state, response counts, and concurrency slots, which frames the parameter as a workflow gate rather than a bare boolean.

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

Purpose5/5

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

States a specific verb and resource and pins the exact scope: 'a RUNNING survey stops accepting NEW responses.' The reversibility contrast with publish_survey and the distinction from archive_survey (nothing deleted, PublicationID unchanged) lets an agent separate this from its siblings without opening a schema.

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

Usage Guidelines5/5

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

Prescribes an explicit call sequence: call WITHOUT confirm first for a zero-side-effect preview, show the user what pausing means, then call with confirm:true only after explicit consent. It also names the sibling that reverses the action (publish_survey), covering both when to use and what restores state.

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