pdf-writer-mcp — ツールリファレンス
INFO
v0.21.0 の tools/list ハンドシェイクから自動生成（20 ツール・2026-09-04）。手で編集しない — 再生成は node scripts/generate-reference.mjs。日本語訳は翻訳メモリ（scripts/i18n）から適用され、原文が更新された項目は同期されるまで英語で表示される。
このページは自動生成リファレンス — 全ツールの引数・型・既定値・戻り値を tools/list（正典 = サーバー実装）から写したもの。責務・設計思想・使いどころの解説は解説ページへ。
ツール一覧
| ツール | 概要 |
|---|---|
create_text_pdf | プレーンテキストから PDF を生成する。 |
create_markdown_pdf | Markdown から PDF を生成する。 |
create_table_pdf | ヘッダと行データから罫線付きの表 PDF を生成する。 |
set_metadata | 既存 PDF のメタデータ(Info 辞書)を更新する。 |
merge_pdfs | 複数の PDF を指定順に 1 つへ結合する。 |
split_pdf | PDF をページ範囲ごとに複数ファイルへ分割する。 |
extract_pages | 指定ページだけを含む新しい PDF を作る。 |
delete_pages | 指定ページを削除した新しい PDF を作る。 |
reorder_pages | ページを並べ替える。 |
add_bookmarks | PDF にしおり(アウトライン)を設定する。 |
add_annotation | ページに注釈を 1 つ追加する。 |
stamp_page_numbers | 各ページにページ番号を刻む。 |
add_watermark | 各ページの中央に斜めの透かし文字を重ねる("社外秘" / "DRAFT" / "COPY" 等)。 |
fill_form | 既存 PDF の対話フォーム（AcroForm）にフィールド値を流し込む。 |
flatten_form | 既存 PDF の対話フォーム（AcroForm）をフラット化し、記入済みの見た目を保ったまま非対話にする。 |
tag_form_fields | タグ付き PDF のフォームを PDF/UA-1 準拠へ修復する。 |
ensure_tagged | 既存 PDF を PDF/UA-1 の「器」に載せる。 |
ensure_pdfa | 既存 PDF を PDF/A の「器」に載せる（ensure_tagged の PDF/A 版）。 |
attach_file | PDF にファイルを埋め込む(添付する)。 |
rotate_pages | ページを時計回りに回転する(90/180/270 度)。 |
create_text_pdf
Create PDF from Plain Text
プレーンテキストから PDF を生成する。改行(\n)を尊重し、空行を段落区切りとして扱う。長い行は自動で折り返す。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
text | string | 必須 | 本文テキスト。\n で改行、空行で段落区切り。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
fontPath | string (minLength 1) | 任意 | 埋め込むフォントファイル(.ttf / .otf)の絶対パス。日本語など非ラテン文字を含む場合は必須。.ttc(TrueTypeCollection)は非対応。環境変数 PDF_WRITER_FONT でも指定可。 | |
fontSize | number (4–96) | 任意 | 本文フォントサイズ(pt)。既定 11。範囲 4〜96。 | |
pageSize | "A4" | "A3" | "A5" | "LETTER" | "LEGAL" | 任意 | ページサイズ。既定 A4。 | |
margin | number (0–300) | 任意 | 上下左右マージン(pt)。既定 56(≒20mm)。範囲 0〜300。 | |
title | string | 任意 | PDF タイトル。メタデータに設定し、本文冒頭にも見出しとして描画する。 | |
author | string | 任意 | PDF 作成者(メタデータ)。 | |
onMissingGlyph | "error" | "replace" | "ignore" | 任意 | フォントに存在しない文字(例: Noto Sans JP に無い ✔ U+2714)の扱い。error(既定)=欠落文字を列挙してエラー / replace=〓 に置換して警告 / ignore=空白のまま描画して警告。 | |
tagged | boolean | 任意 | タグ付き PDF(PDF/UA-1・ISO 14289)として生成する。既定 false。true にすると構造木・PDF/UA 宣言・/Lang・DisplayDocTitle を付与し、スクリーンリーダで読める文書になる。PDF/UA はタイトルを要求するため title が必須。 | |
lang | string | 任意 | 文書の自然言語(BCP 47。例 "ja" / "en-US")。tagged 時に省略すると本文から推定し、推定結果を warnings で報告する。誤った言語宣言はスクリーンリーダの誤読を招くため、確実な場合は明示すること。 | |
pdfVersion | "1.7" | "2.0" | 任意 | 出力する PDF の版。既定 "1.7"。"2.0"(ISO 32000-2)にすると版の宣言だけでなく、版に紐づく義務も満たす: trailer /ID を付与し(Table 15 で Required)、Info 辞書を CreationDate / ModDate に絞って題名・作成者・Producer は XMP へ移す(§14.3.3)。tagged: true とは併用できない(writer が書けるのは PDF 1.7 基盤の PDF/UA-1 宣言のみ)。 |
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
tagged: true と pdfVersion: "2.0" は併用できません
このサーバーが書ける適合宣言は PDF/UA-1（PDF 1.7 基盤）だけです。PDF 2.0 の文書に載せると、誰にも測れない宣言になります。
タグ付きにするなら最初から
後から ensure_tagged を掛けるより、tagged: true で作るほうが良い文書になります。PDF/UA はタイトル必須のため title も必須です。lang は確実なら明示してください。
呼び出し例 — 「タグ付きの短い PDF を作って」
- 実測: v0.21.0
tagged:truelang:"en"title:"Tagged sample"- フォント: 標準 Helvetica（
fontPathなし）
パラメータ
{
"text": "This is a tagged sample.\n\nSecond paragraph.",
"title": "Tagged sample",
"tagged": true,
"lang": "en",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON
{
"pageCount": 1,
"bytes": 4122,
"font": "Helvetica",
"path": "/absolute/path/to/output.pdf",
"warnings": [
"The standard font (Helvetica) is not embedded, but PDF/UA-1 (7.21.4.1) requires all fonts to be embedded — this tagged PDF will NOT pass conformance validation. Pass \"fontPath\" (or set PDF_WRITER_FONT) to embed a font."
]
}標準フォントは埋め込まれないため、PDF/UA-1 7.21.4.1 では veraPDF は通りません。日本語やタグ付き納品では fontPath（または PDF_WRITER_FONT）を渡してください。
create_markdown_pdf
Create PDF from Markdown
Markdown から PDF を生成する。見出し・段落・箇条書き/番号リスト・コードブロック・引用・水平線・表に対応。インライン装飾の記号は除去し字面のみ反映する(単一フォントのため)。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
markdown | string | 必須 | Markdown 文字列。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
fontPath | string (minLength 1) | 任意 | 埋め込むフォントファイル(.ttf / .otf)の絶対パス。日本語など非ラテン文字を含む場合は必須。.ttc(TrueTypeCollection)は非対応。環境変数 PDF_WRITER_FONT でも指定可。 | |
fontSize | number (4–96) | 任意 | 本文フォントサイズ(pt)。既定 11。範囲 4〜96。 | |
pageSize | "A4" | "A3" | "A5" | "LETTER" | "LEGAL" | 任意 | ページサイズ。既定 A4。 | |
margin | number (0–300) | 任意 | 上下左右マージン(pt)。既定 56(≒20mm)。範囲 0〜300。 | |
title | string | 任意 | PDF タイトル。メタデータに設定し、本文冒頭にも見出しとして描画する。 | |
author | string | 任意 | PDF 作成者(メタデータ)。 | |
onMissingGlyph | "error" | "replace" | "ignore" | 任意 | フォントに存在しない文字(例: Noto Sans JP に無い ✔ U+2714)の扱い。error(既定)=欠落文字を列挙してエラー / replace=〓 に置換して警告 / ignore=空白のまま描画して警告。 | |
tagged | boolean | 任意 | タグ付き PDF(PDF/UA-1・ISO 14289)として生成する。既定 false。true にすると構造木・PDF/UA 宣言・/Lang・DisplayDocTitle を付与し、スクリーンリーダで読める文書になる。PDF/UA はタイトルを要求するため title が必須。 | |
lang | string | 任意 | 文書の自然言語(BCP 47。例 "ja" / "en-US")。tagged 時に省略すると本文から推定し、推定結果を warnings で報告する。誤った言語宣言はスクリーンリーダの誤読を招くため、確実な場合は明示すること。 | |
pdfVersion | "1.7" | "2.0" | 任意 | 出力する PDF の版。既定 "1.7"。"2.0"(ISO 32000-2)にすると版の宣言だけでなく、版に紐づく義務も満たす: trailer /ID を付与し(Table 15 で Required)、Info 辞書を CreationDate / ModDate に絞って題名・作成者・Producer は XMP へ移す(§14.3.3)。tagged: true とは併用できない(writer が書けるのは PDF 1.7 基盤の PDF/UA-1 宣言のみ)。 |
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
tagged: true と pdfVersion: "2.0" は併用できません
このサーバーが書ける適合宣言は PDF/UA-1（PDF 1.7 基盤）だけです。PDF 2.0 の文書に載せると、誰にも測れない宣言になります。
タグ付きにするなら最初から
後から ensure_tagged を掛けるより、tagged: true で作るほうが良い文書になります。PDF/UA はタイトル必須のため title も必須です。lang は確実なら明示してください。
呼び出し例の形は create_text_pdf と同じです（text の代わりに markdown）。
create_table_pdf
Create Table PDF
ヘッダと行データから罫線付きの表 PDF を生成する。列幅は内容から自動算出し、セル内は折り返す。改ページ時はヘッダを再描画する。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
headers | string[] | 必須 | ヘッダ行(列見出し)の配列。 | |
rows | string[][] | 必須 | データ行の配列。各行は文字列の配列で、headers と同じ列数を推奨。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
fontPath | string (minLength 1) | 任意 | 埋め込むフォントファイル(.ttf / .otf)の絶対パス。日本語など非ラテン文字を含む場合は必須。.ttc(TrueTypeCollection)は非対応。環境変数 PDF_WRITER_FONT でも指定可。 | |
fontSize | number (4–96) | 任意 | 本文フォントサイズ(pt)。既定 11。範囲 4〜96。 | |
pageSize | "A4" | "A3" | "A5" | "LETTER" | "LEGAL" | 任意 | ページサイズ。既定 A4。 | |
margin | number (0–300) | 任意 | 上下左右マージン(pt)。既定 56(≒20mm)。範囲 0〜300。 | |
title | string | 任意 | PDF タイトル。メタデータに設定し、本文冒頭にも見出しとして描画する。 | |
author | string | 任意 | PDF 作成者(メタデータ)。 | |
onMissingGlyph | "error" | "replace" | "ignore" | 任意 | フォントに存在しない文字(例: Noto Sans JP に無い ✔ U+2714)の扱い。error(既定)=欠落文字を列挙してエラー / replace=〓 に置換して警告 / ignore=空白のまま描画して警告。 | |
tagged | boolean | 任意 | タグ付き PDF(PDF/UA-1・ISO 14289)として生成する。既定 false。true にすると構造木・PDF/UA 宣言・/Lang・DisplayDocTitle を付与し、スクリーンリーダで読める文書になる。PDF/UA はタイトルを要求するため title が必須。 | |
lang | string | 任意 | 文書の自然言語(BCP 47。例 "ja" / "en-US")。tagged 時に省略すると本文から推定し、推定結果を warnings で報告する。誤った言語宣言はスクリーンリーダの誤読を招くため、確実な場合は明示すること。 | |
pdfVersion | "1.7" | "2.0" | 任意 | 出力する PDF の版。既定 "1.7"。"2.0"(ISO 32000-2)にすると版の宣言だけでなく、版に紐づく義務も満たす: trailer /ID を付与し(Table 15 で Required)、Info 辞書を CreationDate / ModDate に絞って題名・作成者・Producer は XMP へ移す(§14.3.3)。tagged: true とは併用できない(writer が書けるのは PDF 1.7 基盤の PDF/UA-1 宣言のみ)。 |
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
tagged: true と pdfVersion: "2.0" は併用できません
このサーバーが書ける適合宣言は PDF/UA-1（PDF 1.7 基盤）だけです。PDF 2.0 の文書に載せると、誰にも測れない宣言になります。
タグ付きにするなら最初から
後から ensure_tagged を掛けるより、tagged: true で作るほうが良い文書になります。PDF/UA はタイトル必須のため title も必須です。lang は確実なら明示してください。
呼び出し例の形は create_text_pdf と同じです（text の代わりに headers と rows）。
set_metadata
Set PDF Metadata
既存 PDF のメタデータ(Info 辞書)を更新する。指定したフィールドのみ変更し、他は保持する。title / author / subject / keywords / creator のうち最低 1 つが必要。XMP(/Metadata)を持つ文書では dc:title 等も同期して不整合を防ぐ。署名済み PDF には preserveSignatures: true で署名を保持したまま更新できる。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 編集対象 PDF の絶対パス。 | |
title | string | 任意 | タイトル。 | |
author | string | 任意 | 作成者。 | |
subject | string | 任意 | サブタイトル・件名。 | |
keywords | string[] | 任意 | キーワードの配列。 | |
creator | string | 任意 | 作成アプリケーション名。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
XMP がある文書では dc:title 等も同期します
Info 辞書だけを変えて XMP と食い違わないようにします。title / author / subject / keywords / creator の少なくとも 1 つが必須です。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（増分更新）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
merge_pdfs
Merge PDFs
複数の PDF を指定順に 1 つへ結合する。文書メタデータは先頭ファイルから引き継ぐ。
ページを新しい文書へ複製するため、文書レベルの情報（タグ付き構造・XMP・添付・AcroForm・しおり等）は引き継がれない。失われたものは warnings で報告されるので、必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけする。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPaths | string (minLength 1)[] | 必須 | 結合する PDF の絶対パスの配列(結合順・2 件以上)。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
文書レベル情報は引き継がれない
ページを新しい文書へ複製するため、タグ付き構造・XMP・AcroForm・しおり等は引き継がれません。失われたものは warnings で報告されます。必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけしてください。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。
呼び出し例 — 「この 2 つの PDF を 1 つにまとめて」
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdfとdocs/specimens/selfmade-base.pdf（呼び出すときは絶対パス）
パラメータ
{
"inputPaths": [
"/absolute/path/to/docs/specimens/publish-demo.pdf",
"/absolute/path/to/docs/specimens/selfmade-base.pdf"
],
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON（warnings は要約）
{
"pageCount": 2,
"bytes": 35552,
"path": "/absolute/path/to/output.pdf",
"warnings": [
"The input XMP declares conformance (pdfuaid/pdfaid) that this output can no longer meet — the structure tree is not carried over yet — so it was dropped rather than copied. …",
"merge_pdfs did not carry over the tagged structure (/StructTreeRoot, /MarkInfo) that the input had …",
"merge_pdfs did not carry over the XMP metadata (/Metadata) that the input had …"
]
}XMP の pdfaid / pdfuaid はコピーせず落とします。名乗ったまま構造木が無いファイルは、名乗らないファイルより悪いためです。
split_pdf
Split PDF
PDF をページ範囲ごとに複数ファイルへ分割する。ranges の各要素が 1 ファイルになり、出力は "<prefix>1.pdf", "<prefix>2.pdf", ... の連番になる。
ページを新しい文書へ複製するため、文書レベルの情報（タグ付き構造・XMP・添付・AcroForm・しおり等）は引き継がれない。失われたものは warnings で報告されるので、必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけする。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 分割対象 PDF の絶対パス。 | |
ranges | string (minLength 1)[] | 必須 | ページ範囲指定の配列。各要素は "1-3" / "5" / "7-" / "-2" 形式(1 始まり)。例: ["1-3", "4-"]。 | |
outputDir | string (minLength 1) | 必須 | 出力先ディレクトリ（絶対パス）。 | |
prefix | string (minLength 1) | 任意 | 出力ファイル名の接頭辞。既定は "<入力ファイル名>-part"。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
文書レベル情報は引き継がれない
ページを新しい文書へ複製するため、タグ付き構造・XMP・AcroForm・しおり等は引き継がれません。失われたものは warnings で報告されます。必要なら各出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけしてください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。
extract_pages
Extract Pages
指定ページだけを含む新しい PDF を作る。指定順がそのまま出力順になるため、ページの並べ替えを兼ねた抽出もできる。
ページを新しい文書へ複製するため、文書レベルの情報（タグ付き構造・XMP・添付・AcroForm・しおり等）は引き継がれない。失われたものは warnings で報告されるので、必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけする。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
pages | string (minLength 1) | 必須 | ページ指定。"1,3-5,8-" 形式(1 始まり)。指定順が出力順になる。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
文書レベル情報は引き継がれない
ページを新しい文書へ複製するため、タグ付き構造・XMP・AcroForm・しおり等は引き継がれません。失われたものは warnings で報告されます。必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけしてください。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
pages は文字列
"1" / "1,3-5,8-" です。配列ではありません。指定順が出力順になります。
呼び出し例 — 「1 ページ目だけ抜き出して」
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdf（呼び出すときは絶対パス） pages:"1"
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/publish-demo.pdf",
"pages": "1",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON（warnings は要約）
{
"pageCount": 1,
"bytes": 26881,
"path": "/absolute/path/to/output.pdf",
"warnings": [
"The input XMP declares conformance (pdfuaid/pdfaid) that this output can no longer meet — the structure tree is not carried over yet — so it was dropped rather than copied. …",
"extract_pages did not carry over the tagged structure (/StructTreeRoot, /MarkInfo) that the input had …",
"extract_pages did not carry over the XMP metadata (/Metadata) that the input had …"
]
}delete_pages
Delete Pages
指定ページを削除した新しい PDF を作る。全ページを削除する指定はエラーになる。
ページを新しい文書へ複製するため、文書レベルの情報（タグ付き構造・XMP・添付・AcroForm・しおり等）は引き継がれない。失われたものは warnings で報告されるので、必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけする。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
pages | string (minLength 1) | 必須 | 削除するページ指定。"1,3-5,8-" 形式(1 始まり)。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
文書レベル情報は引き継がれない
ページを新しい文書へ複製するため、タグ付き構造・XMP・AcroForm・しおり等は引き継がれません。失われたものは warnings で報告されます。必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけしてください。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。
reorder_pages
Reorder Pages
ページを並べ替える。order には全ページを新しい順序で 1 回ずつ列挙する。
ページを新しい文書へ複製するため、文書レベルの情報（タグ付き構造・XMP・添付・AcroForm・しおり等）は引き継がれない。失われたものは warnings で報告されるので、必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけする。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
order | integer (-9007199254740991–9007199254740991)[] | 必須 | 新しいページ順(1 始まり)。例: 5 ページの逆順は [5,4,3,2,1]。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
文書レベル情報は引き継がれない
ページを新しい文書へ複製するため、タグ付き構造・XMP・AcroForm・しおり等は引き継がれません。失われたものは warnings で報告されます。必要なら出力に attach_file / ensure_tagged / add_bookmarks / set_metadata を後がけしてください。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。
add_bookmarks
Add Bookmarks (Outline)
PDF にしおり(アウトライン)を設定する。既存のしおりは置換される。children で入れ子にできる。署名済み PDF には preserveSignatures: true で署名を保持したまま設定できる。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
bookmarks | any[] | 必須 | しおりの配列。各要素は { title, page, open?, children? }。page は 1 始まり。children で階層化でき、最大 8 階層・合計 2000 件まで。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
既存のしおりを置換します
追加ではなく置き換えです。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（増分更新）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
add_annotation
Add Annotation
ページに注釈を 1 つ追加する。付箋（text）・ハイライト（highlight）・矩形（square）に対応し、座標は PDF 座標系（左下原点・pt）で指定する。
署名済み PDF には preserveSignatures: true を使うと、既存署名を無効化せず増分更新で追加できる。タグ付き文書では Annot 構造要素への内包も増分に含まれ、PDF/UA 準拠が保たれる。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
page | integer (1–9007199254740991) | 必須 | 対象ページ(1 始まり)。 | |
type | "text" | "highlight" | "square" | 必須 | text=付箋アイコン / highlight=ハイライト / square=矩形。 | |
rect | object | 必須 | 注釈の矩形。PDF 座標系(左下原点・pt)。x1<x2 かつ y1<y2 であること。 | |
rect.x1 | number | 必須 | ||
rect.y1 | number | 必須 | ||
rect.x2 | number | 必須 | ||
rect.y2 | number | 必須 | ||
contents | string | 任意 | 注釈の本文(日本語可)。 | |
author | string | 任意 | 作成者名。 | |
alt | string | 任意 | 支援技術向けの代替テキスト。タグ付き PDF では注釈が Annot 構造要素に内包される(PDF/UA 7.18.1-1)ため、その要素の /Alt になる。タグ無し文書では無視される。 | |
color | string | 任意 | #rrggbb 形式。既定は type ごと(text=#ffd400 / highlight=#ffff00 / square=#ff0000)。 | |
interiorColor | string | 任意 | square の塗り色(#rrggbb)。 | |
icon | "Note" | "Comment" | "Key" | "Help" | "NewParagraph" | "Paragraph" | "Insert" | 任意 | text のアイコン。既定 Note。 | |
open | boolean | 任意 | text を開いた状態にするか。既定 false。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で注釈を追加する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。タグ付き PDF では Annot 構造要素への内包も増分に含めて PDF/UA 準拠を維持する。認証署名（DocMDP）では P=3 のときのみ許可。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
座標は PDF 座標系
左下原点・pt です。pdf-reader-mcp の locate_objects / extract_structured_text（include_bbox）が返す矩形をそのまま渡せます。タグ付き文書では Annot 構造要素への内包（PDF/UA 7.18.1-1）も行い、支援技術向けの代替テキストは alt で渡します。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（増分更新。DocMDP では P=3 のときのみ許可）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
呼び出し例 — 「H1 の矩形に四角注釈を付けて」
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdf（呼び出すときは絶対パス） type:"square"rect: pdf-reader-mcp が返した H1 の bbox（56, 766.306）–（375.194, 792.37）
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/publish-demo.pdf",
"page": 1,
"type": "square",
"rect": { "x1": 56, "y1": 766.306, "x2": 375.194, "y2": 792.37 },
"contents": "H1",
"alt": "Heading highlight",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON
{
"pageCount": 1,
"bytes": 93486,
"path": "/absolute/path/to/output.pdf"
}stamp_page_numbers
Stamp Page Numbers
各ページにページ番号を刻む。タグ付き PDF では Artifact として囲むため PDF/UA 準拠を維持する。日本語を含む書式を使う場合は fontPath か環境変数 PDF_WRITER_FONT が必要。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
format | string (minLength 1) | 任意 | 書式。{n}=現在ページ、{total}=総ページ数。既定 "{n}"。例: "- {n} -" / "{n} / {total}" / "{n} ページ"。{n} を必ず含めること。 | |
position | "bottom-left" | "bottom-center" | "bottom-right" | "top-left" | "top-center" | "top-right" | 任意 | 配置。既定 bottom-center。ページの回転(/Rotate)を考慮した見た目の位置。 | |
margin | number (0–300) | 任意 | 端からの余白(pt)。既定 24。範囲 0〜300。 | |
fontSize | number (4–96) | 任意 | フォントサイズ(pt)。既定 9。範囲 4〜96。 | |
color | string (minLength 1) | 任意 | #rrggbb。既定 #666666。 | |
fontPath | string (minLength 1) | 任意 | 埋め込むフォント(.ttf/.otf)。省略時は環境変数 PDF_WRITER_FONT → 標準フォント。日本語を含む書式には必須。 | |
pages | string (minLength 1) | 任意 | 番号を刻むページ指定。"1,3-5,8-" 形式(1 始まり)。省略時は全ページ。表紙を除くなら "2-" のように指定する。 | |
startAt | integer (-9007199254740991–9007199254740991) | 任意 | 最初に刻む番号。既定 1。表紙を除いて 1 から始めたい場合などに使う。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
タグ付き PDF では Artifact
ページ番号は Artifact として囲むため、PDF/UA 準拠が保たれます。日本語を含む format にはフォントが必須です。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（増分更新）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
add_watermark
Add Watermark
各ページの中央に斜めの透かし文字を重ねる("社外秘" / "DRAFT" / "COPY" 等)。既定では本文の背面に薄く敷く。タグ付き PDF では Artifact として囲むため PDF/UA 準拠を維持する。日本語の透かしには fontPath か環境変数 PDF_WRITER_FONT が必要。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
text | string (minLength 1) | 必須 | 透かし文字。例: "社外秘" / "DRAFT" / "COPY"。 | |
fontSize | number (4–96) | 任意 | フォントサイズ(pt)。既定 60。範囲 4〜96。 | |
color | string (minLength 1) | 任意 | #rrggbb。既定 #808080(灰)。 | |
opacity | number (0–1) | 任意 | 不透明度 0(透明)〜1(不透明)。既定 0.15。本文を読める程度に薄くする。 | |
angle | number | 任意 | 反時計回りの角度(度)。既定 45。0 で水平。 | |
behind | boolean | 任意 | 本文の背面に敷くか。既定 true。false にすると本文の上に重なる(改ざん防止の主張を強めたい場合)。 | |
fontPath | string (minLength 1) | 任意 | 埋め込むフォント(.ttf/.otf)。省略時は環境変数 PDF_WRITER_FONT → 標準フォント。日本語の透かしには必須。 | |
pages | string (minLength 1) | 任意 | 対象ページ指定。"1,3-5,8-" 形式(1 始まり)。省略時は全ページ。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
タグ付き PDF では Artifact
透かしは Artifact として囲むため、PDF/UA 準拠が保たれます。日本語の文字列にはフォントが必須です。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（増分更新）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
呼び出し例 — 「全ページに DRAFT の透かしを入れて」
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdf（呼び出すときは絶対パス） text:"DRAFT"
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/publish-demo.pdf",
"text": "DRAFT",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON
{
"pageCount": 1,
"bytes": 93321,
"path": "/absolute/path/to/output.pdf",
"watermarked": 1,
"artifact": true
}artifact: true は、タグ付き入力では透かしが Artifact として囲まれたことを示します。
fill_form
Fill Form (AcroForm)
既存 PDF の対話フォーム（AcroForm）にフィールド値を流し込む。XFA フォームは非対応。
- フィールド名が分からないときは、存在しない名前を指定するとエラーに全フィールド名と型が列挙される
- 日本語の値には fontPath か環境変数 PDF_WRITER_FONT が必要
- flatten: true で記入後に非対話化できる。ただしタグ付き PDF では PDF/UA 準拠が壊れるため allowBreakingTags: true も必要
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
fields | object | 必須 | フィールド名 → 値のオブジェクト。値の型はフィールド種別に対応する: text=文字列か数値 / checkbox=真偽値 / dropdown・optionlist=文字列か文字列配列 / radio=文字列。例: {"user.name": "山田 太郎", "agree": true, "plan": "A"} | |
fontPath | string (minLength 1) | 任意 | 値の描画に使うフォント(.ttf/.otf)。省略時は環境変数 PDF_WRITER_FONT → 標準フォント。日本語の値には必須。 | |
flatten | boolean | 任意 | 記入後にフラット化して非対話にするか。既定 false。true にすると値は編集できなくなる。 | |
allowBreakingTags | boolean | 任意 | タグ付き PDF でもフラット化を許すか。既定 false。true にすると PDF/UA-1 準拠が壊れる。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
フィールド名が分からないとき
存在しない名前を 1 つ渡すと、エラーに全フィールド名と型が列挙されます。メッセージ文字列ではなく code で分岐してください。
XFA には対応していません
AcroForm だけです。flatten: true をタグ付き PDF に使うと PDF/UA 準拠でなくなり、さらに allowBreakingTags: true が必要です。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
呼び出し例 — 「フォームに値を流し込む」（AcroForm が無い標本）
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdf（呼び出すときは絶対パス。AcroForm 無し） fields:{ "dummy": "x" }
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/publish-demo.pdf",
"fields": { "dummy": "x" },
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON（エラー）
{
"error": "\"/absolute/path/to/docs/specimens/publish-demo.pdf\" has no AcroForm fields to fill.",
"code": "INVALID_ARGUMENT"
}フィールドが無いときはこの code です。フィールドはあるが名前を間違えたときは、エラー本文に名前と型が列挙されます。
flatten_form
Flatten Form
既存 PDF の対話フォーム（AcroForm）をフラット化し、記入済みの見た目を保ったまま非対話にする。配布前に値を固定したい場合に使う。
既存の値に日本語が含まれるなら、外観の再生成に備えて fontPath か環境変数 PDF_WRITER_FONT を指定しておくこと。タグ付き PDF では Widget 注釈が消えて Form 構造要素が宙に浮くため、既定では拒否する（allowBreakingTags: true で強行できる）。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
fontPath | string (minLength 1) | 任意 | 外観生成に使うフォント。省略時は環境変数 PDF_WRITER_FONT → 標準フォント。既存の外観をそのまま使える場合は不要だが、再生成が必要な日本語フォームでは要る。 | |
allowBreakingTags | boolean | 任意 | タグ付き PDF でもフラット化を許すか。既定 false。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
タグ付き PDF では既定で拒否
Widget 注釈が消えて Form 構造要素が宙に浮くためです。allowBreakingTags: true で強行できますが、PDF/UA 準拠でなくなります。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。
tag_form_fields
Tag Form Fields (PDF/UA repair)
タグ付き PDF のフォームを PDF/UA-1 準拠へ修復する。行うのは次の 3 つ:
- Widget 注釈を Form 構造要素に内包する（7.18.4-1）
- 対象ページに /Tabs S を立てる（7.18.3-1）
- フィールドに代替名 /TU を付与する（7.18.1-3）
labels でスクリーンリーダー向けの人間可読な名前を渡すこと。既に構造木に結ばれた Widget はスキップするため、何度実行しても安全である。タグ無し文書は対象外（create 系の tagged: true でゼロから作る）。
署名済み PDF には preserveSignatures: true で署名を保持したまま修復できる（承認署名のみ。認証署名は拒否）。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
labels | object | 任意 | フィールド名 → 人間可読な代替名(/TU)。スクリーンリーダが読み上げる名前で、例: {"user.name": "氏名", "agree": "利用規約に同意する"}。省略したフィールドはフィールド名を /TU に代用し、warnings で報告する。存在しないフィールド名を指定するとエラーに全フィールド名が列挙される。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
タグ無し文書は対象外
タグ付き PDF のフォームを PDF/UA-1 へ修復します（Widget を Form へ内包、/Tabs S、/TU）。何度実行しても結果は同じです。タグ無しなら先に ensure_tagged か、作成時の tagged: true です。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つなら preserveSignatures: true（承認署名のみ。認証署名は拒否）。無効になってもよい場合のみ allowBreakingSignatures: true。明示が無ければ無効にしません。
ensure_tagged
Ensure Tagged (PDF/UA scaffold & repair)
既存 PDF を PDF/UA-1 の「器」に載せる。
- 既にタグ付きの文書: 構造木には触らず、欠落した文書レベル要件（MarkInfo・Lang・DisplayDocTitle・XMP の pdfuaid:part / dc:title）だけを補う
- タグ無しの文書: 最小限の構造木（各ページ = 1 つの P 要素）を新設し、本文を支援技術から到達可能にする
重要: 機械は意味を推定できないため、見出し・表・リスト・読み順・図の代替テキストは作られない。新設されるのは「足場」であって「アクセシブルな文書」ではなく、人手のレビューが要る。構造を最初から正しく作れるなら create 系の tagged: true を使うこと。
署名済み PDF には preserveSignatures: true（承認署名のみ。認証署名は拒否）。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
title | string (minLength 1) | 任意 | 文書タイトル(PDF/UA-1 7.1 で必須)。省略時は既存 Info の Title を使う。 | |
lang | string | 任意 | 文書の自然言語(BCP 47。例 "ja")。PDF/UA-1 7.2 で必須。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
書いたのは宣言。適合の証明ではない
XMP に pdfuaid を書きます。適合していない文書に適用すると、適合していないのに適合を名乗った PDF になります。書いたら必ず pdf-verify-mcp の validate_conformance（flavour: "pdfua-1"）で測ってください。測れないなら宣言を書かないでください。
機械は意味を推定できません
新設するのは最小限の構造木（各ページ = 1 つの P 要素）です。見出し・表・リスト・読み順・図の代替テキストは作られません。最初から tagged: true で作れるなら、そちらを使ってください。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
呼び出し例 — 「既存 PDF を PDF/UA-1 の器に載せて」
- 実測: v0.21.0
- 標本:
docs/specimens/selfmade-base.pdf（呼び出すときは絶対パス。既にタグ付き） title:"Selfmade base"lang:"en"
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/selfmade-base.pdf",
"title": "Selfmade base",
"lang": "en",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON
{
"pageCount": 1,
"bytes": 18406,
"path": "/absolute/path/to/output.pdf",
"wasTagged": true,
"createdStructure": false,
"wrappedPages": 0,
"addedRequirements": [
"Lang",
"ViewerPreferences/DisplayDocTitle",
"XMP(pdfuaid:part, dc:title)"
]
}既にタグ付きなので構造木には触らず、欠けていた文書レベル要件だけを補いました。宣言を書いたあとは validate_conformance（flavour: "pdfua-1"）で測ります。
ensure_pdfa
Ensure PDF/A (archival conformance scaffold)
既存 PDF を PDF/A の「器」に載せる（ensure_tagged の PDF/A 版）。
flavour | 名乗らせる内容 |
|---|---|
pdfa-3b | 既定。PDF 1.7 基盤 |
pdfa-4 | PDF 2.0。添付ファイル自身が PDF/A であること |
pdfa-4f | PDF 2.0。CSV / JSON などの非 PDF/A 添付向け |
補うのは文書レベルの欠落要件だけである:
- trailer の /ID（ISO 32000-1 14.4）
- sRGB の OutputIntent（GTS_PDFA1。ICC プロファイルを生成して埋め込む）
- XMP の pdfaid
- -4 系はさらにヘッダを PDF 2.0 にし、Info 辞書を削除する（-4 は catalog に /PieceInfo が無い限り Info を許さない）
本文・構造木・フォントには触らない。添付がある文書は "pdfa-4f" を使うこと。素の "pdfa-4" は添付ファイル自身が PDF/A であることを要求するため、CSV や JSON を添える電帳法の使い方では非適合になる。
重要: これは「PDF/A を名乗るための下準備」であって、適合の保証ではない。フォント未埋め込み・暗号化・JavaScript・LZW などの違反は直らない。XMP に pdfaid を書くことは、その文書が「PDF/A です」と名乗ることと同じで、適合していない文書に適用すると嘘を名乗る PDF ができる（このため適用時は常に警告を返す）。適合したかどうかは pdf-verify-mcp の validate_conformance（flavour: 同じ値）で必ず測ること。判定を下すのは veraPDF である。
運用上の注意:
- 電帳法の文脈では、attach_file で機械可読データを添付した後に適用する
- 署名済み PDF には preserveSignatures: true（承認署名のみ。認証署名は拒否）
- ただし -4 系 × preserveSignatures は、入力が既に PDF 2.0 でない限り拒否する（増分更新では先頭のヘッダを書き換えられず、書き換えれば署名が壊れるため）
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
flavour | "pdfa-3b" | "pdfa-4" | "pdfa-4f" | 任意 | 名乗らせる PDF/A。既定 "pdfa-3b"。上の flavour 表を参照。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
書いたのは宣言。適合の証明ではない
XMP に pdfaid を書きます。フォント未埋め込み・暗号化・JavaScript などは直りません。適合していない文書に適用すると、適合していないのに適合を名乗った PDF になります。書いたら必ず pdf-verify-mcp の validate_conformance で測ってください。flavour にはここに渡したものと同じ文字列を指定します。測れないなら宣言を書かないでください。PDF/A の結果は「veraPDF が COMPLIANT と判定した」までです。
添付があるなら "pdfa-4f"
素の "pdfa-4" は添付ファイル自身が PDF/A であることを要求します（6.9-3）。CSV や JSON を同梱するなら "pdfa-4f" です。PDF/A-4 系はヘッダを PDF 2.0 にし Info 辞書を削除します。preserveSignatures との併用は、入力が既に PDF 2.0 でない限り拒否されます。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
呼び出し例 — 「PDF/A-3b の器に載せて」
- 実測: v0.21.0
- 標本:
docs/specimens/publish-demo.pdf（呼び出すときは絶対パス。既に PDF/A-3b を宣言） flavour:"pdfa-3b"
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/publish-demo.pdf",
"flavour": "pdfa-3b",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON（warnings は要約）
{
"pageCount": 1,
"bytes": 92945,
"path": "/absolute/path/to/output.pdf",
"flavour": "3b",
"addedRequirements": ["XMP pdfaid (part 3, conformance B)"],
"wasDeclared": true,
"warnings": [
"The document already has a trailer /ID; it was left unchanged.",
"The document already declares a GTS_PDFA1 output intent; it was left unchanged.",
"This file now CLAIMS PDF/A-3b (pdfaid:part=3, conformance=B), but conformance was NOT checked here. … Verify before relying on it: pdf-verify-mcp validate_conformance(flavour: \"pdfa-3b\") …"
]
}この warnings は異常ではなく設計です。捨てないでください。合否は veraPDF の validate_conformance です。
attach_file
Attach File (Embedded File)
PDF にファイルを埋め込む(添付する)。/Names /EmbeddedFiles と catalog /AF に登録し、AFRelationship を付与する。PDF/A-3(ISO 19005-3)や電子帳簿保存法の文脈で、「人が読む請求書 PDF + 機械可読データ(CSV/XML)」を 1 ファイルに束ねる用途に使う。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
attachmentPath | string (minLength 1) | 必須 | 埋め込むファイルの絶対パス。 | |
name | string (minLength 1) | 任意 | PDF 内での表示名。省略時は元のファイル名。既存の添付と同名にはできない。 | |
description | string (minLength 1) | 任意 | 添付の説明(/Desc・日本語可)。 | |
mimeType | string (minLength 1) | 任意 | MIME 型。省略時は拡張子から推定(例 .csv → text/csv)。 | |
relationship | "Source" | "Data" | "Alternative" | "Supplement" | "Unspecified" | 任意 | 本文との関係(PDF/A-3 §6.8)。Data=本文と同じ内容の機械可読データ(請求書の XML/CSV 等) / Source=本文の元データ / Alternative=代替表現 / Supplement=補足資料 / Unspecified=不明(既定)。PDF/A-3 では意味のある値が必須のため、省略すると警告する。 | |
preserveSignatures | boolean | 任意 | 署名済み PDF に対し、既存署名を無効化せず増分更新（末尾追記）で編集する。既定 false。元のバイト列には一切触れないため /ByteRange が保たれる。認証署名（DocMDP）の許可レベルに反する変更は拒否される。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
PDF/A-3 では relationship に意味のある値が必須
Source / Data / Alternative / Supplement を渡してください。省略すると警告が返り、値は Unspecified です（ISO 19005-3 §6.8）。
添付があるなら PDF/A-4 は "pdfa-4f"
素の "pdfa-4" は添付ファイル自身が PDF/A であることを要求します。CSV や JSON を同梱するなら ensure_pdfa の flavour は "pdfa-4f" です。電帳法の文脈では添付の後に ensure_pdfa を掛けます。
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
呼び出し例 — 「CSV を Data として埋め込んで」
- 実測: v0.21.0
- 標本:
docs/specimens/selfmade-base.pdf（呼び出すときは絶対パス） - 添付:
docs/specimens/publish-demo-data.csv name:"invoice-data.csv"（既存名と重複するとINVALID_ARGUMENT）relationship:"Data"
パラメータ
{
"inputPath": "/absolute/path/to/docs/specimens/selfmade-base.pdf",
"attachmentPath": "/absolute/path/to/docs/specimens/publish-demo-data.csv",
"name": "invoice-data.csv",
"description": "Machine-readable invoice data",
"relationship": "Data",
"outputPath": "/absolute/path/to/output.pdf"
}返る JSON
{
"pageCount": 1,
"bytes": 19070,
"path": "/absolute/path/to/output.pdf",
"attachment": {
"name": "invoice-data.csv",
"bytes": 114,
"mimeType": "text/csv",
"relationship": "Data"
},
"attachments": ["invoice-data.csv"]
}同じ名前の添付が既にあるファイル（例: publish-demo.pdf の publish-demo-data.csv）では INVALID_ARGUMENT になります。
rotate_pages
Rotate Pages
ページを時計回りに回転する(90/180/270 度)。pages 省略時は全ページ。
引数
| 引数 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
inputPath | string (minLength 1) | 必須 | 対象 PDF の絶対パス。 | |
rotation | 90 | 180 | 270 | 必須 | 時計回りの回転角(度)。90 / 180 / 270。 | |
pages | string (minLength 1) | 任意 | 対象ページ指定。"1,3-5" 形式(1 始まり)。省略時は全ページ。 | |
outputPath | string (minLength 1) | 任意 | 保存先ファイルパス（絶対パス）。省略した場合は base64 文字列を返す。 | |
returnBase64 | boolean | 任意 | true の場合、保存に加えて base64 文字列も結果に含める。 | |
allowBreakingSignatures | boolean | 任意 | 編集対象が電子署名済み(/ByteRange 検知)の場合、既定ではエラーにする。true を指定すると署名が無効化されることを承知の上で編集を続行する。 |
outputPath は必ず渡す
省略すると PDF 全体が base64 で返り、会話が破綻しやすいです。保存先は絶対パスで渡してください。
署名済み PDF は既定でエラー
署名を保つ操作ではありません。無効になってもよい場合のみ allowBreakingSignatures: true を明示してください。明示が無ければ無効にしません。