API.SH

get_referral_link

Read-only

The user's referral link and how the program works (a share of what the people they refer use in their first year, paid out as credits after approval), with clicks, sign-ups, paying referrals and rewards earned, waiting for approval, available and redeemed. Redeeming is done in the dashboard (Billing → referrals).

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": "get_referral_link"
  }
}

Input Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 3, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description still adds real value beyond them: the payout model (share of first-year usage, credited after approval) and the crucial constraint that redemption is NOT possible here and must happen in the dashboard under Billing → referrals.

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-loaded with the resource, followed by the data fields and then the redemption caveat, with no filler sentences. The long parenthetical about payout mechanics packs several ideas into one clause and is slightly harder to parse than it needs to be.

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 carries the burden of describing returns, and it does enumerate the metric categories (clicks, sign-ups, paying referrals, waiting/available/redeemed rewards). It is sufficient for an agent to call the tool and interpret the payload, though exact field shapes remain unknown.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate — baseline 4 applies. No syntax or scoping caveats are needed.

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?

Clearly states the resource (the user's referral link) plus everything returned with it: clicks, sign-ups, paying referrals, reward states. No sibling tool in the list covers referrals, so it is separable in practice, but the description never explicitly contrasts itself with billing/balance tools it might be confused with.

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 only implied ('The user's referral link and how the program works') — an agent can infer this is the tool for referral questions. There is no explicit when-to-use condition, no exclusion, and no pointer to an alternative for referral-history or payout actions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All API.SH tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?