Skip to main content
Glama

export_chapter_html

Export a chapter from BookStack as a standalone HTML file. Specify the chapter ID or name along with book context.

Instructions

Export a chapter as a contained HTML file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
chapter_idNoID of the chapter to export. Required if name is not provided.
nameNoName of the chapter to export. Required if chapter_id is not provided.
book_id_contextNoID of the book containing the chapter. Required if chapter_name is used.
book_name_contextNoName of the book containing the chapter. Required if chapter_name is used.
Behavior2/5

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

No annotations are provided, and the description does not disclose behavioral traits beyond the basic export action. It does not specify if the HTML is standalone, includes dependencies, or any side effects. The description carries full burden but offers minimal insight.

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?

The description is a single sentence that is concise and front-loaded. However, it lacks any structural elements like sections or lists, and could be more informative without being 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 4 parameters, no output schema, and no annotations, the description is too minimal. It does not explain what 'contained HTML file' means, how to use parameters together (e.g., chapter_id vs name), or what the output looks like. This is insufficient for an agent to reliably invoke the tool.

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 four parameters. The description adds no additional meaning or context beyond the schema, so baseline 3 is appropriate.

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 clearly states the action ('Export'), the resource ('a chapter'), and the output format ('contained HTML file'). It effectively distinguishes from sibling tools like export_chapter_markdown or export_chapter_pdf.

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?

There is no guidance on when to use this tool versus alternatives like export_chapter_markdown or export_chapter_pdf. The description lacks context such as use cases or when not to use it.

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