内容
# @rendoc/mcp-server
[](https://www.npmjs.com/package/@rendoc/mcp-server)
[](https://opensource.org/licenses/MIT)
[](https://github.com/yoryocoruxo-ai/rendoc-mcp-server/actions/workflows/ci.yml)
<a href="https://glama.ai/mcp/servers/@yoryocoruxo-ai/rendoc-mcp-server">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@yoryocoruxo-ai/rendoc-mcp-server/badge" alt="rendoc MCP 服务器" />
</a>
**rendoc MCP 服务器**允许 **Claude Desktop**、**Cursor** 和其他任何 MCP 兼容的客户端按需生成专业的 PDF 文档。 将您的 AI 连接到 rendoc,它可以创建 **发票**、**合同**、**报告**、**证书** 和任何其他 PDF — 从可重用的模板或内联 HTML/Handlebars 标记 — 所有这些都来自自然语言提示。
> 将 *"为 Acme Corp 生成发票,40 小时咨询,€85/小时"* 转换为几秒钟内交付的 PDF。
## 用例
| 用例 | 示例提示 |
|----------|----------------|
| **发票** | *"为客户 X 生成发票,包含以下行项目..."* |
| **合同** | *"为 TechStart SL 起草一份自由职业合同,费用 18,000 欧元,首付 50%..."* |
| **证书** | *"为 María González 颁发课程完成证书..."* |
| **报告** | *"创建 2026 年 3 月销售报告,包含以下 KPI..."* |
| **批量生成** | *"为 CSV 中的所有 50 名与会者生成证书"* |
| **自定义文档** | 您可以用 HTML + 数据描述的任何内容 |
在 [**`examples/`**](./examples/) 中查看详细的操作指南。
## 功能
- **7 种工具** 用于文档生成、模板管理和使用跟踪
- **基于模板或内联** — 保存可重用的模板或直接传递标记
- **Handlebars 语法** — 在标记中使用 `{{variables}}`、`{{#each}}`、`{{#if}}`
- **多种纸张尺寸** — A4、Letter、Legal、A3、A5、纵向或横向
- **模式验证** — 模板可以声明 JSON 模式,以便 AI 无法传递无效数据
- **零配置** — 只需设置 `RENDOC_API_KEY` 即可
- **轻量级** — 解压后约 35 KB,纯 TypeScript,只有 2 个运行时依赖
- **在 [Glama](https://glama.ai/mcp/servers/@yoryocoruxo-ai/rendoc-mcp-server) 上验证** — 安全、质量和许可证检查已通过
## Claude Desktop 快速设置
在您的 Claude Desktop 配置文件 (`claude_desktop_config.json`) 中添加以下内容:
```json
{
"mcpServers": {
"rendoc": {
"command": "npx",
"args": ["-y", "@rendoc/mcp-server"],
"env": {
"RENDOC_API_KEY": "您的 API 密钥"
}
}
}
}
```
重启 Claude Desktop。rendoc 工具将出现在 MCP 工具菜单中。
## Claude Code 快速设置
在您的项目或全局设置 (`claude/settings.json`) 中添加以下内容:
```json
{
"mcpServers": {
"rendoc": {
"command": "npx",
"args": ["-y", "@rendoc/mcp-server"],
"env": {
"RENDOC_API_KEY": "您的 API 密钥"
}
}
}
}
```
## Cursor 快速设置
添加到 `~/.cursor/mcp.json`(或您的项目的 `.cursor/mcp.json`):
```json
{
"mcpServers": {
"rendoc": {
"command": "npx",
"args": ["-y", "@rendoc/mcp-server"],
"env": {
"RENDOC_API_KEY": "您的 API 密钥"
}
}
}
}
```
## 可用工具
| 工具 | 描述 | 关键参数 |
|------|-------------|----------------|
| `generate_document` | 从模板或内联标记生成 PDF | `template_id` 或 `markup`,`data`,`paper_size?`,`orientation?`,`filename?` |
| `list_templates` | 列出可用的文档模板 | `category?` |
| `preview_template` | 检查模板的标记、样式和模式 | `template_id` |
| `create_template` | 创建新的可重用模板 | `name`,`slug`,`markup`,`schema`,`category?`,`styles?`,`sample_data?`,`paper_size?`,`orientation?`,`is_public?` |
| `delete_template` | 删除模板 ID | `template_id` |
| `get_document` | 获取生成的文档的详细信息 | `document_id` |
| `get_usage` | 查看每月 API 使用情况统计 | _(无)_ |
每个工具都返回结构化的 JSON,其中包含下载 URL、文档 ID 和元数据,供助手操作。
## 获取 API 密钥
1. 在 [rendoc.dev](https://rendoc.dev) 注册
2. 进入 [API 密钥仪表盘](https://rendoc.dev/dashboard/api-keys)
3. 创建新的密钥并将其复制到您的 MCP 客户端配置中
## 环境变量
| 变量 | 必需 | 默认值 | 描述 |
|----------|----------|---------|-------------|
| `RENDOC_API_KEY` | 是 | — | 您的 rendoc API 密钥,用于身份验证 |
| `RENDOC_API_URL` | 否 | `https://rendoc.dev` | rendoc API 的基本 URL(适用于自托管实例) |
## 示例
详细的操作指南,包含真实的提示和工具调用:
- [**01 — 内联标记发票**](./examples/01-invoice.md) — 单次发票生成
- [**02 — 自由职业合同模板**](./examples/02-contract.md) — 创建一次,重用多次
- [**03 — 从保存的模板生成证书**](./examples/03-certificate.md) — 多步骤工具发现
- [**04 — 每月销售报告**](./examples/04-monthly-report.md) — 使用 CSS 进行丰富的可视化
- [**05 — 从数据集批量生成**](./examples/05-bulk-generation.md) — 一个提示生成 50 个 PDF
## 工作原理
```
┌──────────────┐ MCP/stdio ┌────────────────────┐ HTTPS ┌─────────────┐
│ Claude Code │ ─────────────▶ │ @rendoc/mcp-server │ ────────▶ │ rendoc API │
│ / Desktop │ │ (此软件包) │ │ (PDF 生成) │
└──────────────┘ ◀───────────── └────────────────────┘ ◀──────── └─────────────┘
▲ 工具结果 下载 URL
│
└── 用户提示:"为... 生成发票..."
```
MCP 服务器将 AI 助手的自然语言工具调用转换为对 rendoc API 的身份验证 REST 请求,并返回包含 PDF 下载 URL 的结构化响应。
## 贡献
欢迎贡献。请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md) 以获取开发设置和 PR 指南。
有关安全问题,请参阅 [SECURITY.md](./SECURITY.md) 并发送电子邮件至 `info@rendoc.dev` — 请勿公开问题。
## 链接
- **网站**:[rendoc.dev](https://rendoc.dev)
- **文档**:[rendoc.dev/docs](https://rendoc.dev/docs)
- **npm 软件包**:[`@rendoc/mcp-server`](https://www.npmjs.com/package/@rendoc/mcp-server)
- **Glama 列表**:[glama.ai/mcp/servers/@yoryocoruxo-ai/rendoc-mcp-server](https://glama.ai/mcp/servers/@yoryocoruxo-ai/rendoc-mcp-server)
- **官方 SDK**:[`@rendoc/sdk` (TypeScript)](https://www.npmjs.com/package/@rendoc/sdk),[`rendoc` (Python)](https://pypi.org/project/rendoc/)
## 许可证
MIT — 请参阅 [LICENSE](./LICENSE)。