repository_read_file

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

With no annotations, the description carries the full burden. It does add useful safety context ('No code is executed') and hints at a size bound ('bounded'), but never states that bound, whether private repositories require credentials, or how large files are handled.

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 sentences, front-loaded with the operation and followed by the safety qualifier. Nothing is redundant, and no sentence could be removed without losing meaning.

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 three-parameter tool with zero annotation coverage, no output schema, and 0% schema description coverage, the definition is too thin. It omits parameter formats, return shape, encoding/truncation behavior, and authentication expectations, all of which the agent needs to invoke 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 description coverage is 0% for three parameters, so the description must compensate and does not. It never explains that 'repository' is likely an owner/name slug, that 'path' is relative to the repository root, or that 'ref' accepts a branch, tag, or commit SHA.

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?

States a specific verb and resource: read a single text file from a GitHub repository, with the scope qualifier 'one bounded text file'. An agent can distinguish it from the listing-oriented siblings repository_tree and repository_inspect, though the description never names them explicitly.

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?

No when-to-use or when-not-to-use guidance is given, and no alternative is named despite repository_tree and repository_inspect being close siblings. The agent must infer that this fetches file contents rather than listing or metadata.

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