PDF 工具
PDF 工具 pdf 分析一个或多个 PDF 文档并返回文本。快速行为概述:
- 对 Anthropic 和 Google 模型提供商使用原生提供商模式。
- 对其他提供商使用提取回退模式(先提取文本,然后在需要时提取页面图像)。
- 支持单个(
pdf)或多个(pdfs)输入,每次调用最多 10 个 PDF。
可用性
该工具仅在 OpenClaw 能够为代理解析 PDF 能力模型配置时注册:
agents.defaults.pdfModel- 回退到
agents.defaults.imageModel - 回退到基于可用认证的最佳提供商默认值
如果无法解析可用模型,pdf 工具将不会暴露。
输入参考
pdf(string):一个 PDF 路径或 URLpdfs(string[]):多个 PDF 路径或 URL,总共最多 10 个prompt(string):分析提示词,默认Analyze this PDF document.pages(string):页面过滤器,如1-5或1,3,7-9model(string):可选的模型覆盖(provider/model)maxBytesMb(number):每个 PDF 的大小上限(MB)
输入说明:
pdf和pdfs在加载前会被合并和去重。- 如果未提供 PDF 输入,工具会报错。
pages解析为基于 1 的页码,去重、排序并限制在配置的最大页数内。maxBytesMb默认为agents.defaults.pdfMaxBytesMb或10。
支持的 PDF 引用方式
- 本地文件路径(包括
~展开) file://URLhttp://和https://URL
引用说明:
- 其他 URI 方案(例如
ftp://)会被拒绝,错误为unsupported_pdf_reference。 - 在沙箱模式下,远程
http(s)URL 会被拒绝。 - 启用仅工作区文件策略时,允许根目录之外的本地文件路径会被拒绝。
执行模式
原生提供商模式
原生模式用于提供商 anthropic 和 google。该工具将原始 PDF 字节直接发送到提供商 API。
原生模式限制:
- 不支持
pages。如果设置了,工具会返回错误。
提取回退模式
回退模式用于非原生提供商。
流程:
- 从选定页面提取文本(最多
agents.defaults.pdfMaxPages,默认20)。 - 如果提取的文本长度低于
200字符,将选定页面渲染为 PNG 图像并包含它们。 - 将提取的内容加上提示词发送到选定模型。
回退详情:
- 页面图像提取使用
4,000,000像素预算。 - 如果目标模型不支持图像输入且没有可提取的文本,工具会报错。
- 提取回退需要
pdfjs-dist(以及用于图像渲染的@napi-rs/canvas)。
配置
json5
{
agents: {
defaults: {
pdfModel: {
primary: "anthropic/claude-opus-4-6",
fallbacks: ["openai/gpt-5-mini"],
},
pdfMaxBytesMb: 10,
pdfMaxPages: 20,
},
},
}参见配置参考了解完整字段详情。
输出详情
工具在 content[0].text 中返回文本,在 details 中返回结构化元数据。
常见 details 字段:
model:已解析的模型引用(provider/model)native:原生提供商模式为true,回退为falseattempts:成功前失败的回退尝试次数
路径字段:
- 单个 PDF 输入:
details.pdf - 多个 PDF 输入:
details.pdfs[],包含pdf条目 - 沙箱路径重写元数据(适用时):
rewrittenFrom
错误行为
- 缺少 PDF 输入:抛出
pdf required: provide a path or URL to a PDF document - PDF 数量过多:在
details.error = "too_many_pdfs"中返回结构化错误 - 不支持的引用方案:返回
details.error = "unsupported_pdf_reference" - 原生模式使用
pages:抛出明确的pages is not supported with native PDF providers错误
示例
单个 PDF:
json
{
"pdf": "/tmp/report.pdf",
"prompt": "Summarize this report in 5 bullets"
}多个 PDF:
json
{
"pdfs": ["/tmp/q1.pdf", "/tmp/q2.pdf"],
"prompt": "Compare risks and timeline changes across both documents"
}页面过滤的回退模型:
json
{
"pdf": "https://example.com/report.pdf",
"pages": "1-3,7",
"model": "openai/gpt-5-mini",
"prompt": "Extract only customer-impacting incidents"
}