Skip to main content
Glama

Referral programme

referrals_overview
Read-only

The workspace's referral and affiliate standing: the referral code and the link to share, how many people have opened it, how many signed up, how many went on to pay, the commission rate and what the next rate needs, and the earnings split into money still on hold, money available to withdraw, money already paid out and account credit. Also lists the recent sign-ups with the date and the plan they took, and no personal details, because the route sends none. Use it for 'what is my referral link', 'how many people have joined through me', 'how much have I earned' or 'when can I withdraw'. Amounts are in ordinary units of the currency shown, not paise or cents. It covers the whole workspace, so it takes no account id.

Input Schema

NameRequiredDescriptionDefault
limitNoHow many recent sign-ups to return, newest first. Defaults to 20; 50 is the most this tool will ever return.

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 readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds real context beyond that: no personal details are returned because the route sends none, amounts are in ordinary currency units not paise/cents, and it is workspace-scoped with no account id. Return-shape disclosure is a useful addition.

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?

Front-loads the purpose and the enumerated contents, then moves to usage triggers and caveats. The first sentence is a dense run-on list, but every clause carries distinct information about what is returned, so little is wasted.

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

Completeness5/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 compensates by spelling out the returned fields (code, link, counts, commission rate, earnings buckets, recent sign-ups with date and plan) plus the currency-unit and privacy caveats. An agent has everything needed to call and interpret it.

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?

Only one parameter and schema coverage is 100%, so the schema already documents limit fully (default 20, max 50, newest first). The description adds nothing about the limit parameter, so the 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?

Names a specific resource (the workspace's referral and affiliate standing) and enumerates exactly what it exposes: referral code/link, open and signup counts, conversions, commission rate, earnings breakdown. This is unmistakably distinct from siblings like account_usage or stats_overview.

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 concrete trigger phrases ('what is my referral link', 'how many people have joined through me', 'how much have I earned', 'when can I withdraw'), which is strong positive guidance. It does not name an alternative tool or an exclusion, though no close sibling exists to disambiguate against.

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