Skip to main content
Glama

bookstack_books_export

Export BookStack books to HTML, PDF, plain text, or Markdown formats for backup, sharing, or offline access.

Instructions

Export a book in various formats (HTML, PDF, plain text, or Markdown)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesBook ID to export
formatYesExport format
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 the tool exports a book but doesn't disclose behavioral traits such as whether it's a read-only operation, what the output looks like (e.g., file download link, raw content), potential side effects (e.g., generating server load), or any authentication/rate limits. The description is minimal and lacks operational context.

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 that front-loads the core purpose ('Export a book') and specifies key details (formats). There is no wasted verbiage or redundancy, making it appropriately sized for the tool's complexity.

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

Completeness3/5

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

Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose but lacks completeness in usage guidelines, behavioral transparency, and output details. Without annotations or output schema, more context on what the export returns would be beneficial for an agent.

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 fully documents both parameters (id and format with enum values). The description adds no additional meaning beyond what's in the schema, such as explaining what a 'Book ID' is or providing examples of format usage. Baseline 3 is appropriate when the schema does the 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 ('Export') and resource ('a book'), specifying the available formats. It distinguishes from siblings like 'bookstack_books_list' or 'bookstack_books_read' by focusing on export functionality, though it doesn't explicitly differentiate from similar export tools like 'bookstack_chapters_export' or 'bookstack_pages_export'.

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. The description doesn't mention prerequisites (e.g., needing an existing book ID), compare it to sibling export tools (e.g., for chapters or pages), or indicate any constraints like file size limits or processing time.

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