queryBrokerEarning

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

With no annotations, the description carries the full burden. It discloses rate limit, data freshness (up to 1 month, T-1), default behavior, and account requirement. However, it omits whether the operation is idempotent or read-only, and does not describe error handling or response structure.

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 extremely concise, using bullet points and clear sections. Every sentence adds value, and there is no redundancy. The most important information (purpose, rate limit, rules) is front-loaded.

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?

Given 6 parameters, no output schema, and no annotations, the description fails to cover essential aspects like parameter usage for bizType, uid, limit, and cursor. It also does not describe the response format. The tool's complexity demands more complete documentation.

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 description provides meaningful guidance only for 'begin' and 'end' parameters (pairing and default). The other four parameters (bizType, uid, limit, cursor) are left unexplained despite 0% schema coverage. This leaves significant ambiguity for the agent.

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 it queries 'earnings and rebate information' using 'exchange broker master account', providing a specific verb and resource. It effectively distinguishes from sibling tools like queryBrokerAccountInfo or queryBrokerCap, which serve different purposes.

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 explains when to use the tool (for earnings/rebates), the required account type, rate limit, date range limitations, and parameter pairing rules. It does not explicitly call out when not to use or name alternatives, but the context is clear enough.

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