Skip to main content
Glama

get_preview_url

Read-onlyIdempotent

Returns a preview URL for a form draft so you can view its current layout and details before publishing.

Instructions

Get the preview URL for a form draft to see how it looks before publishing.

Use this to:

  • View a form you just created

  • Check the current state of a draft

  • Get form details (field count, steps, status)

The preview URL shows exactly how the form will appear to users once published.

Input Schema

NameRequiredDescriptionDefault
form_idYesThe form UUID or public id.

Output Schema

NameRequiredDescriptionDefault
nameYes
formIdYes
statusYes
publicIdYes
stepCountYes
fieldCountYes
previewUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is fully covered. The description adds that the URL reflects the published appearance and that form details like field count, steps, and status are included, but says nothing about URL expiry or auth requirements for the preview link.

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?

Purpose is front-loaded in the first sentence and the scenario list is scannable. The closing sentence partially restates the opening ('shows exactly how the form will appear to users once published'), which is mild redundancy but not harmful.

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?

With rich annotations, an output schema, and a single well-documented parameter, the description covers enough for correct invocation. The one remaining gap is sibling differentiation against get_form, which would prevent selection errors.

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?

There is a single parameter with 100% schema description coverage ('The form UUID or public id'), so the schema already does the work. The description adds no meaning about the identifier format or whether public ids are accepted differently, so baseline 3 applies.

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+resource: retrieving a preview URL for a form draft. It is clear what the tool returns and its pre-publish framing. However, it doesn't differentiate from the sibling get_form, which an agent could reasonably confuse with this one.

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?

The 'Use this to' list gives three concrete scenarios (view a new form, check draft state, get form details), which is clear usage context. There are no exclusions or explicit alternatives, so the agent must infer that get_form is the non-preview path.

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