Skip to main content
Glama

Update shelf, book or chapter

update

Rename a BookStack shelf, book, or chapter; change its description or tags; move a chapter with its pages to another book; or add/remove books on a shelf.

Instructions

Rename a shelf/book/chapter or change its description or tags; move a chapter (with its pages) to another book; add or remove books on a shelf. For pages use update_page / edit_page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameNo
tagsNoTags as {name, value}. When updating, this replaces all existing tags.
typeYes
descriptionNoNew plain-text description
add_book_idsNoShelves only: books to add
move_to_book_idNoChapters only: move the chapter into this book
remove_book_idsNoShelves only: books to take off the shelf

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden; it does disclose non-obvious behavior ('move a chapter (with its pages)'), which is useful. However, it omits mutation semantics such as whether omitted fields are left unchanged, whether tags replacement is destructive (that fact lives only in the schema), and any permission requirements.

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?

Two sentences, front-loaded with the primary update operations and ending with the routing exclusion. Every clause carries information an agent needs; nothing is padded.

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 multi-entity mutation tool with no annotations and no output schema, the description covers the full operation set and the page-edit exclusion. It leaves some behavior implicit (side effects, error/precondition handling for mismatched type and id), but with the schema documenting per-type parameters the coverage is close to sufficient.

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 description coverage is 63%, so there are gaps; the description compensates by mapping capabilities to entity types, e.g. moving a chapter (move_to_book_id) and adding/removing books on a shelf (add_book_ids/remove_book_ids). It adds context beyond the schema's terse 'Shelves only'/'Chapters only' notes, though it does not define all 8 parameters.

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?

The description names the specific verb+resource combinations: rename shelf/book/chapter, change description or tags, move a chapter, and add/remove books on a shelf. It also explicitly routes page edits away from this tool by naming update_page/edit_page, so an agent can separate it from siblings like create_book or delete without opening a schema.

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?

It gives a clear condition for the main alternative: 'For pages use update_page / edit_page.' That is an explicit when-to-use-else rule, but it does not clarify other boundaries (e.g. update vs create_*, or when removal should use delete instead of remove_book_ids).

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