get_broker_earning_record

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

No annotations are provided, so the description must disclose behavior. It only states 'get' and deprecation, failing to describe side effects, permissions, data freshness, or what happens when called. Transparency is minimal.

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—two lines—with the deprecation notice front-loaded. Every sentence adds value with no redundancy.

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 deprecated tool, the description sufficiently communicates to avoid use and provides basic parameter details. Lack of output schema or further behavioral info is acceptable given the deprecation, but it could still mention return format.

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 briefly explains parameters (biz_type as 'Business type filter', limit as 'Number of records with default 50'), adding meaning beyond the schema which only provides titles and types. Though minimal, it compensates for the 0% schema coverage.

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 retrieves a broker earning record and explicitly marks it as deprecated, directing the agent to use get_broker_earnings_info instead. This distinguishes it from sibling tools by discouraging its use.

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 explicitly says 'deprecated, use get_broker_earnings_info', providing a clear directive to avoid this tool and use the alternative. This offers strong usage guidance.

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