Skip to main content
Glama

update_document

DestructiveIdempotent

Change a published report's summary or collection in Kavita by series ID, including moving it to another collection or clearing its summary.

Instructions

Change the summary or the collection of a report published with add_document.

Works only on reports (the "Reports" library), and needs the Kavita series ID: for a report Kavita hasn't listed yet, call add_document again with the same title instead. collection moves the book: it leaves the collection it was published with and joins the new one; collections added by hand stay.

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": {
      "series_id": "<series_id>"
    },
    "name": "update_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
summaryNoNew summary; "" removes it; leave out to keep it
scan_nowNoAsk Kavita to scan the Reports library now (seconds) instead of waiting for its folder watcher (about 6 minutes). Needs an admin Kavita key.
series_idYesKavita series ID (from list_library, search or add_document)
collectionNoMove the book to this collection; "" takes it out of its collection; leave out to keep it

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare non-read-only, destructive and idempotent, and the description goes beyond them by explaining move semantics: the book leaves the collection it was published with, joins the new one, and hand-made collections stay untouched. It does not describe the scan_now side effect's latency or what the response looks like, but that gap is partly covered by the schema.

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?

Front-loaded with the action, then constraints, then the alternative path; every sentence carries information. Slight redundancy between "published with add_document" and "Works only on reports" costs a point but the text stays tight.

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 4-parameter destructive mutation with no output schema, the description covers scope, prerequisites, partial-update semantics and collection side effects. It stops short of saying what a successful call returns or confirms, which is the only remaining gap.

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, but the description adds real meaning: it clarifies that series_id must be a Kavita series ID and what to do when none exists, and it spells out the leave/join behavior of collection beyond the schema's terse "Move the book to this collection".

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 precise verb+resource (change the summary or collection of a report) and ties the object to its creator sibling, add_document. The scope restriction to reports distinguishes it clearly from generic document update tools.

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?

Explicitly names the condition where this tool cannot be used (a report Kavita hasn't listed yet) and routes the agent to add_document with the same title instead. It also states the prerequisite (Kavita series ID and its sources), leaving little to inference.

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