快速开始

PP Typeset 将 Markdown 文本转换为专业排版的 PDF 或 HTML 文档，底层使用 Pandoc + XeLaTeX 引擎，完整支持中文、数学公式、表格和代码高亮。

MCP — AI Agent 接入

三行 JSON 配置，让 AI 帮你自动完成排版。无需管理密钥，登录授权一次即可。

REST API — 程序化调用

在控制台创建 API Key，发送 POST 请求提交任务，轮询获取结果。

以 MCP 为例——两步上手

准备 Markdown 文档

按标准 Markdown 语法写好内容，支持 GFM 扩展、LaTeX 公式和 BibTeX 参考文献。

content.md

# 论文标题

## 摘要

这是论文的摘要部分，简短概括研究内容。

## 引言

正文内容支持 **粗体**、*斜体* 和 `行内代码`。

- 列表项一
- 列表项二

> 这里是一段引用文字。

```python
def main():
    print("Hello, PP Typeset!")
```

## 结论

使用 Pandoc + XeLaTeX 引擎获得专业排版结果。

配置 MCP 服务器

在 Claude Desktop、Cursor 等 AI 平台的配置文件中添加以下内容，首次连接会自动弹出登录页面完成授权。

或一键安装（自动适配 Claude Code / Codex / WorkBuddy / Cursor）：

Terminal

npx pp-typeset-mcp

需要 Node.js 环境。自动检测已安装的智能体并写入配置。

配置完成后，在对话中直接说：

「帮我把上面的文档排成学术论文格式，导出 PDF」

创建 API Key 浏览模板

MCP 接入

MCP（Model Context Protocol）是 AI Agent 调用外部工具的标准协议。配置后 AI 可直接提交排版任务、查询进度、获取下载链接，无需手动操作界面。

配置文件

claude_desktop_config.json

{
  "mcpServers": {
    "PP-Typeset": {
      "type": "streamableHttp",
      "url": "https://pptypeset.frostrain.tech/mcp"
    }
  }
}

无需手动管理 API Key。首次连接时浏览器自动弹出登录页面，授权一次后 Token 自动续期。

示例指令

「帮我把这份会议纪要排成商务报告格式」

「有哪些模板？我的论文适合哪个？」

「帮我排版，并查一下上个任务好了没有」

「图片和表格怎么写？给我看格式规范」

可用工具

工具	说明
`typeset_document`	提交 Markdown，生成 PDF/HTML。支持图片、表格、公式、代码块、参考文献。
`check_document_status`	查询任务状态，完成后返回下载链接。
`list_templates`	列出所有可用模板及适用场景。
`get_content_guide`	返回 Markdown 格式规范，帮助 AI 写出符合排版要求的内容。

REST API

在控制台 → API Keys 创建密钥，通过 HTTP 请求调用排版服务。

提交排版任务

POST /api/v1/typeset

POST https://pptypeset.frostrain.tech/api/v1/typeset
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

{
  "content": "# 标题\n\n正文内容。",
  "format": "markdown",
  "template": "academic",
  "output": "pdf",
  "title": "我的文档"
}

参数	类型	说明	必填
`content`	string	Markdown 或 HTML 正文	✓
`format`	string	`markdown` / `html`	✓
`template`	string	academic / business / technical / minimal
`output`	string	pdf（默认）/ html
`title`	string	文档标题

response.json

{ "jobId": "abc123", "status": "pending" }

查询任务状态

GET /api/v1/documents/{jobId}

GET https://pptypeset.frostrain.tech/api/v1/documents/{jobId}
Authorization: Bearer <YOUR_API_KEY>

状态流转： pending → processing → completed.
完成后响应包含 downloadUrl，有效期取决于计划（Free 7 天 / Pro 30 天 / Enterprise 180 天）。

模板

通过 template 参数指定，默认为 academic.

academic

学术论文

首行缩进 2 字符，页眉显示标题，规范参考文献格式。适合毕业论文、研究报告、期刊投稿。

business

商务报告

自动生成目录，现代版式，表格美观。适合商业计划书、项目汇报、市场分析。

technical

技术文档

代码语法高亮，紧凑排版，等宽字体标注。适合 API 文档、开发手册、系统设计说明。

minimal

简约文章

大标题，舒适行距，留白充足。适合博客文章、散文、个人笔记。

常见问题

MCP 和 REST API 有什么区别？

MCP 是给 AI Agent 用的——它帮你完成整个排版流程，你只需对话。REST API 是给开发者用的，需要自己写代码调用。不写代码的用户推荐 MCP。

MCP 怎么认证？

首次连接自动弹出浏览器，用 PP Typeset 账号登录授权。授权后 Token 静默续期，无需重复操作。

排版需要多久？

通常 5–30 秒，取决于文档长度和当前队列。Pro/Enterprise 用户享有更高处理优先级。

支持哪些 Markdown 扩展？

支持 GFM（表格、任务列表、删除线）、LaTeX 公式行内与块级、脚注、交叉引用、参考文献（BibTeX）。

图片怎么处理？

在 Markdown 中使用公开 URL 引用图片。API 调用时也可在请求体中附带 base64 编码的图片。

文件保留多久？

Free 7 天，Pro 30 天，Enterprise 180 天。下载链接在保留期内始终有效。