Skip to main content
Glama

goodnotes_set_document_favorite

Set the favorite flag for an authorized notebook or board using its exact title and prior state, then verify the change after reload to confirm identity and status.

Instructions

Set one authorized notebook/board favorite flag. Requires its exact title and previous favorite flag from the library; checks identity and state after reload.

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": {
      "itemPath": "<itemPath>",
      "expectedTitle": "<expectedTitle>",
      "expectedFavorite": "<expectedFavorite>",
      "favorite": "<favorite>",
      "operationId": "<operationId>"
    },
    "name": "goodnotes_set_document_favorite"
  }
}

Input Schema

NameRequiredDescriptionDefault
favoriteYes
itemPathYes
operationIdYes
expectedTitleYes
expectedFavoriteYes

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 only cover the safety profile (not read-only, not destructive, open-world); the description adds real behavior beyond that, namely that the tool performs an optimistic-concurrency check on title and prior favorite state and re-verifies identity and state after reload. It still omits what happens on a mismatch (error shape, whether a retry is needed), which keeps it from a 5.

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?

Two short sentences with the operation stated first and the preconditions second; no filler. The density of prepositional phrases ("from the library", "after reload") makes it slightly terse but not wasteful.

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-required-parameter mutation with no output schema and zero schema coverage, the description covers the verification contract but not the target identification or the new value being written. An agent would still be guessing about itemPath format and operationId purpose before it could call this correctly.

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 load, and it only accounts for two of the five required parameters (expectedTitle as "exact title" and expectedFavorite as "previous favorite flag"). itemPath, favorite, and operationId receive no explanation in either the schema or the description, leaving the most consequential inputs (the target path and the new value) 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 gives a specific verb and resource ("Set one authorized notebook/board favorite flag") scoped to a single item, which separates it from broader sibling operations like goodnotes_manage_document. It does not explicitly name a sibling alternative, so it stops short of a 5.

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?

"Requires its exact title and previous favorite flag from the library" implies the agent must first read the library and hold the current state before calling, which is meaningful usage context. However, there is no explicit statement of when to prefer this over other document-management siblings or what to do 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