affiliate_tapfiliate_get_earnings_summary

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

With no annotations, the description carries the burden. It discloses the return type (EarningsSummary with oldestUnpaidAgeDays) and implies a read-only summarization behavior. However, it does not explicitly state side-effect safety, pagination behavior, or rate limits, leaving some gaps.

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?

Two sentences, no redundancy, and includes a concrete example and a pairing hint. Every part earns its place.

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?

The tool has 9 parameters, no output schema, and no annotations. While the purpose and usage are clear, the description lacks parameter details, required fields, date format expectations, and pagination info, making it insufficient for correct invocation without additional research.

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 must compensate. It vaguely references date window (from/to), programme breakdown (programmeId), and status breakdown (status), but leaves brand, limit, cursor, maxAgeDays, and minAgeDays unexplained. Many parameters remain opaque.

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 summarizes earnings on Tapfiliate across a date window with breakdowns by programme and status. It distinguishes itself from list_transactions by emphasizing a single-figure answer and provides a concrete example query.

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?

Explicitly notes when to use the tool: 'when the user wants a single-figure answer plus context.' It also suggests pairing with list_transactions to drill into underlying records, providing clear contextual alternatives.

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