MCP tools
Complete parameter reference for every tool exposed by the PDFox MCP server.
generate_pdf
Submit a PDF generation job. Returns immediately with a jobId. Use get_job to poll, or use generate_pdf_and_wait to block.
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | required | ID of the template to render |
data | object | required | JSON data to merge with the template |
filename | string | optional | Override the output filename (without .pdf) |
generate_pdf_and_wait
Submit a job and poll until completion, returning the signed downloadUrl directly. Useful when the agent needs the URL in the same turn.
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | required | ID of the template to render |
data | object | required | JSON data to merge with the template |
filename | string | optional | Override the output filename (without .pdf) |
timeoutMs | number | optional | Max wait in ms (default: 60000) |
get_job
Fetch the current status and result of a generation job.
| Parameter | Type | Required | Description |
|---|---|---|---|
jobId | string | required | The job ID returned by generate_pdf |
list_templates
Return all templates visible to the authenticated org. No parameters required.
get_template
Fetch full details for a single template, including its data schema.
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | required | Template ID to fetch |
get_pdf_quota
Return remaining and total credits for the authenticated org. No parameters required.
Agents should call
get_pdf_quota before large batch jobs to avoid mid-batch failures from running out of credits.