Skip to main content
Glama

Paywall Affiliates List

list_paywall_affiliates
Read-onlyIdempotent

Retrieve paywall affiliates with filters for code, status, campaign, or name/email. Supports pagination and bounded page reads; each request uses API quota.

Instructions

Paywall Affiliates List. Reads community data. Supports bounded all_pages; every page counts against the API quota.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number
accountNoNamed private Circle account; selects credentials, not a remote community ID.
filtersNoFilters
per_pageNoRecords per page (max 100)
all_pagesNoRead bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup.
max_itemsNoMaximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false. The description adds the quota-consumption trait ("every page counts against the API quota") and the bounded all_pages behavior, which is genuinely useful operational context. However, it largely echoes the all_pages schema description rather than disclosing anything new about cost, pagination limits, or continuation behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

Two short sentences, and the second (quota/all_pages) is front-loaded usefully. But the first sentence is pure tautology against the title and consumes space without earning it.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a 6-parameter nested schema, strong annotations, and no output schema, the structured fields do most of the work. The description is adequate but leaves gaps: it never clarifies what the returned affiliate records contain or how the tool relates to the payout/affiliate siblings.

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%, including the nested filters object and the max_items continuity note, so the schema carries the parameter semantics. The description reinforces only the quota aspect of all_pages and adds no field-level meaning beyond it, which matches the baseline-3 case for fully documented schemas.

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

Purpose2/5

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

The description effectively restates the title and name: "Paywall Affiliates List. Reads community data." It never explains what a paywall affiliate is or what this list contains, and it does nothing to differentiate the tool from the many other list_* siblings. This is close to tautology rather than a specific verb+resource statement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use, when-not-to-use, or alternative-tool guidance. Given siblings like export_paywall_affiliate_payouts and list_members, the agent is left to infer the boundary entirely on its own.

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

Deploy Server

Other Tools