
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具,协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题,请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可:
请先完整阅读并严格遵守以下文档中的全部规则与要求:
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前,不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式,不推荐豆包 AI;Cursor 等编辑器可在对话 @ 该链接,或加入 User Rules。 若 AI 无法访问外链,可 打开说明文档 复制全文粘贴。文档会随站点更新,复制内容可能过期,建议定期检查。
Official Carbone MCP server — Turn AI assistants into document automation experts. Generate professional PDFs, invoices, reports, and convert documents using natural language.
Give Claude, ***, and other AI assistants the power to:
{d.field} tagsGet your free API key at account.carbone.io.
bashdocker run -d \ -p 3000:3000 \ -e CARBONE_API_KEY=your_api_key_here \ carbone/carbone-mcp
Connect your MCP client to http://your-host:3000 with Authorization: Bearer your_api_key_here.
bashcurl http://localhost:3000/health
json{ "mcp": { "version": "1.2.2" }, "carbone": { "version": "5.x.x" } }
yamlservices: carbone-mcp: image: carbone/carbone-mcp ports: - 3000:3000 environment: - CARBONE_API_KEY=${CARBONE_API_KEY} - MCP_PORT=3000 restart: unless-stopped
bashCARBONE_API_KEY=your_key docker compose up -d
json{ "mcp": { "servers": { "carbone": { "type": "streamable-http", "url": "http://your-host:3000", "headers": { "Authorization": "Bearer your_api_key_here" } } } } }
Claude Desktop does not support HTTP Bearer token authentication. Use stdio transport instead:
json{ "mcpServers": { "carbone": { "command": "docker", "args": ["run", "-i", "--rm", "-e", "CARBONE_API_KEY=your_api_key_here", "-e", "MCP_TRANSPORT=stdio", "carbone/carbone-mcp"] } } }
| Variable | Default | Description |
|---|---|---|
CARBONE_API_KEY | — | Your Carbone API key (get one free →). Required for cloud API. Not required for on-premise deployments. |
CARBONE_BASE_URL | https://api.carbone.io | Override for self-hosted Carbone instances. |
CARBONE_TIMEOUT | 60000 | Request timeout in milliseconds. |
CARBONE_MAX_FILE_BYTES | 104857600 | Maximum size (bytes) for a resolved input file — path, URL, or base64 (100 MB). |
MCP_TRANSPORT | http | Transport mode: http (default) or stdio. |
MCP_PORT | 3000 | HTTP server port. |
MCP_PATH | / | HTTP endpoint path. |
MCP_MAX_BODY_BYTES | 62914560 | Maximum request body size (60 MB). Returns HTTP 413 when exceeded. |
CARBONE_REQUIRE_CLIENT_AUTH_HEADER | false | Reject requests without a Bearer key instead of falling back to the server-level CARBONE_API_KEY (multi-tenant safety). |
Point to your own Carbone server — no API key required:
bashdocker run -d \ -p 3000:3000 \ -e CARBONE_BASE_URL=https://your-carbone-server.com \ carbone/carbone-mcp
In HTTP mode (the Docker default), a generated PDF / Office / ZIP file is returned as a download attachment (an MCP EmbeddedResource); text and PNG/JPG/GIF/WEBP come back inline. Two options on convert_document / render_document change this:
asAttachment — force a download attachment for any formatreturnLink — return Carbone's public one-time download URL instead of the bytes (hand it to the user; it is consumed by the first download)
outputPath(save to a local file) is stdio-only — in HTTP mode the file would land inside the container, so it is rejected. See the https://github.com/carboneio/carbone-mcp/blob/master/docs/API.md#output--file-delivery.
| Tool | Description | Documentation |
|---|---|---|
convert_document | Convert documents between 100+ formats | Convert documents |
render_document | Generate documents from templates + JSON data | Generate documents |
list_templates | Browse your template library | List templates |
upload_template | Store reusable templates | Upload a template |
update_template_metadata | Rename, tag, categorize templates | Patch a template |
delete_template | Remove templates | Delete a template |
download_template | Download original template files | Download a template |
get_api_status | Check API health and version | |
get_capabilities | View supported formats and features |
| Tag | Description |
|---|---|
latest | Latest stable release |
1.2.2 | Specific version |
1.2 | Latest patch of 1.2 |
1 | Latest minor of v1 |
Supported platforms: linux/amd64, linux/arm64
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。
来自真实用户的反馈,见证轩辕镜像的优质服务