read_source_file

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

Annotations already declare readOnlyHint=true, and the description is consistent with that. It adds real behavioral context beyond the annotation: only 'allowed' files can be read (implying an access whitelist and possible failure for disallowed paths), UTF-8 encoding constraint, and the return of a SHA256 hash for conflict checking.

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?

A single front-loaded sentence with zero filler; the SHA256 clause earns its place by explaining why the hash is returned. Nothing could be removed without losing information.

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 one-parameter read tool with no output schema and minimal annotations, the description covers the gist but leaves the path semantics and the failure mode for disallowed files unspecified. Adequate but with clear gaps an agent would hit in practice.

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% and the single 'path' parameter is undocumented in the schema, so the description carries the burden. It only hints that the path must point to an 'allowed' file; it does not say whether the path is relative or absolute, what the allowed roots are, or how invalid paths behave.

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 (Read) and resource (one allowed UTF-8 source file), which an agent can distinguish from the sibling list_source_files (plural) and edit_source_file (write). It does not explicitly name those siblings, but the singular/read framing makes the distinction inferable.

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?

There is no explicit when-to-use or when-not statement, but 'including its SHA256 for conflict checking' implicitly signals the read-before-edit/commit workflow involving edit_source_file and commit_candidate. Usage is implied rather than spelled out.

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