Skip to main content
Glama

goodnotes_write_text

Destructive

Replace text on a previously read target in a locally allowed document, with empty strings clearing a read native shape label; verify text and kind after reload and use a unique operationId.

Instructions

Replace the text of a previously read target, only in a locally allowed document. An empty string clears only an explicitly read native shape label, keeping its shape. Verifies exact text and native kind after reload. Use a unique operationId; never retry an uncertain write with a new ID.

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": {
      "targetId": "<targetId>",
      "text": "<text>",
      "operationId": "<operationId>"
    },
    "name": "goodnotes_write_text"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes
targetIdYes
operationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.21.1

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already declare a destructive, non-read-only, open-world write, and the description goes well beyond them: it specifies that an empty string only clears a read native shape label while preserving the shape, that results are verified by reloading and checking exact text and native kind, and that retries must reuse the operationId. That is exactly the idempotency and side-effect detail an agent needs before a destructive write.

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 destructive-scope constraint front-loaded before the edge-case rules and the retry warning. Dense but no sentence is filler; the empty-string rule could arguably be split for readability but the ordering is sensible.

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?

For a destructive three-parameter write with no output schema and zero schema-level descriptions, the definition covers preconditions, the special empty-string case, post-write verification, and idempotency. What remains thin is the relationship to sibling text tools and the size limit on text.

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 coverage is 0%, so the description carries the burden. It adds real meaning for operationId (uniqueness and no fresh IDs on retry) and for text (empty-string clearing behavior), but says nothing about the 8000-character limit or the UUID target format, leaving part of the parameter surface undocumented.

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?

The description names a specific verb and resource ('Replace the text of a previously read target') and constrains the scope to a locally allowed document, which separates it from creation tools like goodnotes_create_text. It does not explicitly contrast with the closely named goodnotes_edit_text sibling, leaving the agent to infer the split.

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?

Preconditions are stated clearly: the target must have been read previously and the document must be locally allowed. Operational guidance about using a unique operationId and never retrying an uncertain write with a new ID is concrete and actionable. It stops short of naming an alternative tool when the preconditions fail.

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