Read referral status
referral_statusRead or issue this agent's referral code and return activations, credit balance, and fee-share accruals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_key | Yes | ||
| issue_code | No |
referral_statusRead or issue this agent's referral code and return activations, credit balance, and fee-share accruals.
| Name | Required | Description | Default |
|---|---|---|---|
| agent_key | Yes | ||
| issue_code | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full behavioral burden. It does not disclose what happens when issue_code is set, whether issuing a code is idempotent, what permissions are required, or the side effects of creating a referral code.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no wasted words. It efficiently states the tool's action and return content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no annotations, no output schema, and 0% parameter description coverage, the description is too sparse. It names return fields but omits parameter semantics and the behavioral implications of triggering a referral-code issuance.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description should explain both parameters. It mentions issuing a code, which hints at issue_code, but never defines agent_key or the exact meaning/default/behavior of issue_code.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (read or issue) and resource (this agent's referral code) and lists the returned data. It does not differentiate from siblings like agent_earnings_get or balance_get, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use guidance or mention of alternatives. The description implies the tool is for referral status/code operations, but does not say when to prefer it over related tools such as agent_earnings_get or balance_get.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.