Skip to main content
Glama
Sign In

uNotes

by net.unotes
OverviewDiscussionsAdmin

Get referral summary

get_referral_summary
Read-onlyIdempotent

Show the user's Refer & Earn state: their personal invite link, clicks, signups, sales and earnings (pending, cleared, paid), plus their invite points. includeReferrals=true also lists the people they referred.

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_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
includeReferralsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish that this is a read-only, idempotent, non-destructive operation. The description adds useful context by listing the returned referral metrics and clarifying that includeReferrals=true controls whether referred people are listed, though it does not mention authentication or privacy considerations for the personal invite link and earnings data.

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 two compact sentences, front-loads the tool's purpose, and uses the remaining space to enumerate outputs and parameter behavior. Every phrase carries information relevant to selecting or invoking the tool.

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?

For a simple read-only getter with one optional boolean and no output schema, the description is complete enough: it identifies the resource, lists the returned fields, and explains the only parameter's effect. No further structured output documentation is available, and the description sufficiently covers what an agent needs to call it correctly.

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 description coverage is 0% for the single parameter, so the description must compensate. It does so by explaining that includeReferrals=true also lists referred people, which clarifies the parameter's effect; only the default value for includeReferrals is left unstated.

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?

The description gives a clear verb+resource (show the user's Refer & Earn state) and enumerates exactly what is returned: invite link, clicks, signups, sales, earnings, invite points. It does not explicitly differentiate from any sibling, but no sibling appears to overlap with referral summary functionality.

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 by the phrase 'Show the user's Refer & Earn state', and the effect of includeReferrals=true is described. However, there is no explicit guidance on when to use this versus other account/profile tools, nor any stated prerequisites or exclusions.

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

All uNotes toolsInspect
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