list_snapshot_files

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

With no annotations, the description carries the full behavioral burden. It discloses important traits such as immutable snapshots, relative-path results, prefix/glob filtering, and offset pagination, but it does not cover permissions, snapshot/index prerequisites, error behavior, or what happens when no snapshot exists.

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 tight sentences front-load the purpose and then add usage and filtering/pagination details. There is no redundant or filler language.

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?

The description covers the core purpose, usage, return shape, filtering, and pagination, which is substantial. However, for a five-parameter tool with no annotations and no output schema, it leaves gaps around project semantics, limits, and operational prerequisites.

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 must compensate. It explains prefix/glob filtering and offset pagination, and implies the snapshot/project scope, but it does not clarify the required project parameter or the limit cap.

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: 'List regular files captured in one repository's immutable snapshot tree.' It also scopes the result to relative paths and distinguishes the tool's purpose from reading or searching snapshot contents.

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 gives clear usage contexts: file inventories and extension/path existence questions. It does not explicitly name alternatives such as search_snapshot_text or read_snapshot_file, but the intended use is unambiguous.

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