Skip to main content
Glama

Browse built-in examples

list_examples
Read-onlyIdempotent

List the example packages LivePage ships with and say which one to copy. Call this BEFORE writing anything you intend to publish: weekly reports, client proposals, stage decks, sign-up / poll collection, trips to send to family, and read-write mini apps each have a real, publishable package to adapt, and writing one from scratch usually misses the platform features (passcode access, in-page forms that land in the feedback thread, reader write-back to data tables, deck speaker notes on a phone). No arguments returns the catalogue: purpose, when to pick it, which features it uses, page structure. With key it returns that package’s manifest, README (which feature it shows / what to change / how to publish it) and entry source. Add file for one specific file inside the package. Read-only: creates nothing, uploads nothing, and is independent of the current workspace. Every customer name, figure, case study and price in an example is fictional: copy the structure, replace the content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNoWhich example to read (its key from the catalogue). Omit it to get the whole catalogue.
fileNoWhich file in the package to read (relative path). Use together with key; omitted means the entry file.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Adds real context beyond the annotations: workspace independence ('independent of the current workspace'), the exact return shape per mode (catalogue fields, manifest + README + entry source), and a fictional-content warning that prevents an agent from copying names, figures or prices. The read-only reaffirmation ('creates nothing, uploads nothing') largely restates readOnlyHint/destructiveHint, 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.

Conciseness4/5

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

Front-loaded with the core purpose and the BEFORE instruction, then layered by mode. The long middle sentence enumerating use cases and platform features is dense but earns its place as scope-setting; a slightly tighter list would improve it.

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?

No output schema exists, so the description carries the return-value burden and does so fully — it names the catalogue fields, what the key-mode manifest/README/entry source contain, and what the README covers. Combined with the fictional-data caveat, an agent has everything needed to call it correctly and interpret results.

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 description coverage is 100%, so baseline is 3; the description exceeds that by explaining the interaction between the two parameters and the mode transitions (omit everything = catalogue, add key = package detail, add file = one file, omitted file = entry file) and what each mode returns. Some of this duplicates the schema's own descriptions, so not a 5.

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?

Opens with a specific verb and resource ('List the example packages LivePage ships with and say which one to copy') and states the intended outcome, not just the read. No sibling in the list overlaps this resource, and the three usage modes (no args / key / key+file) are each spelled out, so an agent can distinguish it immediately.

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?

Explicit when-to-use: 'Call this BEFORE writing anything you intend to publish', followed by an enumeration of the concrete artifact types it applies to. It also supplies the when-not / why-bother rationale ('writing one from scratch usually misses the platform features') and names the specific features at risk.

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