Skip to main content
Glama

Get form share info

get_form_share_info
Read-only

Everything needed to put a form of the current team in front of an audience: the public answer link (also per language version), the team's custom domain and whether it is actually serving, ready-to-paste embed snippets in three modes (inline / popup / iframe), and the current delivery settings so you can tell whether the form will even accept responses. Pass utmSource to get every link and snippet tagged for one channel. Use this to answer "give me the link / the embed code" and to sanity-check a launch; change the switches with update_form_settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formIdYesThe form UUID
utmSourceNoOptional channel tag applied to the links and snippets (letters, digits, _ and - only, max 64). Omitted or invalid = no tag, in which case the embed script forwards whatever utm_* the host page already has.
iframeHeightNoOptional pixel height for the iframe snippet, default 600
popupButtonTextNoOptional label for the popup-mode button; empty uses the built-in default

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoCustom path under the custom domain; only shapes shareUrl while that domain is serving
embedNoCopy-paste embed snippets { inline, popup, iframe }; null when the form has no public token
titleNoForm title
formIdNoThe form
deliveryNoDelivery state: { isActive, submissionAccess, reportGateRequireCode, timeLimit, sharing, answerSheet, crowdCompare, booking, feedback, allowPdfDownload, gaTrackingId, sharedWithAll, searchIndexable }; get_form_share_info adds the team-level examineeSignupDisabled (respondent self-signup off = a login-gated quiz turns away anyone not on the roster)
shareUrlNoThe link to hand out (custom domain when one is serving)
publicTokenNoToken behind the public answer link
customDomainNoCustom-domain state { domain, status, serving, plan }
languageUrlsNoOne link per language version
defaultShareUrlNoThe same quiz on the default domain — always works

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / delivery / description
      Previous value: -"Delivery state: { isActive, submissionAccess, reportGateRequireCode, timeLimit, sharing, answerSheet, booking, gaTrackingId, sharedWithAll }; get_form_share_info adds the team-level examineeSignupDisabled (respondent self-signup off = a login-gated quiz turns away anyone not on the roster)"New value: +"Delivery state: { isActive, submissionAccess, reportGateRequireCode, timeLimit, sharing, answerSheet, crowdCompare, booking, feedback, allowPdfDownload, gaTrackingId, sharedWithAll, searchIndexable }; get_form_share_info adds the team-level examineeSignupDisabled (respondent self-signup off = a login-gated quiz turns away anyone not on the roster)"
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so safety is covered. The description adds real behavioral context beyond that: the domain serving check answers whether the form is live, the delivery settings reveal whether the form will accept responses, and utmSource tagging propagates across every link and snippet. It does not mention auth requirements or rate limits, so it stops short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the returned artifacts, then the utmSource behavior, then the routing to update_form_settings. Dense but every clause carries information; the only mild cost is a long first sentence enumerating outputs.

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 read-only 4-parameter tool with an output schema, the description supplies exactly the missing context: what the payload is for, how a parameter changes the payload, and which sibling performs the write. Nothing an agent needs before calling is absent.

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, but the description adds cross-parameter meaning: passing utmSource tags 'every link and snippet' for one channel, which goes beyond the per-parameter schema text. The iframe and popup parameters are left to the schema, which documents them well.

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 (get) and resource (form share info) and enumerates exactly what comes back: public answer link per language, custom domain and serving status, embed snippets in three modes, and current delivery settings. An agent can distinguish this from get_form (definition) or get_form_stats without inspecting any schema.

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

Usage Guidelines5/5

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

Explicitly names the use cases ('give me the link / the embed code', sanity-check a launch) and routes the mutation case to the sibling: 'change the switches with update_form_settings.' Both when-to-use and when-to-use-something-else are covered.

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