read

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

No annotations are provided, so the description must carry the behavioral burden. It implies a read operation and mentions immutable revisions, but gives no information about permissions, errors, pagination, return shape, or what “all artifacts and head” actually means operationally.

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 a single front-loaded sentence with no obvious waste. Its brevity is appropriate, though “all artifacts and head” is slightly compressed and ambiguous.

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 annotations, no output schema, and zero schema descriptions, the definition is not complete enough for reliable invocation. It leaves key parameter semantics, return behavior, and usage boundaries unexplained.

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%, so the description needs to explain all parameters. It gives some meaning for branch ancestry and revision immutability, but does not explain the required project parameter or clarify that revision defaults to null to read head.

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: reading artifacts and head, or an immutable revision in the branch ancestry. It is clearer than the bare tool name, but it does not distinguish this operation from siblings such as history or compare.

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 does not explain when to use this tool instead of history, compare, branch, or write. The only usage signal is the optional revision wording, which is indirect and insufficient for tool selection.

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