Skip to main content
Glama

Rewardful MCP by usefulapi

List referrals

rewardful_list_referrals
Read-only

List referrals — visitors who arrived via an affiliate link — newest first, with their conversion state (visitor, lead, conversion), customer and link. Filter by affiliate, state, email, Stripe customer or an updated-at window. Rewardful: GET /v1/referrals.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, from 1. See pagination.next_page.
emailNoOnly referrals with this customer email.
limitNoResults per page, 1-100 (default 25).
expandNoInclude the full affiliate object for each referral.
affiliate_idNoOnly this affiliate's referrals.
updated_sinceNoISO 8601 timestamp: only referrals updated after it.
updated_untilNoISO 8601 timestamp: only referrals updated before it.
conversion_stateNoOnly referrals currently in these conversion states.
stripe_customer_idNoOnly referrals with this Stripe customer (cus_...).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true, but the description adds genuine behavioral context beyond that: default ordering ('newest first'), the conversion-state lifecycle, and the fields returned per referral. It does not mention pagination behavior or rate limits, but with annotations covering safety this is solid.

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?

One front-loaded sentence stating resource, scope, ordering, return fields, and filters, followed by the underlying endpoint. Every clause carries information; nothing is padded.

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 names the returned fields (conversion state, customer, link), and pagination parameters are documented in the schema. It is nearly complete for a 9-parameter read tool, though it omits pagination/ordering caveats.

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; baseline is 3. The description restates the filter categories and adds minor meaning (e.g., conversion states), but adds little beyond what the schema already provides.

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 ('List referrals') and immediately defines the resource as 'visitors who arrived via an affiliate link', which distinguishes it from siblings like list_affiliates or list_commissions. The tool's scope and identity are unambiguous.

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

Usage Guidelines3/5

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

It enumerates available filters (affiliate, state, email, Stripe customer, updated-at window), which implies when to use it for scoped queries, but gives no explicit when-to-use/when-not guidance or naming of alternatives among the many sibling list/get tools.

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.