Skip to main content
Glama

How to write documents for ReflowPDF

read_guide
Read-onlyIdempotent

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).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicNoDefault: html.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is fully covered structurally. The description adds only the topic content map; it says nothing about the return format (markdown? length? whether all topics are large payloads), which is the one behavioral detail an agent might want before requesting a topic.

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?

A single sentence with a dense but purposeful parenthetical list; every clause maps to a real enum value, so nothing is filler. The identification of the tool is front-loaded, though the long run-on list of topics is slightly harder to scan than a short lead sentence plus bullets would be.

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?

For a one-parameter read-only documentation tool, the description covers what matters: what it is and what each topic yields. The only meaningful gap is that it doesn't characterize the returned content (format, approximate size, whether topics are self-contained), and since there is no output schema, the description could have carried that detail.

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 coverage is 100% and the enum plus default are already documented, so 3 would be the baseline. The description goes beyond the bare enum values by summarizing the substantive contents of each topic (bleed and crop marks, drop caps, text wrap, fillable fields), which materially helps an agent pick the right topic rather than guessing from one-word labels.

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 this as the documentation lookup tool for the engine and enumerates exactly what each topic covers, so an agent knows what content comes back. It lacks an explicit verb ('returns the guide for the given topic'), but the resource and its granularity are unambiguous and it clearly doesn't overlap with any sibling tool.

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 only implied: an agent can infer this is reference material to consult before writing documents or templates, but the description never states when to call it (e.g., before render_pdf or update_document) or that 'overview' is the sensible first call. No alternatives or exclusions are named, though no sibling competes for the same job.

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.