Indexer: Stargate VTHO claimed by period

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

Annotations already indicate readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds the behavioral constraint that only claimed rewards 'post hayabusa' are included, which is not in annotations. No contradictions.

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, front-loaded with the core purpose and periods. Every sentence adds value: the first defines the tool, the second clarifies scope (claimed subset, post-hayabusa). No unnecessary words.

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 the presence of an output schema (not shown but stated), the description does not need to explain return values. It covers the essential: what it returns (time-series), the periods, and a time constraint. With strong annotations, this is complete.

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 one parameter 'period'. The description adds value by explicitly listing the allowed values (DAY, WEEK, MONTH, YEAR, ALL) which are not formally declared as enums in the schema. This helps the agent understand valid inputs.

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 specifies the resource (VTHO claimed from Stargate rewards), the action (get time-series), and the aggregation periods (DAY, WEEK, MONTH, YEAR, ALL). It distinguishes itself from sibling tools like getStargateTotalVthoClaimed by focusing on time-series rather than total.

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 implies usage for time-series data but does not explicitly state when to use this tool versus alternatives (e.g., getStargateTotalVthoClaimedHistoric). No exclusions or when-not-to-use guidance is provided.

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