Skip to main content
Glama

Set Paywall

set_paywall

Turn a short link into a gated link or update its paywall so consumers pay to unlock the destination and optionally receive an access code.

Instructions

Turn a link into a Gated link (or update its paywall): consumers pay to get the destination and, optionally, an access code. Replaces the paywall's settings, so pass every field you want kept. For one code per order use codeMode 'unique' and fill the pool with add_pool_items.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYesThe link's short code (the part after the domain).
priceYesPrice in USDT/USDC as a decimal string, e.g. "5" or "4.99".
titleYesWhat the consumer sees as the title.
codeModeNo'same': one code for every consumer. 'unique': each order takes one item from the pool.
coverUrlNoA third-party https image URL for the cover. Xbitto stores only the address.
blurCoverNoBlur the cover on the landing page.
codeLabelNoWhat the consumer page calls the code, e.g. "License Key".
accessCodeNoThe code every consumer gets, in 'same' mode. Left out: none.
descriptionNoShown before payment. Supports **bold**, _italic_ and lists with '- ' or '1. '. Links show as plain text.
verifyPayerNoScreen the consumer's wallet before showing the payment address (each real check costs credits).
payoutWalletIdsNoWallet ids from list_wallets, at most one per network. Left out: the first usable wallet on each network.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does disclose the critical destructive trait: it replaces the paywall's settings, so omitted fields are lost. It also notes the credit cost of real payer verification, but says nothing about permissions, reversibility, or what is returned.

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?

Three sentences, front-loaded with the purpose, then the destructive replacement warning, then the mode-specific instruction. No filler or restatement of the name.

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?

For an 11-parameter mutation tool with no annotations and no output schema, the description covers the highest-risk facts (full replacement, pool workflow, credit cost). It omits error/permission behavior and the shape of the result, which an agent would otherwise have to discover.

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 coverage is 100%, so the baseline is 3, and the description goes beyond it by tying codeMode 'unique' to the pool workflow and clarifying that 'same' mode pairs with accessCode semantics. It adds cross-tool meaning rather than repeating field text.

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+resource pair — converting a link into a Gated link or updating its paywall — and immediately explains the consumer-facing outcome (pay to get the destination plus optional access code). This separates it from create_link and other link tools without needing the 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?

Gives a concrete condition for the 'unique' codeMode and routes the agent to add_pool_items to fill the pool, which is real when-to-use guidance for the trickiest branch. It does not state when *not* to use it, nor prerequisites, so it stops short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.