Skip to main content
Glama

List Referrals

list_referrals
Read-onlyIdempotent

List referrals for the current account, newest first, with each affiliate's name. Optional local-date bounds filter created_at; totals and pagination use the same window.

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
idNoFilter by exact record ID.
pageNo
limitNo
stateNoFilter by conversion state.
end_dateNoInclusive local date upper bound for created_at.
timezoneNoIANA time zone used to interpret the date bounds; defaults to UTC because accounts do not store a reporting time zone.
start_dateNoInclusive local date lower bound for created_at. Omit both dates for lifetime results.
affiliate_idNo

Output Schema

NameRequiredDescriptionDefault
okYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / end_date
      Added value: +{
      +  "description": "Inclusive local date upper bound for created_at.",
      +  "format": "date",
      +  "type": "string"
      +}
    • addedInput schema / properties / start_date
      Added value: +{
      +  "description": "Inclusive local date lower bound for created_at. Omit both dates for lifetime results.",
      +  "format": "date",
      +  "type": "string"
      +}
    • addedInput schema / properties / timezone
      Added value: +{
      +  "description": "IANA time zone used to interpret the date bounds; defaults to UTC because accounts do not store a reporting time zone.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, closed-world and non-destructive, so the safety profile is free. The description earns credit by disclosing behavior annotations cannot: default sort order, the affiliate-name join, that date bounds apply to created_at, and — most valuable — that totals and pagination are computed over the same filtered window rather than the whole dataset.

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?

Two sentences, no filler. The scope/ordering/join information leads, and the filtering and window caveat follows — front-loaded and every clause carries distinct information.

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?

An output schema exists, so return values need not be described. Combined with annotations, the description covers scope, ordering, filter field, and the pagination/totals window rule; only affiliate_id's meaning and the default page size are left to inference. Solid for an 8-parameter read tool.

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 63%, leaving page, limit and affiliate_id undocumented in structured fields. The description closes the most consequential gap by stating that pagination and totals respect the date window, which is exactly the non-obvious semantics an agent needs; affiliate_id and default page/limit sizes remain unexplained.

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

Purpose4/5

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

Names a specific verb and resource (list referrals) scoped to the current account, and adds output-relevant detail ('newest first, with each affiliate's name'). It stops short of distinguishing itself from siblings like list_commissions or list_affiliates, so an agent must infer the boundary from the resource noun alone.

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?

Usage is implied rather than stated: 'Optional local-date bounds filter created_at; totals and pagination use the same window' explains how the arguments behave but never says when to prefer this tool over list_commissions or get_dashboard_summary, nor any prerequisite. Adequate for a straightforward list tool, but no explicit routing 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.

Resources