Skip to main content
Glama

goodnotes_restore_snapshot

Restores a saved native snapshot as a new independently editable document without overwriting originals, preserving both source and snapshot and verifying title/page identities.

Instructions

Restore a saved native snapshot into a NEW independently editable document. Keeps the original and snapshot intact. Checks snapshot title/page identities; does not overwrite originals.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "snapshotId": "<snapshotId>",
      "title": "<title>",
      "operationId": "<operationId>"
    },
    "name": "goodnotes_restore_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYes
snapshotIdYes
operationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.21.1

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=false and readOnlyHint=false; the description goes further by explaining the non-destructive semantics (original and snapshot preserved, no overwrite) and the identity check on snapshot title/page. It does not cover failure modes, permissions, or idempotency behavior of operationId.

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?

Three tight sentences, front-loaded with the core action before the invariants. Minor redundancy between 'Keeps the original and snapshot intact' and 'does not overwrite originals', which restate the same guarantee.

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

Completeness3/5

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

For a mutating, document-creating tool with three required parameters and no output schema, the description covers the safety story but omits what a successful restore returns (e.g., the new document identifier), what operationId controls, and what happens on a title collision.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry the burden, and it largely does not. 'Checks snapshot title/page identities' gives useful context for the title parameter, but snapshotId and especially operationId (apparently an idempotency key) are never explained.

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?

Names a specific verb and resource ('Restore a saved native snapshot') and states the concrete outcome: a NEW independently editable document, original untouched. This implicitly separates it from the in-place restore_document/restore_page siblings, but no sibling is named, so differentiation requires inference.

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?

Usage is only implied: an agent can infer this is the right tool when the user wants a restore that leaves the original and snapshot intact. There is no explicit when-to-use/when-not statement and no comparison against goodnotes_restore_document, goodnotes_restore_page, or goodnotes_verify_restore.

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