Skip to main content
Glama

Preview the draft

preview_site
Read-only

Show the current draft so the user can look at changes (phone and desktop) before publishing. In apps that support it, a preview panel opens right in the chat with a Publish button; otherwise give the user the preview_url. The live site is not affected. Form entries made in the preview are saved as tests (no emails or alerts; query_records leaves them out unless tests: "include"). Payments and Komers checkout are off in previews.

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": {
      "site": "<site>"
    },
    "name": "preview_site"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoPage to open, e.g. "/" or "/services"/
siteYesSite slug (e.g. "kopitiam-muar") or id
hoursNoHow long the link works

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the readOnlyHint/destructiveHint annotations: the live site is unaffected, preview form entries are stored as tests with no emails or alerts, payments and Komers checkout are disabled, and query_records hides those test records unless tests:"include". These are exactly the side-effect details an agent needs before calling a preview tool.

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?

Information is front-loaded: what it does, then how the result surfaces, then side effects. It is dense but almost every clause carries a distinct fact; the test-record/query_records sentence is slightly long-winded relative to its importance.

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?

With no output schema, the description still explains what the agent gets back (an in-chat panel with a Publish button, or a preview_url) and what happens to data created during the preview. For a three-parameter, read-only tool this covers everything an agent needs to call it correctly.

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?

Schema description coverage is 100% and all three parameters (path, site, hours) are documented in the schema itself, so the baseline is 3. The description adds no syntax or format detail for them beyond the incidental mention of phone/desktop viewing modes.

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 and resource ("Show the current draft") plus its scope (phone and desktop, before publishing), which cleanly separates it from publish_site and check_site in the sibling list. An agent can identify this as the non-destructive preview step 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 Guidelines4/5

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

Gives clear situational context ("before publishing") and a fallback rule for environments that can't open a panel (return preview_url instead). It does not explicitly name publish_site as the follow-up action or state exclusions, so it stops short of full when/when-not routing.

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