get_earnings

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

Annotations already set readOnlyHint, openWorldHint, idempotentHint, and destructiveHint false. The description adds valuable context: the tool returns earnings data in sats, includes recent paid days and top-earning endpoints, and is read-only. No contradictions with annotations.

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 concise sentences that front-load the purpose, scope, and constraints. Every sentence carries essential information without 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?

Despite lacking an output schema, the description clearly enumerates the return data (earnings, paid days, top endpoints). For a read-only reporting tool with good annotations, this is sufficiently complete for an agent to understand behavior and usage.

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 coverage is 100% with detailed parameter descriptions. The description adds the note 'All-time totals are always included', which clarifies behavior beyond the schema. However, this adds minimal value over the already comprehensive schema descriptions.

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's a revenue report for a bolthub workspace, specifying exact data (all-time and windowed earnings in sats, recent paid days, top-earning endpoints). This distinguishes it from sibling tools like 'usage_summary' or 'get_api_details'.

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 'Read-only' and 'Requires BOLTHUB_ACCOUNT_TOKEN', providing clear usage conditions. It also mentions default and max for the 'days' parameter and how to handle 'tenant_id'. However, it does not explicitly state when not to use this tool or suggest alternatives.

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