Skip to main content
Glama
formfeed

formfeed

Official

Compress a PDF

compress_pdf

Reduce PDF file size and return a downloadable compressed render; PDFs that cannot shrink are returned unchanged.

Instructions

Makes a PDF smaller and returns the render with download_url; a PDF that cannot be made smaller comes back as it was. For a preview picture of a page instead, use pdf_to_image. Pass exactly one PDF: source, a render or library file of the workspace; path, a file on this machine; or file_base64. Starter plan and above; 0.5 units on a live key. A PDF/A or a password-protected PDF is refused.

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": "compress_pdf"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoAbsolute path of a PDF on this machine, up to 100 MB; sent with the request and not kept
sourceNoA PDF of the workspace: the rnd_ id of a PDF render, or a PDF of the file library by name (such as terms.pdf) or fil_ id
filenameNoName of the file behind download_url; the source's name when left out
file_nameNoName of the PDF given as file_base64 or path, e.g. contract.pdf; the results are named after it
file_base64NoThe PDF itself, base64 encoded, up to 20 MB; sent with the request and not kept

Output Schema

NameRequiredDescriptionDefault
idYesrnd_ id of the render
formNoWhat fill_pdf_form did: the fields filled, those left out (unknown name or invalid value) and those whose calculation or display format no viewer ran
pdfaNoThe PDF/A verdict (PDF/A-2b or PDF/A-3b), when the template declares it
errorYesWhy a failed render failed
unitsYesUnits the render counted
outputNoThe format of the file: pdf, png, jpg, webp, docx or pptx, or zip for the several files of split_pdf and pdf_to_image
statusYes
einvoiceNoThe e-invoice report, when the render made one
templateYesThe template and version rendered; null for html and conversions
expires_atYesWhen download_url stops working; get_render issues a fresh one
page_countYes
environmentYes
download_urlYesSigned link to the file; null until the render succeeded
accessibilityNoThe PDF/UA-1 verdict, when the template declares it

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.26

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations (which only say non-read-only, non-destructive, non-idempotent), it discloses the meaningful behaviors: a no-op result when the file cannot shrink, the download_url return, a Starter-plus plan gate, a 0.5-unit cost on a live key, and refusals for PDF/A and password-protected files. That is exactly the operational context annotations cannot express, and it is consistent with readOnlyHint=false since a new render is produced.

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 purpose and return value come first, followed by alternative routing, input exclusivity, and constraints. Four sentences carry a lot of information with little waste, though the plan/credit clause sits mid-paragraph where it slightly interrupts the operational flow.

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 five-parameter tool with an output schema, the description supplies everything an agent needs to choose it and call it correctly: outcome, download_url return, exclusive input options, prerequisites, cost, and failure/refusal conditions. No gaps remain that the schema or output schema do not cover.

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 a real constraint the schema cannot express: 'Pass exactly one PDF' across source, path, or file_base64, which matters because zero parameters are marked required. It does not clarify the filename vs. file_name distinction, which remains schema-only.

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 opens with a specific verb and resource ('Makes a PDF smaller') and states the primary outcome ('returns the render with download_url'). It explicitly distinguishes itself from the sibling pdf_to_image, so an agent can route between the two without opening either schema.

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?

It names the alternative tool and the condition that selects it ('For a preview picture of a page instead, use pdf_to_image'), and adds plan/credit prerequisites plus refusal cases. There is no broader statement of when compression is not appropriate, but the routing guidance present is concrete.

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