Skip to main content
Glama

Survey Update Description

survey_update_description
Destructive

Set, or clear with null, a survey's description in one of its languages. lang must already be on the survey, and for any language other than English auto-translate must be off. Needs version = versions.current from survey_get; the result returns the next surveyVersion for your next edit.

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": {
      "surveyId": "<surveyId>",
      "lang": "<lang>",
      "description": "<description>",
      "version": "<version>"
    },
    "name": "survey_update_description"
  }
}

Input Schema

NameRequiredDescriptionDefault
langYesLanguage code (e.g., "en")
versionYesCurrent survey version: versions.current from survey_get, or the surveyVersion your last edit returned. A stale version is rejected (WRONG_VERSION). The result returns the next one as surveyVersion.
surveyIdYesSurvey ID (from survey_list)
descriptionYesNew description (null to clear)

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds behavior beyond that: null clears the value, language and auto-translate preconditions can block the call, and the response drives the next write via surveyVersion — useful sequencing and constraint context rather than restatement.

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?

Three dense sentences, front-loaded with the action and the null semantics, followed by preconditions and then the version contract. No filler or redundant restatement of the tool name.

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 destructive single-field mutation with full schema coverage and an output schema, the description covers the action, the clearing behavior, the blockers, and the version handoff. An agent has everything needed to call it correctly and to chain the next edit.

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%, so baseline is 3. The description still adds meaning the schema lacks: it constrains lang to a language already configured on the survey and to non-English only when auto-translate is off, and it frames version as a chained token from survey_get rather than a static number.

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 opens with a specific verb+resource: "Set, or clear with null, a survey's description in one of its languages." That is precise enough to separate it from survey_update_title, survey_update_welcome_screen and survey_update_thank_screen without opening their schemas, though no sibling is named explicitly.

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?

Gives concrete preconditions rather than vague guidance: lang must already exist on the survey, auto-translate must be off for non-English languages, and version must come from survey_get or the previous edit's result. It stops short of explicitly stating when to prefer this over a sibling update tool, but the conditions an agent must satisfy before calling are clear.

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