env.example•2.13 kB
# Universal Document Processor Environment Variables
# Output and cache directories
# ============================================
# OUTPUT_DIR: Controls where all generated files will be saved
# This is the primary directory for all document outputs (PDF, HTML, etc.)
# If not set, defaults to ~/Documents
OUTPUT_DIR=./output
# CACHE_DIR: Directory for temporary and cache files
# If not set, defaults to ~/.cache/doc-ops-mcp
CACHE_DIR=./cache
# PDF Enhancement Features
# ========================================
# WATERMARK_IMAGE: Default watermark image path for PDF files
# This image will be automatically added to all PDF conversions
# Supported formats: PNG, JPG
# If not set, no watermark will be added
WATERMARK_IMAGE=./resources/watermark.png
# QR_CODE_IMAGE: Default QR code image path for PDF files
# This QR code will be added to PDFs only when explicitly requested
# Supported formats: PNG, JPG
# If not set, no QR code will be available
QR_CODE_IMAGE=./resources/qrcode.png
# IMPORTANT: OUTPUT_DIR Environment Variable Usage
# ================================================
# The OUTPUT_DIR environment variable controls where ALL generated files are saved.
# When using the MCP tools:
#
# 1. If outputPath is NOT provided in tool calls:
# - Files will be auto-generated in OUTPUT_DIR with timestamp-based names
# - Example: OUTPUT_DIR/output_1234567890.pdf
#
# 2. If outputPath is a relative path:
# - It will be resolved relative to OUTPUT_DIR
# - Example: outputPath="my-doc.pdf" → OUTPUT_DIR/my-doc.pdf
#
# 3. If outputPath is an absolute path:
# - It will be used as-is, ignoring OUTPUT_DIR
# - Example: outputPath="/Users/john/Desktop/doc.pdf" → /Users/john/Desktop/doc.pdf
#
# This ensures consistent output location management across all document operations.
# Usage Examples
# =========================
# Convert DOCX to PDF with watermark:
# - Set WATERMARK_IMAGE to your watermark file path
# - Use convert_docx_to_pdf tool
#
# Add QR code to existing PDF:
# - Set QR_CODE_IMAGE to your QR code file path
# - Use add_qrcode tool or set addQrCode=true in conversion tools