Read repository file

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behaviour, so the safety profile is covered. The description adds real context beyond that: the 64 KiB truncation threshold and the fact that binary or oversized files return size only, which an agent cannot learn from annotations. Return format for partial reads is still unstated.

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?

Two compact sentences, front-loaded with the core action and the ref default, followed by the size/binary caveat and a docs pointer. Nothing is redundant, though the trailing API/docs sentence is low value for an agent already in the tool.

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 3-parameter read tool with full annotation coverage and no output schema, the essentials are present: default ref behaviour, size ceiling, and binary handling. Missing guidance on which sibling to use and on 'path' formatting keeps it short of complete.

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 only 33% – just 'repo' is documented (owner/name with a reference to repo_list). The description partially compensates by explaining that 'ref' defaults to the default branch when omitted, but 'path' semantics (leading slash, directory rejection, encoding) are undocumented in both places.

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 and resource ('Read a text file from a Lizard Git repository at a ref') and pins the scope with the 64 KiB cap and binary fallback. It implicitly distinguishes itself from the listing sibling (repo_files) by emphasizing single-file content retrieval, but never names that alternative outright.

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?

Usage is only implied: an agent can infer this is the way to fetch file contents rather than list them. There is no explicit 'use this when…' or routing to repo_files / repo_commits / sandbox_read_file, so the choice among near-neighbours is left to inference.

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