Skip to main content
Glama

The catalog as a PDF

get_catalog_pdf

A download link for the catalog as a PDF, draft or published. The stored PDF comes back at once when it is newer than the last change; otherwise a render starts — compressed by default, pdfFormat: "print" for press quality — and the link comes back when it finishes within about twenty seconds. state is "ready" (with downloadUrl), "rendering" (with jobId), "failed" (with reason) or "not_configured". "rendering" is not a failure — a large catalog takes a few minutes — and a call with that jobId returns the link once the render is done.

Input Schema

NameRequiredDescriptionDefault
jobIdNoFrom an earlier answer with state "rendering"
catalogIdYesCatalog id, as returned by list_catalogs
pdfFormatNoForces a fresh render in that format

Output Schema

NameRequiredDescriptionDefault
jobIdNoWith "rendering": call again with it to collect the PDF
stateYes
titleYes
cachedNoThe stored PDF, newer than the last change
reasonNo
catalogIdYes
downloadUrlNoWith "ready"
generatedAtNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing the caching rule (stored PDF returned when newer than last change), the ~20 second sync threshold, the full four-value `state` machine with what accompanies each state, and the explicit warning that "rendering" is not a failure and large catalogs take minutes. This is exactly the behavioral context the annotations (readOnly=false, destructive=false) leave unstated.

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?

Front-loads the outcome (a download link) before the mechanics, and every sentence carries information an agent would otherwise get wrong. The dense em-dash stacking makes it slightly harder to parse at a glance, keeping it off a 5.

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

Completeness5/5

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

For a three-parameter tool with an output schema, the description covers everything an agent needs: trigger semantics, default format, async polling, and the non-failure "rendering" state. No material gap remains.

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%, so the baseline is 3, but the description adds real meaning: `pdfFormat` is compressed by default and "print" is for press quality, and `jobId` is tied to polling a prior "rendering" response. Only `catalogId` is left to the schema.

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?

States a specific verb (download/get link) and resource (catalog rendered as PDF), plus the scope of draft vs published catalogs. It does not name or distinguish itself from adjacent siblings such as preview_catalog or preview_page_image, so an agent must infer which of the rendering tools to pick.

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

Usage Guidelines4/5

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

Gives clear operational guidance: it explains that a cached PDF returns immediately, that a render otherwise starts, and that a follow-up call with `jobId` retrieves the link when the render finishes. It stops short of naming alternatives or stating when-not to use it, so it is context-rich but not fully routing.

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