Skip to main content
Glama

Publish Survey

publish_survey
DestructiveIdempotent

Publishes a survey — starts collecting responses — and returns the public share link respondents open. Idempotent: publishing an already running survey is not an error; the current state comes back with wasAlreadyStarted=true. The started state is verified server-side by re-reading the publication before success is reported. The account's limit on concurrently running surveys is enforced: when it is reached the call fails with a message naming the limit and the current count — relay it; the user can stop another survey first. Publishing also fires the survey's SurveyPublished webhooks, if any are configured. Uses the same start flow as the application UI — never creates duplicate publications. Once published, responses start collecting on the share link and the survey counts against the account's concurrent-survey limit. Surveys can also be published from the app.

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 and clone_survey.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
shareURLNo
isStartedNo
surveyCodeNo
wasAlreadyStartedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing webhook side effects (SurveyPublished), the concurrent-survey limit and its failure message, the instruction to relay that message, and server-side re-verification of the started state. These are operationally important traits the structured fields do not convey.

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

Conciseness3/5

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

The core purpose is front-loaded, but the text runs long and repeats itself: the concurrent-limit consequence is stated twice, and 'Surveys can also be published from the app' restates the earlier UI-flow sentence without adding value.

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?

Given a mutation tool with an output schema and rich annotations, the description still supplies the error behavior, idempotency semantics, side effects, and limit enforcement an agent needs to invoke it correctly. Nothing material is missing.

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 coverage is 100% and the single 'code' parameter is fully documented in the schema, including format and source tools. The description adds nothing about the parameter, so the baseline 3 applies.

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 (publishes), the resource (a survey), and the concrete effect (starts collecting responses) plus the return (public share link). This clearly separates it from siblings like pause_survey and archive_survey.

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?

Implies usage context (publishing to start collection, stopping another survey when the limit is hit) but never names the alternative tool (pause_survey) or states explicit when-not conditions. Guidance is inferable rather than 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