get_upcoming_dividends

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

With no annotations provided, the description carries the full burden. It transparently discloses that the tool returns a list of payouts, including specific fields (book closure, AGM date, payout amount/type, buy deadline) and the optional filtering behavior. No hidden side effects or destructive actions are indicated, and the description appears accurate.

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 concise sentences plus a bullet-like list of result fields. Every sentence adds value without repetition, and the structure is clear and front-loaded with the main purpose.

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 description covers the essential behavior (listing upcoming dividends, filtering by symbol) and enumerates the key return fields. With an output schema present (per context signals), avoiding detailed return format is acceptable. It could explicitly note that only future payouts are returned, but 'upcoming' implies this.

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 schema has 0% description coverage, so the description must compensate. It explains the 'symbol' parameter succinctly: 'Optional PSX ticker to filter. If omitted, returns all upcoming payouts in the table.' This provides clear meaning beyond the raw schema definition.

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 'List upcoming dividend payouts on PSX,' specifying a concrete verb, resource, and market. The additional detail about results including book closure dates, AGM date, payout amount/type, and buy deadline further clarifies the tool's purpose and distinguishes it from siblings like get_dividend_history (past payouts) and get_buy_deadline (computing a single deadline).

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 explains the optional symbol filter and its effect ('If omitted, returns all upcoming payouts'), but does not explicitly state when to use this tool versus alternatives like get_quote or screen_dividend_stocks. Usage context is implied but lacks explicit when-to-use/when-not-to-use guidance.

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