@99xio/markdown2pdf-mcp
v2.2.0
Published
MCP server for converting markdown to PDF - run with npx markdown2pdf-mcp to start the server
Downloads
51
Maintainers
Readme
Markdown2PDF MCP Server (markdown2pdf-mcp)
An MCP server for converting Markdown documents to PDF files. This server provides a simple and efficient way to generate PDFs from Markdown content with support for syntax highlighting and custom styling. Also allows for watermarking on page 1.
Inspired by Alan Shaw's markdown-pdf.
Quick Start
Package: @99xio/[email protected]
Install and run:
npx @99xio/markdown2pdf-mcpMCP Configuration:
{
"mcpServers": {
"markdown2pdf": {
"command": "npx",
"args": ["@99xio/markdown2pdf-mcp"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}Features
- Convert Markdown to PDF with a single command
- Syntax highlighting for code blocks
- Custom CSS styling for PDF output
- Support for standard Markdown formatting
- Mermaid diagram rendering
- Modern PDF generation using Chrome's rendering engine
- Excellent support for modern web features and fonts
- Reliable resource loading and rendering
Limitations
The following markdown elements are not supported:
- LaTeX math equations (e.g.,
$x^2$or$$\sum_{i=1}^n x_i$$) - Complex mathematical formulas or scientific notation
Stick to these supported markdown elements:
- Headers (all levels)
- Text formatting (bold, italic, strikethrough)
- Lists (ordered and unordered)
- Code blocks with syntax highlighting
- Tables
- Blockquotes
- Links
- Images (both local files and external URLs)
- Task lists
- Mermaid diagrams
Mermaid Diagrams
To render a Mermaid diagram, use a mermaid code block:
´´´markdown
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;´´´
If there is a syntax error in your diagram, the error message will be rendered in the PDF, helping you to debug it.
Installation (from source)
# Clone the repository
git clone https://github.com/2b3pro/markdown2pdf-mcp.git
# Navigate to the project directory
cd markdown2pdf-mcp
# Install dependencies
npm install
# Build the project
npm run buildInstallation (via npm)
# Install globally
npm install -g @99xio/markdown2pdf-mcp
# Or use with npx (no installation needed)
npx @99xio/markdown2pdf-mcpUsage
Starting the Server
# Using npx (recommended)
npx @99xio/markdown2pdf-mcp
# Or if installed globally
@99xio/markdown2pdf-mcp
# Or from source
npm startUsing the MCP Tools
The server provides two tools for converting markdown to PDF:
1. create_pdf_from_markdown
Convert markdown content directly to PDF with the following parameters:
{
// Required parameters
markdown: string; // Markdown content to convert
// Optional parameters with defaults
outputFilename?: string; // Filename for the PDF (e.g., "output.pdf")
paperFormat?: string; // 'letter' (default), 'a4', 'a3', 'a5', 'legal', 'tabloid'
paperOrientation?: string; // 'portrait' (default), 'landscape'
paperBorder?: string; // '2cm' (default), accepts decimal values with CSS units (e.g., '1.5cm', '2.5mm', '0.5in', '10.5px')
watermark?: string; // Optional watermark text (max 15 characters, uppercase)
}2. create_pdf_from_markdown_file
Convert a markdown file to PDF by providing the file path with the following parameters:
{
// Required parameters
filePath: string; // Path to the markdown file to convert
// Optional parameters with defaults
outputFilename?: string; // Filename for the PDF (e.g., "output.pdf")
paperFormat?: string; // 'letter' (default), 'a4', 'a3', 'a5', 'legal', 'tabloid'
paperOrientation?: string; // 'portrait' (default), 'landscape'
paperBorder?: string; // '2cm' (default), accepts decimal values with CSS units (e.g., '1.5cm', '2.5mm', '0.5in', '10.5px')
watermark?: string; // Optional watermark text (max 15 characters, uppercase)
}Examples
Example with create_pdf_from_markdown (direct content):
await use_mcp_tool({
server_name: "markdown2pdf",
tool_name: "create_pdf_from_markdown",
arguments: {
markdown: "# Hello World\n\nThis is a test document.",
outputFilename: "output.pdf",
paperFormat: "a4",
paperOrientation: "landscape",
paperBorder: "1.5cm",
watermark: "DRAFT",
},
});Example with create_pdf_from_markdown_file (from file):
await use_mcp_tool({
server_name: "markdown2pdf",
tool_name: "create_pdf_from_markdown_file",
arguments: {
filePath: "/path/to/your/document.md",
outputFilename: "output.pdf",
paperFormat: "a4",
paperOrientation: "landscape",
paperBorder: "1.5cm",
watermark: "DRAFT",
},
});Example minimal usage (direct content):
await use_mcp_tool({
server_name: "markdown2pdf",
tool_name: "create_pdf_from_markdown",
arguments: {
markdown: "# Hello World\n\nThis is a test document.",
outputFilename: "output.pdf",
},
});Example minimal usage (from file):
await use_mcp_tool({
server_name: "markdown2pdf",
tool_name: "create_pdf_from_markdown_file",
arguments: {
filePath: "/path/to/your/document.md",
},
});Configuration
Output Directory
You can configure the output directory in your MCP settings file for apps that use MCP such as Cline or Claude. If not configured, it will save files to $HOME:
{
"mcpServers": {
"markdown2pdf": {
"command": "npx",
"args": ["@99xio/[email protected]"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}Alternative configurations:
Using latest version:
{
"mcpServers": {
"markdown2pdf": {
"command": "npx",
"args": ["@99xio/markdown2pdf-mcp"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}Using global installation:
{
"mcpServers": {
"markdown2pdf": {
"command": "@99xio/markdown2pdf-mcp",
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}Using local build (from source):
{
"mcpServers": {
"markdown2pdf": {
"command": "node",
"args": ["/path/to/markdown2pdf-mcp/build/index.js"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}The tool automatically handles file name conflicts by appending incremental numbers (e.g., output.pdf, output-1.pdf, output-2.pdf).
Dependencies
- @modelcontextprotocol/sdk - MCP SDK for server implementation
- remarkable - Markdown parser
- highlight.js - Syntax highlighting
- puppeteer - Modern PDF generation using Chrome for Testing (v131.0.6778.204)
Chrome Version
This package uses Chrome v131.0.6778.204 for consistent PDF generation across all installations. This version is automatically installed when you run npm install.
- tmp - Temporary file handling
Development
# Build the project
npm run build
# Start the server
npm startPublishing
This package uses automated publishing via GitHub Actions. To publish a new version:
Update the version in
package.json:npm version patch # for bug fixes npm version minor # for new features npm version major # for breaking changesCreate and push a version tag:
git push origin main git push origin --tagsThe GitHub Action will automatically:
- Build the project
- Run tests
- Verify build output
- Publish to npm
- Generate a release summary
Manual Publishing
If you need to publish manually:
# Make sure you're logged in to npm
npm login
# Build and publish
npm run build
npm publishNPM Token Setup
For automated publishing, you need to set up an NPM_TOKEN secret in your GitHub repository:
- Go to npmjs.com and create an access token
- In your GitHub repository, go to Settings → Secrets and variables → Actions
- Add a new secret named
NPM_TOKENwith your npm access token
License
MIT
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
