Markdown2PDF MCP 服务器(markdown2pdf-mcp)
一个用于将Markdown文档转换为PDF文件的MCP服务器。该服务器提供了一种简单高效的方法,可以从Markdown内容生成PDF文件,支持语法高亮、自定义样式、可选的页码以及灵活的水印位置设置(仅首页或所有页面)。
受艾伦·肖的启发 markdown-pdf(将Markdown转换为PDF)。
特点/功能
- 使用单个命令将Markdown转换为PDF
- 代码块的语法高亮
- 为PDF输出定制CSS样式
- 支持标准Markdown格式
- 美人鱼图渲染
- 使用Chrome渲染引擎生成现代PDF
- 对现代网页功能和字体提供出色支持
- 可靠的资源加载和渲染
- 通过PDF页脚显示的可选页码
- 可配置范围(首页或所有页面)的水印
局限性
以下Markdown元素不受支持:
- LaTeX 数学公式(例如。,
$x^2$或者$$\sum_{i=1}^n x_i$$) - 复杂的数学公式或科学记数法
请仅使用以下支持的Markdown元素:
- 标题(所有级别)
- 文本格式化(加粗、斜体、删除线)
- 列表(有序列表和无序列表)
- 带有语法高亮的代码块
- 桌子
- 引用块
- 链接
- 图像(包括本地文件和外部URL)
- 任务列表
- 美人鱼图(或称为“泳道图”)
美人鱼图(或称为泳道图)
要渲染一个Mermaid图表,请使用一个 mermaid 代码块:
```markdown```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
\`
如果您的图表中存在语法错误,错误信息将会显示在PDF中,帮助您进行调试。
## (从源代码)安装```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
安装(通过 npm)```bash
npm install markdown2pdf-mcp
## 使用方法
### 启动服务器```bash
npm start
使用MCP工具
服务器提供了一个单一工具 create_pdf_from_markdown 具有以下参数:```typescript
{
// 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)
watermarkScope?: 'all-pages' | 'first-page'; // Defaults to 'all-pages'
showPageNumbers?: boolean; // Defaults to false
}
带选项的示例:```typescript
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",
watermarkScope: "first-page",
showPageNumbers: true,
},
});
最小化使用示例:```typescript
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",
},
});
## 按需运行,与……一起 `npx`
你可以通过请求在不进行永久本地安装的情况下运行服务器 `npx` 获取最新包并执行其入口点:```bash
npx -y markdown2pdf-mcp@latest
此命令将包安装到临时工作区,然后通过其自带的命令行界面(CLI)启动MCP服务器。将您的MCP客户端(例如Cline或Claude Desktop)指向此命令,以便按需启动服务器。
配置
输出目录
您可以在MCP设置文件中配置输出目录,以适用于使用MCP的应用程序,如Cline或Claude。如果未进行配置,文件将保存到$HOME目录:```json
{
"mcpServers": {
"markdown2pdf": {
"args": ["/path/to/markdown2pdf-mcp/build/index.js"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory"
}
}
}
}
该工具通过自动添加递增数字(例如,output.pdf、output-1.pdf、output-2.pdf)来处理文件名冲突。
### 大文件支持
该工具可自动处理大型Markdown文件,具有以下功能:
- **动态超时**根据内容大小自动调整(对于非常大的文件,最多可能需要5分钟)
- **内存限制**为Chrome分配4GB内存以处理复杂文档
- **尺寸验证**最大文件大小为10MB,并附有清晰的错误信息
- **进度跟踪**显示内容大小和预估处理时间
对于非常大的文件(1300行以上),该工具将:
1. 提醒您处理时间可能会延长
1. 自动增加超时时间
1. 在响应中显示内容大小
1. 如果处理失败,请提供详细的错误信息
### 冗长的日志记录
启用详细日志记录以进行调试:```json
{
"mcpServers": {
"markdown2pdf": {
"command": "node",
"args": ["/path/to/markdown2pdf-mcp/build/index.js"],
"env": {
"M2P_OUTPUT_DIR": "/path/to/output/directory",
"M2P_VERBOSE": "true"
}
}
}
}
这将在标准错误输出(stderr)中记录处理步骤,同时不会干扰MCP通信。
> 更喜欢本地构建的版本?那就切换吧 "command" 回到 node 并且指出 "args" 编译后的 build/index.js 使用路径而不是使用(其他方法/功能) npx例如: "args": ["/path/to/markdown2pdf-mcp/build/index.js"]。
依赖项
- 显著的;惊人的 - Markdown 解析器
- highlight.js(一个用于代码高亮的JavaScript库) - 语法高亮
- Puppeteer(操控木偶者/浏览器自动化工具) - 使用现代技术生成PDF 用于测试的Chrome (v131.0.6778.204)
Chrome 版本
此软件包使用Chrome v131.0.6778.204版本,以确保所有安装环境下的PDF生成一致性。此版本将在您运行时自动安装 npm install.
- 临时文件(或临时目录) - 临时文件处理
发展```bash
Build the project
npm run build
Start the server
npm start
```
许可证
麻省理工学院(MIT)
做出贡献
- 为仓库创建分支(或“克隆仓库”)
- 创建你的特性分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推送到分支(
git push origin feature/amazing-feature) - 提交一个拉取请求
