Skip to main content
Glama

goodnotes_prepare_unlock

Select a locked sticky, text box, image, or shape at a preview point, verify its native unlock control, and prepare a content/appearance guard without unlocking it.

Instructions

Select a locked sticky, text box, image or shape at a preview point (use the border for unfilled shapes). Verify its native unlock control and prepare a content/appearance guard. Does not unlock it.

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": {
      "viewId": "<viewId>",
      "x": "<x>",
      "y": "<y>"
    },
    "name": "goodnotes_prepare_unlock"
  }
}

Input Schema

NameRequiredDescriptionDefault
xYes
yYes
kindNosticky
viewIdYes
expectedTextNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.21.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false but destructiveHint=false, and the description reconciles that apparent tension by clarifying this selects and verifies but deliberately does not mutate the lock state. It adds real behavioral context beyond the annotations. The remaining weakness is the undefined jargon 'content/appearance guard', which leaves the agent unsure what state this preparation actually establishes.

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 with the key constraint ('Does not unlock it') front-loadable and no filler. The only cost is the opaque phrase 'content/appearance guard', which spends words without conveying meaning to a new caller.

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 five-parameter tool with zero schema description coverage and no output schema, the description covers the workflow purpose well but leaves the agent unequipped on viewId, the expectedText verification mechanism, and what 'guard' produces. It is adequate to decide when to call it, but not to call it confidently with the optional parameters.

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 parameter meaning and largely does not. It hints at the object kinds matching the `kind` enum and at coordinate placement ('at a preview point', 'use the border'), but neither viewId nor the 8000-character expectedText field — whose verification role seems important — is mentioned anywhere.

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?

States a specific verb chain (select, verify, prepare) on a specific resource (a locked sticky/text box/image/shape at a preview point) and explicitly negates the obvious confusion by ending with 'Does not unlock it.' That distinguishes it cleanly from the unlock_* siblings without the agent needing to open their schemas.

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?

The closing 'Does not unlock it' plus the two-phase framing (select, then verify/prepare) makes the intended position in a workflow clear, and the parenthetical '(use the border for unfilled shapes)' gives concrete usage guidance. It stops short of naming the follow-up tool (goodnotes_unlock_object) that actually performs the unlock, so the routing is implied rather than explicit.

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