Skip to main content
Glama

update_shelf

Update an existing BookStack shelf's name, description, assigned books, tags, or cover image.

Instructions

Update an existing shelf in BookStack.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shelf_idNoID of the shelf to update. Required if name is not provided.
nameNoNew name for the shelf. Required if shelf_id is not provided.
descriptionNoNew description of the shelf.
description_htmlNoNew HTML description of the shelf.
booksNoNew array of book IDs to set for the shelf. Overwrites existing assignments.
tagsNoNew tags for the shelf.
imageNoBase64 encoded image content for the new shelf cover. Set to null to remove.
Behavior2/5

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

The description only indicates 'update an existing shelf', which implies mutation but does not disclose any behavioral traits such as whether fields are overwritten, whether the shelf must exist, or what the response contains. With no annotations, the description carries the full burden and fails to provide sufficient transparency.

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

Conciseness3/5

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

The description is a single sentence, which is concise but arguably too brief. It lacks structure and could benefit from additional context without becoming verbose.

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

Completeness2/5

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

Given the tool has 7 optional parameters and no output schema, the description is insufficiently complete. It does not explain the update behavior (e.g., partial vs full overwrite) or the implications of not providing certain fields.

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?

The input schema has 100% coverage, so the baseline is 3. The description adds no additional meaning beyond what the schema already provides. It does not clarify parameter relationships or usage context.

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 clearly states the verb 'update' and the resource 'existing shelf', making the basic purpose evident. However, it does not differentiate from sibling tools like update_book or update_chapter, which have similar descriptions.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives such as create_shelf or delete_shelf. There is no mention of prerequisites, side effects, or when it would be inappropriate to use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Derron-Knox/bookstack-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server