Skip to main content
Glama

Edit a Grimmory book

update_book

Edit a book's title, authors, series details, categories, and field locks by hand; preview changes first, then confirm to apply so locked fields stay protected.

Instructions

Edits one Grimmory book by hand: title, authors, series, series number, categories (tags) and field locks. A locked field is refused unless the same call unlocks it, and Grimmory may rewrite the book file and rename it. Film, series or artist: update_media. From a provider: fix_metadata. Previews first; confirm to apply. Field reference: arr://docs/update_book.

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": {
      "id": "<id>"
    },
    "name": "update_book"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe book's id: `acquisition.id` on a get_library record, as 58 or grimmory:58.
tagsNoIts categories: free text that need not exist yet, replacing the set. [] clears them.
titleNoThe new title.
seriesNoThe series name. "" clears it.
authorsNoThe authors; replaces the list.
confirmNoThe token from this tool's preview; pass it back to apply.
dry_runNoPreview only, no token issued: for "what if" questions, not the first step of a change.
instanceNoWhich instance (e.g. "4k") when several of this service exist. Omit it when there is one.
lock_fieldsNoFields to lock after writing, so a metadata refresh leaves them alone.
series_numberNoThe book's number in its series.
unlock_fieldsNoFields to unlock before writing. A locked field is refused unless this call unlocks it.

Output Schema

NameRequiredDescriptionDefault
noopYes
tierYes
toolYes
targetYes
appliedYes
dry_runYes
effectsYes
serviceYes
summaryYes
operationYes
permissionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv2.2.0
    • changedInput schema / properties / confirm / description
      Previous value: -"The token from this tool's preview, passed back verbatim to apply it. Single-use and bound to the previewed arguments."New value: +"The token from this tool's preview; pass it back to apply."
    • changedInput schema / properties / dry_run / description
      Previous value: -"Preview without a confirm token, for \"what would happen if\" questions; not the first step of a real change."New value: +"Preview only, no token issued: for \"what if\" questions, not the first step of a change."
    • removedOutput schema / properties / audit_id
      Removed value: -{
      -  "type": "number"
      -}
    • removedOutput schema / properties / confirm_error
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / confirm_token
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / next_steps
      Removed value: -{
      -  "items": {
      -    "additionalProperties": {},
      -    "properties": {
      -      "arguments": {
      -        "additionalProperties": {},
      -        "properties": {},
      -        "type": "object"
      -      },
      -      "tool": {
      -        "type": "string"
      -      },
      -      "why": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "tool",
      -      "arguments",
      -      "why"
      -    ],
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • removedOutput schema / properties / permission / properties / reason
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / permission / properties / remedy
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / result
      Removed value: -{}
    • removedOutput schema / properties / unchecked
      Removed value: -{
      -  "items": {
      -    "type": "string"
      -  },
      -  "type": "array"
      -}
    • removedOutput schema / properties / warnings
      Removed value: -{
      -  "items": {
      -    "type": "string"
      -  },
      -  "type": "array"
      -}
  2. Addedv1.84.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and destructiveHint=false; the description adds the behavior that actually matters — a locked field is refused unless the same call unlocks it, and Grimmory may rewrite and rename the book file as a side effect. It also documents the preview-token workflow that the schema only implies, though it does not discuss failure modes or what the preview returns.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the operation and its editable fields, then packs routing, lock behavior, side effects and the preview/confirm rule into three tight sentences with no filler. The trailing doc pointer is a single clause and does not dilute the core.

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

Completeness5/5

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

For an 11-parameter mutation tool with an output schema and full schema descriptions, the description covers what structured fields cannot: the destructive side effects, the lock refusal rule, the preview/confirm protocol, and sibling routing. Nothing an agent needs in order to invoke it safely is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, and the description earns a step up by clarifying the `tags`-as-categories mapping and, more importantly, the lock/unlock interaction between `lock_fields`, `unlock_fields` and the write itself. It still leaves per-parameter detail (e.g. `instance`, clearing semantics) to the schema.

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 and resource ("Edits one Grimmory book by hand") and enumerates the editable surface: title, authors, series, series number, categories (`tags`) and field locks. It then names the siblings it is not (update_media for film/series/artist, fix_metadata for provider-sourced fixes), so an agent can route without opening another schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit alternatives with the condition that selects them: film/series/artist goes to update_media, provider data goes to fix_metadata. It also prescribes the operating order ("Previews first; confirm to apply"), which tells the agent what sequence to follow rather than just what the tool does.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.