Read a project file

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

Annotations already mark the operation as readOnly and idempotent. The description adds meaningful behavioral context beyond these hints: it reveals that unsaved edits are included and that binary or oversized documents require outputPath. No contradiction with annotations is present.

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 two sentences with no filler. The core purpose is front-loaded, and the important edge-case behavior about outputPath is placed right after, making it easy for an agent to parse quickly.

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 simple read operation, the description covers the main behavioral nuances: unsaved edits, binary files, and size caps. There is no output schema, so the description could have elaborated on return format or error conditions, but the current guidance is sufficient for an agent to invoke the tool correctly in most cases.

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 0%, so the description carries the burden of explaining parameters. It does explain the special role of outputPath ('Binary files and documents over the size cap require outputPath'), and projectId/path are fairly self-explanatory from their names. However, it does not fully define outputPath semantics, such as whether it is a local destination or how the path should be formatted.

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 states a specific verb ('Read') and resource ('a text document from an Overleaf project'), which clearly distinguishes it from sibling tools like write_file, list_files, or upload_file. It also adds a specific behavioral qualifier ('including collaborators' unsaved edits') that sharpens the purpose.

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 clearly establishes when the tool is appropriate: reading text documents from a project, with the notable inclusion of unsaved edits. It does not explicitly name alternatives or conditions to avoid using it, but the context is clear enough for an agent to select it for read operations versus write or export operations.

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