Skip to main content
Glama

Create Document Snapshot

create_snapshot

Create a Scrivener-native snapshot of a document before rewriting to preserve a restorable version with title and timestamp, without altering the current content.

Instructions

Take a Scrivener-native snapshot of a document's current content, restorable from Scrivener's own Snapshots browser. Use this before rewriting a document to give the writer a native rollback point. Copies the live content into the project's Snapshots directory with a title and timestamp; does not modify the document. Requires an open project and a document that has content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoSnapshot title shown in Scrivener. Defaults to "Snapshot".
documentIdYesUUID of the document to snapshot.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateYesTimestamp recorded for the snapshot.
titleYes
documentIdYes
snapshotIdYesId of the new snapshot (for read_snapshot).
Behavior4/5

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

Annotations indicate not readOnly, not destructive. Description adds that it 'copies the live content into the project's Snapshots directory' and 'does not modify the document,' which aligns with annotations. It also mentions prerequisites (open project, document with content). No contradictions.

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

Conciseness5/5

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

Three concise sentences covering purpose, usage, behavior, and prerequisites. No wasted words. Front-loaded with the core action.

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?

Given the simple 2-parameter schema and presence of an output schema, the description adequately covers prerequisites and behavior. Could mention error conditions (e.g., document not found) but not essential.

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 documentation covers 100% of parameters with descriptions. The description mentions 'with a title and timestamp,' which adds slight context but does not substantially exceed schema. Baseline 3 is appropriate.

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

Purpose5/5

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

The description clearly states the tool creates a Scrivener-native snapshot of a document's content. It distinguishes from sibling tools like list_snapshots, read_snapshot, and compare_snapshot by focusing on creation.

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

Usage Guidelines4/5

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

Explicitly advises using the tool 'before rewriting a document to give the writer a native rollback point,' providing clear usage context. It does not explicitly exclude other scenarios or mention alternatives, but the purpose is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/writerslogic/scrivener-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server