get_earnings

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

No annotations are provided. The description discloses the source documents and the metrics returned, which is transparent. It does not mention any destructive behavior (none expected) or limitations like rate limits, but for a read-only retrieval tool this is adequate.

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 two sentences long, front-loading the main purpose and listing key outputs. There is no extraneous information; every sentence 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?

Despite lacking an output schema, the description explains what metrics are returned and the unit (NZD thousands). It also mentions the source documents. For a tool with 4 parameters and no output schema, this provides sufficient context for an agent to understand what to expect.

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 input schema has 100% coverage and each parameter has a brief description. The tool description adds value by specifying that monetary values are in NZD thousands, which is not in the schema. This additional semantic information enhances parameter understanding.

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 explicitly states it gets structured earnings results for an NZX company, extracted from full-year and half-year announcement PDFs, and lists the specific metrics returned (revenue, net profit, etc.). This clearly distinguishes it from sibling tools like get_financials or get_dividends.

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 specifies that data is sourced from full-year and half-year announcement PDFs, implying when to use the tool (for NZX company earnings reports). However, it does not provide explicit guidance on when not to use it or mention alternative tools for similar data.

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