Skip to main content
Glama
Sign In

SurveyNinja

by io.surveyninja
OverviewDiscussionsAdmin

Create widget hidden option

create_widget_hidden_option

Creates a hidden service option for a quiz widget. widget_uuid must be one of the UUIDs from quiz://{id}/structure (the ids field); do not invent ids — take them from the structure.

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": {
      "quiz_id": "<quiz_id>",
      "widget_uuid": "<widget_uuid>",
      "name": "<name>",
      "value": "<value>"
    },
    "name": "create_widget_hidden_option"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesHidden option key for the widget.
valueYesOption value.
quiz_idYesQuiz ID.
widget_uuidYesWidget UUID (format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). Must be taken from quiz://{id}/structure, field ids; do not generate your own.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare this is a non-read-only, non-destructive, non-idempotent, closed-world write. The description adds the sourcing constraint on widget_uuid, which is real context. It stays silent, however, on non-idempotency (what happens if the same option is created twice) and on whether the call succeeds or errors, which is the main behavioral risk here.

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?

Two sentences, front-loaded with the purpose, and the warning about inventing ids follows immediately. Nothing is wasted.

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 simple four-parameter create tool with full schema coverage, annotations and no output schema, the description covers purpose and the one real prerequisite. The only gap is duplicate-handling, which matters because the tool is explicitly non-idempotent.

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%, so the schema already documents all four parameters, including the same widget_uuid sourcing rule almost verbatim. The description's only added value is pointing at the quiz://{id}/structure resource, which the schema's widget_uuid description also mentions.

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?

States a specific verb and resource: creates a hidden service option scoped to a quiz widget. That is enough to separate it from create_hidden_option and update_widget_hidden_option, though the description never names those siblings, so the distinction has to be inferred from the name.

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?

The description implies a read-before-write workflow by requiring widget_uuid to come from quiz://{id}/structure, which is useful prerequisite context. But it gives no explicit when-to-use vs create_hidden_option/update_widget_hidden_option guidance and no exclusions.

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

All SurveyNinja toolsInspect
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