QuantConnect

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

Annotations declare readOnlyHint=true, indicating a safe read operation. The description adds value by specifying it reads 'insights' (not raw data or charts), which provides behavioral context beyond the annotations. However, it doesn't detail aspects like pagination (implied by start/end parameters) or rate limits, leaving some gaps.

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 a single, clear sentence with zero wasted words. It's front-loaded with the core action ('Read out'), making it easy to parse quickly. No unnecessary details or redundancy are present, achieving optimal conciseness.

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 tool has annotations (readOnlyHint) and an output schema (implied by 'Has output schema: true'), the description doesn't need to cover safety or return values. However, it lacks context on usage versus siblings and parameter meaning, making it incomplete for guiding the agent fully in a complex environment with many similar tools.

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?

Schema description coverage is 0%, meaning parameter descriptions are absent in the schema. The tool description doesn't mention any parameters, failing to compensate for this gap. However, the parameter count is effectively 1 (a nested object with 4 fields), so the baseline is 4, but the description adds no semantic value, lowering the score to 3.

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 'Read out the insights of a backtest' clearly states the verb ('read out') and resource ('insights of a backtest'), making the basic purpose understandable. However, it doesn't differentiate from sibling tools like 'read_backtest' or 'read_live_insights', which would require more specificity about what insights contain or their format.

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 no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a valid backtest ID), compare to similar tools like 'read_backtest' or 'read_live_insights', or specify use cases (e.g., for analysis after a backtest completes). This leaves the agent with insufficient context for selection.

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