Skip to main content
Glama

Get embed code for a scene

get_embed_code
Read-only

Generate copy-paste embed code for a 3D scene in a web page, including iframe, viewer element, and URL; add a share token to embed private scenes.

Instructions

Get copy-paste code to embed a scene in a web page: an iframe (works anywhere), the <verse-viewer> element plus its script, and the plain url. For a private scene pass the share token from create_share_link as share_token.

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": {
      "scene": "<scene>"
    },
    "name": "get_embed_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
loadNo'lazy' (default) loads when scrolled into view, 'tap' only on tap, 'eager' immediately.
sceneYesScene id (e.g. palm-villa-0a1b2c3d4e5f), the job id returned by upload_scene, or a Verse share link.
titleNoAccessible title for the iframe.
aspectNoFrame shape. Default 16:9.
backgroundNo'rrggbb', 'transparent' or 'studio:warm'.
share_tokenNoShare token of a private scene.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is known. The description adds genuinely new behavioral context: the response is code snippets in three formats and private scenes require a share token obtained elsewhere. It does not cover token lifetime/revocation or whether the returned code expires, which keeps it from 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.

Conciseness5/5

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

Two sentences, both earning their place: the first front-loads the deliverable and its variants, the second handles the only conditional input. No restatement of the title, no filler.

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 no output schema, the description carries the burden of describing return values and does so by listing the three code forms. Minor omissions remain for a six-parameter tool: no note on whether iframe versus `<verse-viewer>` has compatibility trade-offs beyond 'works anywhere', and nothing on token expiry or revocation via the sibling revoke_share_link.

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 the baseline is 3 and the schema already documents load, aspect, background, and title. The description adds meaning beyond the schema for `share_token` by giving its provenance (create_share_link) and the privacy condition that triggers it, which the schema's one-line 'Share token of a private scene' does not.

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?

The description names a specific verb and resource ('Get copy-paste code to embed a scene') and then enumerates exactly what is returned: an `iframe`, the `<verse-viewer>` element plus its `script`, and the plain `url`. That enumeration distinguishes it from every sibling, none of which produce embed markup.

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?

It gives a concrete conditional rule: pass the share token from create_share_link as `share_token` for a private scene, which also names the sibling that produces that input. It stops short of saying when to prefer this tool over create_share_link or which of the three embed forms to choose, so there is a gap but the main branching condition is covered.

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