Skip to main content
Glama

Get a Studio paywall's document

get_paywall_doc
Read-only

The JSON document a Studio (visual editor) paywall is made of, with its status and version, plus the reference to the document model. Read this before save_paywall_doc, and edit the document you got rather than writing one from scratch — keep node ids, change only what was asked. Prices are never typed: use {{ products..price }} and the other product variables.

Input Schema

NameRequiredDescriptionDefault
idYesThe paywall id, from list_surfaces

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description adds value by disclosing the returned package (document body + status + version + model reference) and an important content rule about price variables. It does not state whether the returned document is a snapshot or live-editable reference, which is the one behavioral question left open.

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 sentences, front-loaded with the return payload before the workflow advice and the price-variable caveat. The pricing note is slightly tangential for a pure read tool but directly supports the intended read-then-edit loop, so it earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 must characterize the return value, and it does so by naming the document, its status/version, and the model reference. Combined with the strong annotations and full schema coverage, an agent has enough to call and interpret it, though the exact response envelope shape remains implicit.

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 coverage is 100% and the single id parameter is already documented with its provenance ('from list_surfaces'), so the baseline of 3 applies. The description adds no further detail on the identifier or its format.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names the specific resource (the JSON document of a Studio paywall) and enumerates what it carries: status, version, and a reference to the document model. It does not explicitly contrast with near siblings like read_doc, editor_get_doc, or get_surface, so an agent must infer which of several doc/surface readers returns the editable paywall document.

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 a concrete workflow rule: read this before save_paywall_doc and edit the retrieved document rather than authoring one from scratch. It also gives an in-place editing constraint (keep node ids, change only what was asked). What it lacks is disambiguation from read_doc/editor_get_doc, which likely return similar shapes.

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