Skip to main content
Glama

list_referrals

Read-onlyIdempotent

List referral records (who referred whom, reward coupon code, pending/rewarded status) with what the referred buyer paid, newest first. Use for working out creator commission: a one_time referredPaymentType means referredAmountPaidCents is the whole sale; for a recurring row it is the LATEST payment, not lifetime, so do not commission on it. Optionally scope by app_id and/or status.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_referrals"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
app_idNo
statusNo
include_samplesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the description wisely spends its budget on data semantics instead: default ordering (newest first) and the critical warning that referredAmountPaidCents is lifetime-equivalent only for one_time rows and is just the latest payment for recurring rows. It omits pagination/truncation behavior around the limit, which is the main remaining behavioral gap.

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 core capability and ordering are front-loaded in the first sentence, with the commission caveat following as the highest-value detail. The second sentence is long and dense but every clause carries operational meaning; nothing is filler.

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 a read-only list tool with no output schema, the description adequately conveys what rows contain, their order, and how to interpret the tricky monetary field. The gap is control-parameter coverage (limit and include_samples), which matters for an agent that may need to page or request samples.

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 0%, so the description must carry parameter meaning, and it only partially does: app_id and status are framed as optional scoping filters and the enum values pending/rewarded are echoed. The limit (default 25) and include_samples parameters get no explanation at all, leaving an agent to guess their effect.

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 description gives a specific verb and resource ("List referral records") plus the exact fields returned (referrer/referee, reward coupon code, pending/rewarded status, amount paid) and the sort order (newest first). This clearly separates it from the payment- and cancellation-oriented siblings like list_recent_payments and list_recent_cancellations 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?

It states the intended job explicitly ("Use for working out creator commission") and gives a concrete exclusion: do not commission on referredAmountPaidCents for recurring rows because it is the latest payment, not lifetime. It does not name an alternative sibling to use instead (e.g., list_recent_payments for raw payment data), so it stops short of full when/when-not routing.

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