Skip to main content
Glama

Get a form

get_form
Read-only

One form's settings: fields (every item in order, with its settings, headings, text blocks and page breaks included, in the shape update_form takes back), allowed websites, success message or redirect, anti-spam check, owner alert, Google Sheet link, the form it changes rows of (targetFormId) if any, whether Record Fetch is on, and the revision update_form and set_form_status need. console_only lists what on this form the connector cannot edit (file upload questions, show-if and page-skip rules, uploaded page pictures, a blocked page), each with where in the Webtzm console to change it. share_url is the address of the form's public Webtzm page while that page is on, otherwise null. page is the page's settings: what is set, response_count and closed when a closing date or limit is set, inactive_pro_parts (stored Pro settings this plan ignores), pictures and whether Webtzm has blocked it. Read it before changing a page. A prefilled link is the share_url followed by ?= (repeat a key to tick several boxes); hidden, file upload, consent and grid questions and headings and text blocks are never prefilled, and nothing private belongs in a link.

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": {
      "form_id": "<form_id>"
    },
    "name": "get_form"
  }
}

Input Schema

NameRequiredDescriptionDefault
form_idYesThe form's id, as list_forms returns it.

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
pageNoThe form's public Webtzm page: what is set, what it costs to keep, and why it is closed if it is.
sheetYes
fieldsYesThe form's items in order, as create_form and update_form take them: questions with their settings, and headings, text blocks and page breaks between them.
outputYes
statusYes
revisionYes
operationNo
share_urlNoThe form's public page address, a short link that stays the same for good, while the page is on, otherwise null.
ownerAlertYes
recordLinksNo
allowedSitesYes
console_onlyNoWhat is on this form that this connection cannot edit, each with where in the Webtzm console to change it. Empty when there is none.
targetFormIdNo
retentionDaysNo
spamProtectionYes
successMessageYes
recordFetchEnabledNo
successRedirectUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / console_only
      Added value: +{
      +  "description": "What is on this form that this connection cannot edit, each with where in the Webtzm console to change it. Empty when there is none.",
      +  "items": {
      +    "properties": {
      +      "item": {
      +        "type": "string"
      +      },
      +      "where": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "item",
      +      "where"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / fields / description
      Added value: +"The form's items in order, as create_form and update_form take them: questions with their settings, and headings, text blocks and page breaks between them."
    • addedOutput schema / properties / fields / items
      Added value: +{
      +  "type": "object"
      +}
    • addedOutput schema / properties / page
      Added value: +{
      +  "description": "The form's public Webtzm page: what is set, what it costs to keep, and why it is closed if it is.",
      +  "properties": {
      +    "another_response": {
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "blocked": {
      +      "description": "true while Webtzm has blocked the page; the owner contacts support@webtzm.com.",
      +      "type": "boolean"
      +    },
      +    "button_label": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "closed": {
      +      "description": "null while the page takes responses; otherwise {reason: date, at} or {reason: limit}.",
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "closes_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "description": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "enabled": {
      +      "type": "boolean"
      +    },
      +    "footer_text": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "inactive_pro_parts": {
      +      "description": "Stored Pro settings the page ignores because this workspace is not on Pro. They return when it is.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "pictures": {
      +      "properties": {
      +        "background": {
      +          "type": "boolean"
      +        },
      +        "cover": {
      +          "type": "boolean"
      +        },
      +        "logo": {
      +          "type": "boolean"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "response_count": {
      +      "description": "Responses that came through the page since the limit was set; null without a limit.",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "response_limit": {
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "share_description": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "share_image": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "share_title": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "share_url": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "thanks_heading": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "theme": {
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "enabled",
      +    "share_url",
      +    "theme",
      +    "pictures",
      +    "blocked",
      +    "inactive_pro_parts"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedOutput schema / properties / share_url / description
      Previous value: -"The form's public page address while the page is on (the custom address when a Pro workspace has set one), otherwise null."New value: +"The form's public page address, a short link that stays the same for good, while the page is on, otherwise null."
  3. Changed1 schema field changed
    • addedOutput schema / properties / share_url
      Added value: +{
      +  "description": "The form's public page address while the page is on (the custom address when a Pro workspace has set one), otherwise null.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  4. Changed1 schema field changed
    • addedOutput schema / properties / recordLinks / properties / viaLinkedForms
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  5. Changed3 schema fields changed
    • addedOutput schema / properties / recordFetchEnabled
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / recordLinks
      Added value: +{
      +  "properties": {
      +    "enabled": {
      +      "type": "boolean"
      +    },
      +    "onlyAcceptChangesFromLinks": {
      +      "type": "boolean"
      +    },
      +    "showCurrentAnswers": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / targetFormId
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  6. First observed

TDQS

A3.9/5.0
Behavior5/5

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

Beyond the read-only annotations, the description discloses connector limitations via console_only, null conditions for share_url, page-level settings, revision data needed by mutation tools, and restrictions on prefilled links. This is substantial behavioral context that helps an agent interpret and use the result correctly.

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 description is front-loaded with the core purpose, but much of it is a single dense run-on sentence with nested parentheticals and abrupt field references. The prefilled-link guidance is useful, but the overall structure is difficult to scan.

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 the output schema and annotations, the description is more than complete enough to call the tool correctly. It covers the returned form settings, connector editing limitations, share_url behavior, page metadata, revision usage, and prefilled-link constraints.

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 single form_id parameter is already fully documented in the schema. The description adds no additional parameter semantics such as format examples or scoping behavior beyond the schema's reference to list_forms.

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 clearly states that it returns one form's settings and enumerates the major categories of data returned. It is distinguishable from list_forms by explicitly scoping to a single form, though it does not name sibling alternatives.

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?

It gives one explicit usage cue: 'Read it before changing a page.' It implies the tool is useful before update_form or set_form_status calls, but it does not provide broader when-to-use or when-not-to-use guidance against alternatives.

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