Skip to main content
Glama

List affiliates

rewardful_list_affiliates
Read-only

List affiliates, newest first, with visitors/leads/conversions. Filter by campaign, or look one up by email or Stripe customer id (returns zero or one). Expand campaign, links or commission_stats for more detail. Rewardful: GET /v1/affiliates.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, from 1. See pagination.next_page.
emailNoOnly the affiliate with this email.
limitNoResults per page, 1-100 (default 25).
expandNoNested objects to include for each affiliate.
campaign_idNoOnly affiliates in this campaign.
stripe_customer_idNoOnly the customer-referrer affiliate tied to this Stripe customer (cus_...).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly hint, so the bar is lower; the description nevertheless adds ordering (newest first), the returned metrics, the zero-or-one semantics of the lookup filters, and that campaign/links/commission_stats can be expanded for depth.

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 tight clauses front-loaded with what/ordering, then filter modes, then expansion, closing with the underlying endpoint. No sentence is wasted.

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 usefully describes the returned fields and the zero-or-one case. It leaves pagination behavior and the default page size to the schema, which is acceptable but not fully complete for an agent unfamiliar with the endpoint.

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%, so every parameter is already documented in the schema; the description only echoes campaign, email, stripe customer id, and expand without adding format or default detail beyond what the schema provides. Baseline 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?

States a specific verb and resource (list affiliates) plus what each row carries (visitors/leads/conversions) and the ordering (newest first). This differentiates it from the singular rewardful_get_affiliate and from the other list_* siblings by naming its own filter modes.

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 clear selection context: filter by campaign for a set, or use email/stripe_customer_id to resolve a single affiliate (returns zero or one). It never names get_affiliate as the alternative for a known id, so it stops short of explicit when-not guidance.

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.