snapshot

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

No annotations are provided, so the description must disclose behavior. It reveals a dependency on the session cache and suggests a required prior scan, which is useful. However, it does not specify side effects (e.g., whether capturing modifies state), nor does it describe output formats for list/diff modes, leaving gaps.

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 purpose and modes, followed by a critical dependency. No redundant words, every sentence contributes new 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?

The description covers modes and the capture dependency, but lacks a mapping of parameters to modes and does not explain expected return values (no output schema). Given the tool's multi-mode complexity, this is a noticeable gap, though it remains serviceable for a broad understanding.

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 low (25%), only mode has a description. The description explains mode values and mentions diff requires two snapshots, but it does not clarify the roles of 'label', 'beforeId', or 'afterId' beyond schema type definitions. This adds some context but leaves key parameters under-specified.

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 clearly states the tool captures or inspects Document Model snapshots, with distinct modes (before, after, list, diff). This is specific and distinctive among sibling tools, which focus on document analysis or editing, not snapshots.

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?

The description provides a clear prerequisite ('run scan_document first') for capture mode, indicating the workflow context. It doesn't explicitly exclude alternatives, but the snapshot functionality is unique among siblings, so usage is implied.

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