get_document_snapshot

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

Annotations already indicate read-only, non-destructive, idempotent behavior. The description adds context about point-in-time retrieval and explicitly states restoration is out of scope, which is valuable beyond annotations.

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 concise with three sentences: purpose and output, resolution method, and usage guidance. Each sentence is meaningful and well-structured, with no wasted words.

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?

Covers identification, output format, and scope. References sibling tool list_document_snapshots for collision avoidance. Could mention error handling if snapshot not found, but output schema likely handles that. Overall, sufficiently complete for the tool's complexity.

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?

The schema only describes parameters as 'a string that will be trimmed', but the description explains the semantics: resolve document by teamspace plus title/ID, and resolve snapshot by snapshotId, title, or createdOn timestamp. It also advises preferring snapshotId when collisions may occur, adding significant meaning.

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 specifies the verb 'Get', the resource 'point-in-time Huly document history snapshot', and the output 'markdown content'. It clearly distinguishes from sibling tools like get_document and list_document_snapshots by detailing resolution methods and scope.

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?

Provides explicit guidance on how to resolve documents and snapshots, including a recommendation to use snapshotId from list_document_snapshots to avoid collisions. Also clarifies that restore is out of scope, effectively telling when not to use this tool.

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