Skip to main content
Glama

get_referrals

Retrieve all users referred by a specific affiliate code, providing a clear view of affiliate-driven signups to manage referral programs effectively.

Instructions

Get all users referred by an affiliate code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYesAffiliate code
Behavior3/5

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

With no annotations, the description carries the burden of behavioral disclosure. The verb 'Get' implies a read-only operation, but it does not mention any additional behavior like error handling, empty results, or authentication requirements. It provides minimal but not misleading transparency.

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?

The description is a single concise sentence that immediately conveys the tool's function. No superfluous words or redundant 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?

For a simple get operation with one parameter and no output schema, the description adequately covers the return value (all referred users) and the required input. It does not address error cases or edge cases, but the simplicity of the tool does not demand more.

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?

The schema description covers the sole parameter 'code' as 'Affiliate code', and the description does not add further semantic detail. Since schema coverage is 100%, a baseline score of 3 is appropriate.

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 clearly states the verb 'Get' with a specific resource ('all users referred by an affiliate code'), making its purpose unambiguous. It distinguishes itself from related tools like get_my_affiliates by explicitly referencing a code parameter rather than user context.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives such as check_affiliate_code or get_my_affiliates. The description simply states what it does without any contextual or exclusionary information.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bolivian-peru/baozi-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server