Skip to main content
Glama
Paperboy

Paperboy

Official
by sudostash

flatten_pdf

DestructiveIdempotent

Flatten PDF form fields and annotations into page content so documents render consistently and edits are prevented.

Instructions

Flatten form fields and annotations into page content (requires the qpdf CLI). Needs the owner password if the PDF forbids changing comments or changing it. Signed PDFs are refused.

Any password argument can be "ask": the user then types it on a local page, so it never passes through the chat.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "input_path": "<input_path>"
    },
    "name": "flatten_pdf"
  }
}

Input Schema

NameRequiredDescriptionDefault
passwordNo
overwriteNo
input_pathYes
output_pathNo

Output Schema

NameRequiredDescriptionDefault
pagesYes
outputYes
warningsYes
password_protectedYes
user_password_changedYes
permissions_restrictedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "output": {
      +      "title": "Output",
      +      "type": "string"
      +    },
      +    "pages": {
      +      "title": "Pages",
      +      "type": "integer"
      +    },
      +    "password_protected": {
      +      "title": "Password Protected",
      +      "type": "boolean"
      +    },
      +    "permissions_restricted": {
      +      "title": "Permissions Restricted",
      +      "type": "boolean"
      +    },
      +    "user_password_changed": {
      +      "title": "User Password Changed",
      +      "type": "boolean"
      +    },
      +    "warnings": {
      +      "title": "Warnings",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "password_protected",
      +    "permissions_restricted",
      +    "user_password_changed",
      +    "output",
      +    "pages",
      +    "warnings"
      +  ],
      +  "title": "FlattenResult",
      +  "type": "object"
      +}
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the description's added value is the external CLI dependency, the permission/password preconditions, the signed-PDF refusal, and the 'ask' mode that keeps the secret off the chat transcript. It does not explain what happens when overwrite is left null, which matters for a destructive operation.

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?

Four short lines, front-loaded with the primary action and followed by preconditions and the password safety note; nothing is padding. The phrase 'if the PDF forbids changing comments or changing it' is awkwardly worded and slightly obscures the permission rule.

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

Completeness3/5

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

An output schema exists, so return values need not be described, and annotations cover the safety profile. The gap is that a destructive mutation with a null-default overwrite flag leaves an agent unable to predict whether the input file is replaced, which is material for correct invocation.

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 0%, so the description must carry all four parameters and only fully covers password (owner password semantics and the 'ask' sentinel). input_path, output_path, and especially the destructive overwrite flag receive no explanation of defaults or behavior.

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 states a specific verb and resource: 'Flatten form fields and annotations into page content', which is precise enough to separate it from fill_form or sanitize_pdf without opening the schema. It never names a sibling or explicitly contrasts with one, so it stops short of the top band.

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 gives concrete operating conditions: the qpdf CLI dependency, the owner-password requirement when permissions forbid changes, and the refusal of signed PDFs. That is clear context plus an explicit exclusion case, but there is no routing guidance among the many sibling PDF tools.

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