Skip to main content
Glama

Get one paywall or onboarding flow's config

get_surface
Read-only

The configuration of one paywall or onboarding flow, plus its version history (version, note, date). A served design's compiled html is left out (html_bytes gives its size) and a Studio doc shows as doc: true; read the design with get_paywall_doc or get_onboarding_doc. Note that configs never contain price strings — prices resolve at render time from the PurchasesAdapter's packages, so never copy a price literal out of (or into) a config.

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": {
      "kind": "<kind>",
      "id": "<id>"
    },
    "name": "get_surface"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe surface id, from list_surfaces
kindYesWhich kind of surface

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?

Annotations only declare a safe read, and the description adds substantive behavior beyond that: version history is returned with version/note/date, compiled HTML is deliberately omitted with html_bytes as a size proxy, and Studio docs are flagged as doc: true. The price-resolution warning explains a non-obvious data invariant (prices come from the PurchasesAdapter's packages at render time) that an agent could otherwise get wrong.

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?

The definition is front-loaded with what is returned, then the omission and the alternative, then the price invariant. Every sentence carries information, though the price-warning sentence is long and slightly dense relative to the rest.

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 takes on the return-shape burden and meets it: it lists the version-history fields, explains how to detect an omitted HTML payload, and describes the Studio-doc case. For a two-parameter read tool, nothing essential is left unspecified.

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 both parameters are documented, including the enum for kind and the pointer to list_surfaces for the id. The description reinforces that the tool addresses exactly one surface of one kind but adds no format or constraint detail beyond the schema, so the baseline of 3 applies.

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 first clause names the exact resource — the configuration of a single paywall or onboarding flow — and adds that version history is included. It also distinguishes itself from get_paywall_doc and get_onboarding_doc, so an agent can separate config retrieval from design retrieval without opening a 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?

The description explicitly routes the agent: if you need the served design's compiled HTML or a Studio doc, use get_paywall_doc or get_onboarding_doc instead. It also gives a strong usage constraint (never copy a price literal out of or into a config). It does not spell out when to prefer this over list_surfaces or the draft-creation tools, but the alternative it does name is the one that matters.

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