Skip to main content
Glama

Get Preview URL

get_preview_url
Read-only

Show the user a live preview card and return the preview link. On an EXISTING project this is typically called EARLY, before the first change, so the user watches edits live from the start; the result is informational and a working session normally continues past it. It is not needed right after create_project, whose result already includes the same card. The preview URL carries an access token in its query string and only works shared EXACTLY as returned (no Floot login, view-only — which is also what lets it open on a phone); it live-updates as you edit, so it also suits an in-app browser tab if your client has one. The result additionally includes the sandbox API base for your own headless /_api/* testing — the frontend does not render there and it is not a user-facing URL; the preview link is the one meant for the user. Floot hosts the app: publish_app publishes it to production. To send the user straight to one view (a page, a component's examples, a page's staged screens, a design canvas or one of its frames, a page's link preview card), pass targetType with path or name, as navigate_preview takes them: the link then opens on that view, with or without a Floot window open.

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": {
      "projectId": "<projectId>"
    },
    "name": "get_preview_url"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoThe other targetTypes: the item name as list_files shows it, with "#<screen>" for page examples or "#<section, frame or bookmark id>" for a design ("CheckoutExplorations#payment").
pathNotargetType "page" or "link-preview": a path from "/", query and hash allowed.
projectIdYes
targetTypeNoOptional: the view the link opens on, as navigate_preview's targetType. Omit for the plain preview.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "The other targetTypes: the item name as list_files shows it, with \"#<screen>\" for page examples or \"#<section, frame or bookmark id>\" for a design (\"CheckoutExplorations#payment\").",
      +  "type": "string"
      +}
    • addedInput schema / properties / path
      Added value: +{
      +  "description": "targetType \"page\" or \"link-preview\": a path from \"/\", query and hash allowed.",
      +  "type": "string"
      +}
    • addedInput schema / properties / targetType
      Added value: +{
      +  "description": "Optional: the view the link opens on, as navigate_preview's targetType. Omit for the plain preview.",
      +  "enum": [
      +    "page",
      +    "component",
      +    "page-examples",
      +    "design",
      +    "link-preview"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the read-only, non-destructive, non-open-world profile, yet the description adds substantial context: the URL embeds an access token and only works shared exactly as returned, it is view-only without Floot login and opens on a phone, and it live-updates as edits are made. It also discloses a secondary return value — the sandbox API base for headless /_api/* testing — and warns that it is not user-facing.

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 action and its return, and nearly every clause carries distinct behavioral information rather than repetition. It is, however, a single dense paragraph with heavy parenthetical nesting, which slows scanning; a light structural break would improve readability.

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?

There is no output schema, so the description carries the return-value burden and does so: the card, the link, and the sandbox API base with its intended audience. Combined with the token/sharing caveats and the targetType routing detail, nothing an agent needs to call this correctly is missing.

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?

With 75% schema coverage the baseline is a 3, and the description earns above that by explaining that targetType selects the opening view and by enumerating the concrete view kinds (page, component examples, staged screens, design canvas or frame, link preview card) plus the path/name pairing. projectId itself is left unexplained, which is a minor gap for a required parameter.

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 concrete verb and resource: 'Show the user a live preview card and return the preview link.' It distinguishes itself from create_project (whose result already contains the card) and from publish_app (production), so an agent can identify it without opening the 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?

Gives explicit timing ('typically called EARLY, before the first change'), an explicit when-not ('It is not needed right after create_project'), and names the production alternative (publish_app). It also tells the agent that a session normally continues past the call, so the result is not terminal.

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