nse_circuit_breakers

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

No annotations are provided, so the description carries the full burden. It reveals the scope (Nifty 500) and the circuit_type parameter, but lacks details on data freshness (live vs. historical), read-only nature, or any rate limits. Basic behavioral context is given, but gaps remain.

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 well-structured with a docstring format including Args and Examples. It is concise but includes essential information; a bit more trimming could be done, but overall effective.

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, the description does not need to detail return values. It covers the core functionality, scope, and parameter. Minor missing details like data source or refresh cadence, but adequate for a simple scanning 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 schema description coverage is 0%, but the description fully explains the single parameter circuit_type with its allowed values ('upper', 'lower', 'both') and provides concrete examples. This adds significant meaning beyond the schema.

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 it scans NSE stocks hitting upper or lower circuit limits, specifying the scope as Nifty 500. It distinguishes from siblings like nse_52week_scanner and predict_circuit by focusing specifically on circuit breakers, and includes parameter details.

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 when to use the tool (to get stocks at circuit limits) and provides examples for each circuit_type. However, it does not explicitly state when not to use it or mention alternative tools like predict_circuit.

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