QuestionPunk

Survey Update Welcome Screen

survey_update_welcome_screen

Destructive

Set, or clear with null, the welcome screen shown before the first question, in one of the survey's languages. Send title, description and buttonLabel together. Needs version = versions.current from survey_get; the result returns the next surveyVersion.

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>",
      "version": "<version>"
    },
    "name": "survey_update_welcome_screen"
  }
}

Input Schema

Name	Required	Description
`lang`	Yes	Language code
`version`	Yes	Current 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.
`surveyId`	Yes	Survey ID (from survey_list)
`welcome_screen_text`	No	Welcome screen content (null to clear)

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 7, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=false and openWorldHint=true. The description adds the important behavioral details the annotations cannot: passing null clears the screen, all three nested fields must be sent together, and the version chain is enforced (a stale version is rejected) with the next surveyVersion returned for the follow-up call.

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 short sentences, each carrying a distinct fact: what is changed, how to send the payload, and the versioning precondition. Front-loaded with the operation and no filler.

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?

For a mutating, version-guarded tool with an output schema present, the description covers the operation, clearing semantics, the required version source and the returned version. It does not mention what happens to any pre-existing welcome screen content beyond the implied overwrite, but nothing essential for a correct call 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 description coverage is 100%, so the schema already documents lang, version, surveyId and the welcome_screen_text object including null-to-clear. The description adds only the instruction to send title, description and buttonLabel together, which the schema's required list already implies, so it does not meaningfully exceed the schema baseline.

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 ('Set, or clear with null, the welcome screen shown before the first question') and scopes it to one language. This clearly separates it from sibling tools such as survey_update_title and survey_update_thank_screen, which target different survey surfaces.

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 clear preconditions: the survey must be selected by lang, and version must come from versions.current via survey_get or the previous edit's surveyVersion. It does not explicitly name an alternative tool or state when not to use it, but for a single-purpose updater the context is sufficient.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All QuestionPunk tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?