Skip to main content
Glama

Set render options

set_render_options
Idempotent

Configure how a site is delivered, without touching its sandbox. spa_fallback (free on every plan) serves the entry page for unknown in-app routes so client-side navigation and shared deep links resolve, but real missing files (scripts, images, styles) still 404. document_kind and printable say what the site is as a document (see publish_site). auto_refresh (free on every plan) makes a viewer that is open when a new version is published reload on its own, instead of offering a Refresh prompt; off by default, since a reload mid-read loses a reader their place. external_origins extends the site's content-security policy to allow specific https origins it calls at runtime (fonts, images, APIs, embeds); this is a paid capability (Pro) and each entry must be a bare https://host[:port] with no path. Pass an empty array to clear the list, or use add_external_origins to add origins without replacing the list. include_original false stops a Word, PowerPoint or Excel site offering its file for download, by rendering the page again from the file it holds as a new version; true is refused, since a withheld file was never kept: update_site with the file and include_original true instead. Omit a field to leave it unchanged. Needs edit access to the site (its creator or an editor grant, in a role that can edit); rejected requests (forbidden, plan_limit, validation_failed) leave the stored options unchanged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
site_idYesThe id of the site to configure
printableNoThe page is built to print (a PDF that keeps the look): the design check asks for print styles, and a plain page gets the viewer's Print action (a report or a deck carries its own Download PDF button instead). Kept on later updates unless given again.
auto_refreshNoReload open viewers on their own when a new version is published, instead of offering a Refresh prompt
spa_fallbackNoServe the entry page for unknown in-app routes (deep-link routing)
workspace_idNoOptional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for).
document_kindNoWhat the site is: a report, a presentation, a dashboard, or a plain page (the default). A publish or content update of such a site runs the design check (`design_warnings`); a presentation may go full screen. Kept on later updates unless given again.
external_originsNoFull set of https origins to allow in the site CSP; replaces the existing list
include_originalNofalse: stop offering the Office file this site renders for download (a new version, rendered from the file already held). true is refused; upload the file again with update_site and `include_original` true.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / printable / description
      Previous value: -"The page is built to print (a PDF that keeps the look): the viewer then offers Print, and the design check asks for print styles. Kept on later updates unless given again."New value: +"The page is built to print (a PDF that keeps the look): the design check asks for print styles, and a plain page gets the viewer's Print action (a report or a deck carries its own Download PDF button instead). Kept on later updates unless given again."
  2. Changed2 schema fields changed
    • addedInput schema / properties / document_kind
      Added value: +{
      +  "description": "What the site is: a report, a presentation, a dashboard, or a plain page (the default). A publish or content update of such a site runs the design check (`design_warnings`); a presentation may go full screen. Kept on later updates unless given again.",
      +  "enum": [
      +    "page",
      +    "report",
      +    "presentation",
      +    "dashboard"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / printable
      Added value: +{
      +  "description": "The page is built to print (a PDF that keeps the look): the viewer then offers Print, and the design check asks for print styles. Kept on later updates unless given again.",
      +  "type": "boolean"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / auto_refresh
      Added value: +{
      +  "description": "Reload open viewers on their own when a new version is published, instead of offering a Refresh prompt",
      +  "type": "boolean"
      +}
  4. Changed1 schema field changed
    • addedInput schema / properties / include_original
      Added value: +{
      +  "description": "false: stop offering the Office file this site renders for download (a new version, rendered from the file already held). true is refused; upload the file again with update_site and `include_original` true.",
      +  "type": "boolean"
      +}
  5. Changed1 schema field changed
    • changedInput schema / properties / workspace_id / description
      Previous value: -"Optional: the workspace (the personal space or a Pro workspace) to act in, from list_workspaces. Omit to act in the token owner's own account."New value: +"Optional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for)."
  6. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover safety (idempotent, non-destructive), but the description adds substantive behavior beyond them: which options are free vs paid (external_origins is Pro), that rejected requests (forbidden/plan_limit/validation_failed) leave stored options unchanged, that omitting a field leaves it unchanged, and that include_original=true is refused.

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 core purpose before per-field detail, and nearly every sentence carries operational information. It is a dense single block, though, with some overlap against the equally detailed schema descriptions, so it is information-rich but not maximally lean.

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 an 8-parameter mutation tool with no output schema, the description covers defaults, paid-vs-free gating, access requirements, the omit-to-leave-unchanged contract, and named error codes. An agent has everything needed to invoke it correctly.

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 genuinely adds meaning: external_origins entries must be 'bare https://host[:port] with no path', an empty array clears the list, auto_refresh defaults off, and include_original=false re-renders rather than withholding. It exceeds the schema but partly restates existing field docs.

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+resource (configure how a site is delivered) and scopes it with the qualifier 'without touching its sandbox', which cleanly separates it from content/mutation siblings like update_site and publish_site. Per-field clauses make the tool's remit concrete enough to distinguish from any sibling.

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?

Names alternatives with the condition that selects them: 'use add_external_origins to add origins without replacing the list' and 'update_site with the file and include_original true instead'. Also states prerequisite access ('Needs edit access... its creator or an editor grant').

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.