jade.read_range

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

The description adds behavioral details beyond the readOnlyHint annotation: the budget parameter cuts reads at whole lines and provides a continue handle, error handling for multi-range calls is described, and dependency reads are marked read-only, aligning with the annotation.

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 slightly long but well-structured, front-loading the core purpose and then layering usage details. Every sentence carries information; the example is compact and illustrative.

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?

For a read tool with no output schema, the description covers key behaviors: how to address ranges, how to batch reads, how to handle dependency paths, and how pagination works via continue. It lacks an explicit description of the return format, but that is inherent to a file-read operation. Overall, it is complete for an agent to invoke correctly.

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 already documents all parameters with descriptions, so baseline is 3. The description adds value by explaining the semantics of the 'lines' format, the 'ranges' structure with a concrete example, and the budget/continue flow, which clarifies usage 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 the tool reads file contents verbatim, whole or by line range, and positions it as the replacement for cat and sed -n. It distinguishes from sibling tools like find and grep by focusing on direct file content retrieval, and mentions dependency path syntax.

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?

Explicit guidance on when to omit line numbers to read whole files (e.g., go.mod, config files), how line ranges behave (end past EOF reads to end), and how to read dependency sources read-only. It also shows how to batch multiple reads in one call with an example, making usage unambiguous.

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