Skip to main content
Glama

Referral summary

my_referrals
Read-onlyIdempotent

Show your referral summary as a GYOTAK referrer: your referral URL, number of referred orders (paid / unpaid), this month's estimated commission, unpaid balance, payout destination status, and the last 5 paid referred orders (order number, date, subtotal, commission — no buyer details). Only works for the customer of this connection; if you are connected through a personal token URL, omit customerKey.

Input Schema

NameRequiredDescriptionDefault
customerKeyNoYour customerKey (gyotak_cus_...). Omit when connected through a personal token URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds genuinely new behavioral context: the result is scoped to this connection's customer, contains no buyer details (a privacy constraint), and caps order history at the last 5 paid orders.

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 action and the identity scope, and every listed return field earns its place since there is no output schema. The single long sentence is dense and slightly run-on, but no sentence is wasted.

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 correctly compensates by enumerating the return payload, and it covers the one optional parameter's conditional use. It stops short of saying what happens when the customer is not a referrer or has no payout destination configured, which an agent would need before calling.

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 coverage is 100% and the customerKey property already documents 'Omit when connected through a personal token URL,' so the description is largely restating the schema. It adds no format examples or error behavior for a wrong/missing key beyond the omit condition.

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?

States a specific verb+resource ('Show your referral summary as a GYOTAK referrer') and then enumerates exactly what the summary contains: referral URL, paid/unpaid order counts, estimated commission, unpaid balance, payout destination status, and last 5 paid orders. This clearly separates it from siblings like apply_referrer, report_share, get_share_kit, and register_payout.

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?

It gives a useful scoping rule ('only works for the customer of this connection') and a concrete connection-mode condition for omitting customerKey. However, it never names an alternative tool or states what to do if the caller is not yet a referrer (apply_referrer) or needs payout setup (register_payout), so routing is left implicit.

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