Skip to main content
Glama

Preview a catalog

preview_catalog
Read-only

The catalog as a whole: returns the page list and livePreviewUrl, a read-only page that shows the catalog exactly as it renders and reloads by itself whenever the catalog changes, keeping the page the viewer is on. For "show me", "what does it look like", or following edits as they land. Nothing opens beside the chat; preview_page shows ONE page, or a few, as pictures beside the chat. Reads the catalog and changes nothing.

Input Schema

NameRequiredDescriptionDefault
catalogIdYesCatalog id, as returned by list_catalogs

Output Schema

NameRequiredDescriptionDefault
pagesYes
titleYes
totalYesPages in the catalog
catalogIdYes
editorUrlYes
viewerUrlNo
livePreviewUrlYesA read-only page that reloads itself whenever the catalog changes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond annotations, it explains that `livePreviewUrl` is a read-only page showing the catalog exactly as it renders, reloading automatically when the catalog changes while keeping the viewer on the same page. It also clarifies that nothing opens beside the chat and that the tool reads the catalog without changing anything.

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?

The description is front-loaded with the core result and the `livePreviewUrl` return value, then adds usage cues and sibling differentiation. Despite being information-dense, every clause contributes to selecting or understanding the tool.

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?

The tool has an output schema and rich annotations, and the description still adds the important live-reload behavior and in-chat presentation boundary. An agent has enough information to choose this tool and understand what it returns.

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 the single `catalogId` parameter is already documented as coming from `list_catalogs`. The description does not add further parameter meaning beyond what the schema provides.

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 states a specific resource and output: the catalog as a whole, returning the page list and `livePreviewUrl`. It also clearly differentiates itself from `preview_page`, which shows one page or a few as pictures beside the chat.

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?

It gives explicit use cases: "show me", "what does it look like", or following edits as they land. It also gives a clear exclusion by directing single-page image previews to `preview_page` instead.

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