get_stock_timeline

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

No annotations exist, and the description does not disclose behavioral traits such as data freshness, pagination, rate limits, or error handling. While it is a read operation, the description fails to add context beyond listing event categories.

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 extremely concise: a one-line purpose statement, a one-line usage hint, and a two-line Args section. No redundant or extraneous words, earning its place efficiently.

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?

An output schema exists, so missing return value details are excusable. However, the description lacks specifics on event ordering, date range scope, or the precise type of events included beyond the listed categories. It is adequate but incomplete for a timeline tool.

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 description includes an explicit Args block explaining 'symbol: NSE symbol (e.g. RELIANCE, HDFCBANK, TCS)' and 'max_events: max timeline events to return', adding meaning beyond the schema's raw property names and types. The default for max_events is noted in the schema but clarified in context.

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 'Unified stock timeline: news, results, insider, bulk deals, sentiment, pledge, smart money' and identifies it as the 'what changed recently?' tool for a stock. This verb+resource combination distinguishes it from sibling tools.

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 recent changes but offers no explicit guidance on when to use this tool versus alternatives like nse_quarterly_results or nse_insider_trading. No direct exclusion criteria or when-not-to-use are provided.

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