Skip to main content
Glama

bookstack_chapters_update

Modify chapter details like name, description, tags, and priority in BookStack knowledge bases to maintain accurate and organized documentation.

Instructions

Update a chapter's details including name, description, tags, and priority

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesChapter ID to update
book_idNoMove chapter to different book
nameNoNew chapter name
descriptionNoNew chapter description in plain text
description_htmlNoNew chapter description in HTML format
tagsNoNew tags to assign to the chapter (replaces existing tags)
priorityNoNew chapter priority for ordering
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Update' implying a mutation, but doesn't disclose behavioral traits like required permissions, whether changes are reversible, if it overwrites or merges fields, rate limits, or what happens to unspecified fields. The description mentions what can be updated but not how the update behaves, leaving significant gaps for a mutation tool.

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?

The description is a single, efficient sentence with zero waste. It front-loads the purpose and lists key fields without unnecessary elaboration. Every word earns its place, making it easy to scan and understand quickly.

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's complexity (mutation with 7 parameters), lack of annotations, and no output schema, the description is incomplete. It doesn't cover behavioral aspects like permissions, side effects, or response format, and while schema coverage is high, the description adds little value beyond repeating parameter names. For a mutation tool, more context on safety and outcomes is needed.

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?

Schema description coverage is 100%, so the schema already documents all 7 parameters thoroughly. The description lists fields (name, description, tags, priority) that map to some parameters, adding minimal context about what can be updated. However, it doesn't explain semantics beyond the schema, such as interactions between fields (e.g., description vs description_html) or that 'tags' replaces existing ones (which is in the schema). Baseline 3 is appropriate as schema does heavy lifting.

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 action ('Update') and resource ('a chapter's details') with specific fields mentioned (name, description, tags, priority). It distinguishes from siblings like 'bookstack_chapters_create' (create vs update) and 'bookstack_chapters_read' (read vs update), though not explicitly named. However, it doesn't fully differentiate from 'bookstack_chapters_delete' (update vs delete) beyond the verb.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a chapter ID), when not to use it (e.g., for creating new chapters), or refer to sibling tools like 'bookstack_chapters_create' for creation or 'bookstack_chapters_read' for viewing. Usage is implied by the verb 'Update' but lacks explicit context.

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/pnocera/bookstack-mcp-server'

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