Skip to main content
Glama

query_partner_stats

Read-only

Monitor affiliate revenue and referral activity by querying real-time partner analytics, attributed referral counts, and commission payout status from the Aradia partner ledger.

Instructions

[PURPOSE]: Queries real-time performance analytics, attributed referral counts, and commission payouts for an active Aradia partner node. [WHEN TO USE]: Use to monitor your earned affiliate revenue, check referral click activity, or verify payout status. [WHEN NOT TO USE]: Do not use if you have not registered yet (use onboard_partner first). [SIDE EFFECTS & BEHAVIOR]: Pure read-only query against sovereign partner ledger. Non-destructive.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ref_codeYesYour unique 4-character partner referral code (e.g. '5FYVQ').

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYesAccount status: active or pending.
ref_codeYesPartner referral code.
earnings_usdNoTotal accrued commission earnings in USD.
partner_nameNoRegistered partner or agent handle.
referral_countNoTotal attributed client referrals.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • addedInput schema / properties / ref_code / description
      Added value: +"Your unique 4-character partner referral code (e.g. '5FYVQ')."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "earnings_usd": {
      +      "description": "Total accrued commission earnings in USD.",
      +      "type": "number"
      +    },
      +    "partner_name": {
      +      "description": "Registered partner or agent handle.",
      +      "type": "string"
      +    },
      +    "ref_code": {
      +      "description": "Partner referral code.",
      +      "type": "string"
      +    },
      +    "referral_count": {
      +      "description": "Total attributed client referrals.",
      +      "type": "integer"
      +    },
      +    "status": {
      +      "description": "Account status: active or pending.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ref_code",
      +    "status"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and destructiveHint=false, so the 'pure read-only, non-destructive' line is largely redundant. It earns partial credit for specifying the target ('sovereign partner ledger'), adding a bit of behavioral context beyond the annotations, but does not mention auth requirements or refresh/rate behavior.

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?

Bracketed sections front-load purpose, usage, and behavior in four tight lines with no filler. Nothing is redundant enough to cut.

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?

Single-param read tool with a 100%-covered schema, safety annotations, and an existing output schema. The description covers purpose, routing, and safety context; nothing material for correct invocation is missing.

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 coverage is 100% and the single param already carries a clear description (4-char code with example), so the baseline is 3. The description's framing of the tool as partner-scoped reinforces that ref_code is an identity selector rather than a filter, adding marginal meaning.

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 (queries) and three concrete resources (performance analytics, referral counts, commission payouts) scoped to an 'active Aradia partner node'. An agent immediately understands the domain and can distinguish it from procurement/ROI siblings.

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

Usage Guidelines5/5

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

Explicit WHEN TO USE (monitor revenue, check clicks, verify payout) and WHEN NOT TO USE with a named alternative (onboard_partner if unregistered). That is the full routing decision, not just implied context.

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