Skip to main content
Glama

goodnotes_prepare_study_revision

Prepares a selective revision of a completed study board by making a verified native copy of the original, including personal additions, while preventing duplicate copies with a stable request ID.

Instructions

Prepare a selective revision of a completed managed learning board or prior revision. Defaults to an independently verified native COPY including personal additions. copy=false keeps a verified native backup and targets the authorized original. A stable request ID prevents duplicate copies. Returns managed block IDs and current source references.

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": {
      "baseId": "<baseId>",
      "title": "<title>",
      "requestId": "<requestId>"
    },
    "name": "goodnotes_prepare_study_revision"
  }
}

Input Schema

NameRequiredDescriptionDefault
copyNo
titleYes
baseIdYes
itemPathNo
requestIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.21.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-destructive, open-world mutation, and the description adds real context beyond that: a verified native copy is made by default, copy=false preserves a backup and targets the original, and a stable request ID prevents duplicate copies. It also discloses the return payload. It stops short of stating permissions or failure modes.

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?

Four dense sentences, front-loaded with the core action and followed by the copy semantics, idempotency, and return value. No filler, though the copy/backup sentence is somewhat compressed and requires careful reading.

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?

A 5-parameter mutation tool with no output schema and zero schema coverage needs more. The description covers the copy branch, idempotency, and return shape, but leaves itemPath and the title/baseId relationship unexplained, so an agent cannot fully construct a call from the description alone.

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%, so the description must compensate. It gives meaningful semantics for copy (default true, copy vs backup behavior) and requestId (idempotency key), and implies baseId/title, but itemPath (a 1-13 element UUID path) is never explained, leaving a significant gap.

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: 'Prepare a selective revision of a completed managed learning board or prior revision.' An agent can distinguish it from run/review siblings by the 'prepare' framing, though no sibling is named explicitly.

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?

Explains the copy=true vs copy=false branch and the duplicate-prevention role of requestId, which is useful operational guidance. However, it never says when to choose this tool over goodnotes_plan_study_revision, goodnotes_run_study_revision, or goodnotes_review_study_revision, so the workflow position is only implied.

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