Read a project file

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

Annotations only cover the safety profile (readOnlyHint, openWorldHint); the description adds substantial behavioral context beyond them — the pre-read commit pull, the 60,000-character plain-text cutoff, truncation-without-revision in revision modes, and the exact failure conditions (missing/binary file, out-of-project path, mode+line-range conflict, startLine after endLine).

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?

It is a dense single block, but front-loaded with the core action and ordered sensibly (modes, then edit workflow, then truncation, then failures). The delta-application recipe is arguably reference material rather than selection guidance, which slightly dilutes 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?

With no output schema and a complex multi-mode tool, the description carries the full burden and does so: return format (plain text vs revision JSON), revision/hash semantics, truncation behavior, and all documented failure paths. An agent has everything needed to call it 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?

Schema coverage is 100%, so the baseline is 3, but the description adds real semantics the schema omits: startLine alone reads to the end, endLine is clamped, and it documents the exact delta-application algorithm (split on newline, replace deleteLineCount lines at 1-based startLine, join). It stops short of documenting every parameter (e.g. project resolution), so not a full 5.

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 gives a precise verb+resource ("Read one text file from the project") and adds the distinguishing behavior that it pulls the latest Overleaf commits first. It is clear what the tool does, but it never explicitly contrasts itself with the closely related sibling read_section, so the agent must infer the boundary from the resource wording.

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?

It states explicit selection rules for each mode: "Use a line range to sample a large file, mode=full before an edit that passes expectedRevision, and mode=smart to re-read a file already read." Each variant is tied to a concrete situation, leaving nothing to inference.

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