1.0.1 • Published 8 months ago

@mcpflow.io/mcp-markdown2pdf-mcp-server-markdown2pdf-mcp v1.0.1

Weekly downloads
-
License
未指定
Repository
-
Last release
8 months ago

Markdown2PDF MCP Server (markdown2pdf-mcp)

此包由 MCPFlow 打包并发布到npm仓库。

用于将 Markdown 转换为 PDF 的 MCP 服务器

安装与使用

直接使用npx运行:

npx @mcpflow.io/mcp-markdown2pdf-mcp-server-markdown2pdf-mcp

或者先安装后使用:

# 安装
npm install @mcpflow.io/mcp-markdown2pdf-mcp-server-markdown2pdf-mcp

# 使用
npx @mcpflow.io/mcp-markdown2pdf-mcp-server-markdown2pdf-mcp

使用方法

Installation

## 工具函数

### setupToolHandlers

Sets up the tool handlers for the MarkdownPdfServer class.

**参数:**

- `requestSchema`: The request schema for the tool.

### getIncrementalPath

Generates an incremental path for a given base path if the file already exists.

**参数:**

- `basePath`: The base path of the file.

### convertToPdf

Converts markdown content to a PDF file.

**参数:**

- `markdown`: The markdown content to convert.
- `watermark`: The watermark text for the PDF.
- `outputPath`: The output path for the PDF file.
- `paperBorder`: The border margin for the PDF.
- `paperFormat`: The paper format for the PDF.
- `paperOrientation`: The paper orientation for the PDF.

### run

Starts the MarkdownPdfServer and connects it to a StdioServerTransport.

**参数:**




## 原始信息

- **开发者:** 2b3pro
- **版本:** 1.0.0
- **许可证:** 未指定
- **原始仓库:** [2b3pro/markdown2pdf-mcp](https://github.com/2b3pro/markdown2pdf-mcp)

## 原始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](https://github.com/alanshaw/markdown-pdf).

## 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
- 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

## Installation

```bash
# 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 build

Usage

Starting the Server

npm start

Using the MCP Tool

The server provides a single tool create_pdf_from_markdown 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)
}

Example with options:

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 minimal usage:

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",
  },
});

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": "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

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 start

License

MIT

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request
1.0.1

8 months ago

1.0.0

8 months ago