Skip to main content
Glama

Update survey

survey_update
Idempotent

Edits a survey, or opens or closes it with status. Opening makes the survey page public and lets campaigns that ask its questions be test-sent and scheduled; closing stops new answers. Questions you pass replace the whole list; keep each existing question id so earlier answers stay matched. Fields you leave out stay as they are. Sends nothing. Requires API key scope: draft.

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

Input Schema

NameRequiredDescriptionDefault
nameNo
introNo
titleNo
statusNo"open" to start taking answers, "closed" to stop, "draft" to take it offline.
questionsNo
survey_idYesSurvey id (a UUID), as returned by survey_create or surveys_list.
thank_you_messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, it discloses public visibility, campaign scheduling prerequisites, answer-intake behavior, whole-list question replacement, preservation of omitted fields, the fact that nothing is sent, and the required API-key scope. These are substantial operational side effects, safety considerations, and authorization requirements, with no conflict against the supplied annotations.

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?

The description front-loads the operation and then uses short, dense sentences for lifecycle effects, replacement risk, omitted-field behavior, sending, and authorization. Every sentence contributes actionable information without filler or unnecessary repetition.

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 seven-parameter mutation with detailed question configuration and no output schema, it supplies the critical rules needed to invoke the tool safely, especially omitted-field behavior and question replacement. The schema handles detailed formats and question types, while the description covers lifecycle consequences, authorization, and non-sending behavior; no essential selection or invocation gap remains.

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?

With only 29% schema description coverage, the description meaningfully compensates by explaining status consequences, partial-update behavior, full question-list replacement, and preservation of existing question IDs. Some status and ID guidance repeats the schema, and the simple text fields receive no additional description-level semantics, so the compensation is strong but not exhaustive.

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 opening sentence gives a specific verb and resource, then clarifies that the same tool handles opening and closing through status. This functionally separates it from survey creation and results retrieval, but it does not explicitly differentiate or route between sibling tools.

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

Usage Guidelines4/5

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

It provides concrete usage context: open a survey to publish its page and enable dependent campaign test sends and scheduling, close it to stop new answers, and pass questions only when intending to replace the full list. It does not provide explicit when-not guidance or name an alternative tool, so it falls short of a 5.

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