get_max_pain

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

No annotations are provided, so the description bears full responsibility. It describes the tool as a calculation (read-only) but does not disclose potential behaviors like rate limits, data freshness, or required permissions. The description is adequate for a simple query tool but lacks depth.

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 very concise, consisting of two sentences and an example. It front-loads the purpose immediately ('Calculate max pain strike price for an index option') and avoids unnecessary text. Every sentence adds value.

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 that there is no output schema and no annotations, the description should explain what the tool returns (e.g., a strike price number, a table with details). It does not describe the output format or any additional context like data sources or limitations. This omission significantly reduces completeness for a simple 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 input schema defines a single required parameter 'symbol' with no description (0% coverage). The description's example implies symbol is an index ticker (e.g., 'NIFTY'), but does not explicitly explain that the symbol must be an index option or specify valid symbols. This adds some meaning but not full clarity.

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 the tool calculates 'max pain strike price for an index option', using a specific verb ('calculate') and resource. It distinguishes itself from sibling tools like get_option_chain or get_pcr by focusing on the max pain calculation, which is a unique metric.

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 provides an explicit example ('get_max_pain("NIFTY")') and explains the concept of max pain. However, it does not explicitly state when not to use this tool or mention alternative tools for related analysis, such as get_option_chain for full option data.

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