Skip to main content
Glama
Berrio
by Berrio

document_snapshot

Create an opaque, owner-bound snapshot of a document after verifying its exact revision.

Instructions

Creates an opaque, owner-bound snapshot of a document after verifying its exact revision.

Input Schema

NameRequiredDescriptionDefault
pathYes
ttlMsNo
workspaceIdYes
expectedRevisionYes

Output Schema

NameRequiredDescriptionDefault
revisionYes
snapshotIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations only declare destructiveHint=false; the description adds meaningful context about revision verification, owner-binding, and opacity. However it omits whether the snapshot fails on revision mismatch, TTL expiry behavior, or storage/auth implications of ownership.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single well-formed sentence with the verification precondition front-loaded. No waste, though it packs two concepts (creation and verification) that could be clarified.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Output schema exists, so return values need no explanation. The description covers the essential precondition and mutation semantics for a 4-param mutation tool; only failure modes on revision mismatch remain unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 4 parameters, but the schema itself enforces constraints (pattern, min/max, default) that document syntax well. The description names only 'revision' semantics; ttlMs, workspaceId, and path carry no added meaning beyond the schema. Baseline 3 per high structured enforcement.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Creates... snapshot of a document.' The 'opaque, owner-bound' qualifiers distinguish it from export/render siblings, though it doesn't name an alternative tool. A clear, self-contained purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies use via 'after verifying its exact revision', suggesting optimistic-concurrency use, but gives no explicit when-to-use vs alternatives (e.g., vs document_render_preview or export tools) and no when-not-to-use guidance.

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

Deploy Server

Other Tools