getAffiliateUserInfo

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

With no annotations, the description fully bears the burden of behavioral disclosure. It reveals that wallet balance returns a range value (mapping provided), deposit amounts update every 5 minutes, trading volume covers three business lines, and commission data is for reference only. These disclosures provide important behavioral context, though it does not explicitly state the tool is read-only (implied by 'Query').

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 well-structured with a primary sentence followed by bullet-point notes. It front-loads the main action and then details important caveats. While slightly verbose, each note adds value without redundancy, making it efficient for an agent to parse.

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 single-parameter tool with no output schema or annotations, the description covers essential aspects: what data is returned, permission requirements, update frequency, and interpretation of range values. It lacks explicit return format details, but the described data points give sufficient context for an agent to understand the output scope.

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 input schema has only one parameter (uid) with no description, giving 0% schema coverage. The description compensates by explaining that 'uid' is the Master UID of the direct client to query, adding necessary semantic meaning beyond the schema definition.

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's purpose: 'Query detailed information for a specified direct client user under the affiliate account', listing specific data fields (VIP level, KYC level, wallet balance range, etc.). It distinguishes itself from sibling tools like getAffiliateUserList by focusing on a single user's details rather than a list.

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 provides explicit usage context: it requires an API Key with 'affiliate' permission bound to a Master UID, and explains that 'uid' refers to the Master UID of the client. While it does not explicitly mention when not to use it or provide direct alternatives, the notes clarify prerequisites and data refresh behavior, giving clear guidance for correct use.

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