Skip to main content
Glama

How to write documents for ReflowPDF

read_guide
Read-only

The engine's guide: "overview" (the tools), "html" (paper, headers/footers, page numbers, tables of contents, footnotes, fonts, images, accessibility), "pages" (page kinds, breaks and keeping together, covers, numbering, bleed and crop marks), "design" (columns, drop caps, page decorations and watermarks, spacing, images and text wrap, typography), "charts" (the chart block), "codes" (QR codes and barcodes), "forms" (fillable fields), "templates" (the template language).

Input Schema

NameRequiredDescriptionDefault
topicNoDefault: html.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

The readOnlyHint and openWorldHint annotations already establish that this is a safe, local read operation. The description adds useful topic coverage, but it does not disclose the return format, whether the guide is static, or any other behavior beyond what annotations provide.

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 front-loaded sentence with zero filler; every parenthetical item maps directly to an enum value and helps topic selection. It is appropriately sized for a one-parameter documentation lookup tool.

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?

The description fully covers the only parameter and all of its possible topics, which is the main complexity for this tool. It does not state the return format, but with read-only annotations and a simple enum parameter, most of what an agent needs is present.

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 100%, so the baseline would be 3, but the description goes beyond the schema by explaining what each enum value contains, such as "pages" covering page kinds, breaks, covers, and bleed/crop marks. This materially helps an agent choose the correct topic.

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 identifies the resource as "The engine's guide" and enumerates what each guide topic covers, making clear that this tool retrieves documentation. It is distinguishable from sibling tools like get_document or render_pdf, though it never states the retrieval verb explicitly or names alternatives.

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

Usage Guidelines3/5

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

Usage is implied: read this guide to learn how to write ReflowPDF documents, with topics mapping to specific authoring concerns. There is no explicit when-to-use guidance, no prerequisites, and no mention of when not to use it versus other tools.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources