queryReferralCode

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

With no annotations provided, the description carries the behavioral disclosure burden. It discloses the active-code filter, sub-account behavior, link generation based on user preferences, and the authentication requirement via API Key (HMAC/RSA), which goes beyond a minimal description.

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 compact, well-structured with bullets, and every sentence adds meaningful behavioral or usage information. The authentication tip is clearly separated and not redundant.

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 parameterless query tool with no output schema, the description covers the main points: scope, filtering, sub-account behavior, and authentication. It does not describe the exact return structure, but that is not critical for a simple parameterless call.

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?

The tool has zero parameters and the schema already covers this fully, so the baseline is 4. The description adds no parameter-specific details, but none are needed here.

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 clearly states the tool queries referral codes owned by the current user and their corresponding referral registration links. It identifies the specific resource and action, but it does not explicitly differentiate itself from the similarly named sibling tool 'queryReferrals'.

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?

The description gives useful context: it is for the current user's referral codes, sub-accounts get the parent account's codes, and only active codes are returned. However, it does not explicitly say when to prefer this tool over alternatives such as queryReferrals, nor does it list exclusions.

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