Skip to main content
Glama

Preview a page

soclo_page_preview
Read-onlyIdempotent

Return the rendered preview HTML of the home page, or of the page named by page_id, plus its preview address. The saved design is what it shows, and on a live site the saved design is already what customers see. Free; changes nothing.

Input Schema

NameRequiredDescriptionDefault
page_idNoWhich page of the site, from soclo_page_pages (or soclo_page_design_get). Omit for the home page — changing a child page without this changes the home page instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so 'changes nothing' is redundant — but 'Free' discloses a cost trait the annotations do not cover, and the note that the preview reflects the saved design and matches what live customers see is genuine behavioral context. It stops short of describing the preview address's lifetime or the HTML size.

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?

Three short sentences, front-loaded with what is returned, then the state caveat, then cost and side effects. Minimal waste; 'changes nothing' slightly repeats the readOnly/destructive annotations but is defensible as a summary clause.

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 carries the return-value burden and does so: rendered preview HTML plus a preview address. The single optional parameter and its default are covered, and the live-site caveat closes the main interpretive gap.

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?

With 100% schema description coverage the schema already documents page_id, its source (soclo_page_pages / soclo_page_design_get) and the omit-for-home-page rule. The description only restates the home-page default, adding no format or syntax detail beyond the schema.

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 artifact: 'Return the rendered preview HTML of the home page, or of the page named by page_id, plus its preview address.' This clearly separates it from data-returning siblings like soclo_page_get or soclo_page_design_get by naming the output as rendered HTML plus a preview address.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The line about the saved design ('on a live site the saved design is already what customers see') implies this is a preview of persisted state, not unsaved edits, which guides usage indirectly. However, no sibling is named as an alternative (soclo_page_get, soclo_page_design_get, soclo_page_publish, soclo_page_preflight all sit nearby) and there is no explicit 'use this when' statement.

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