跳转到内容

PDF Tool

pdf 分析一个或多个 PDF 文档并返回文本。

快速行为:

  • 对 Anthropic 和 Google 模型提供商使用原生提供商模式。
  • 对其他提供商使用提取回退模式(先提取文本,需要时再提取页面图片)。
  • 支持单个(pdf)或多个(pdfs)输入,每次调用最多 10 个 PDF。

仅当 OpenClaw 能为代理解析出 PDF 能力模型配置时,该工具才会注册:

  1. agents.defaults.pdfModel
  2. 回退到 agents.defaults.imageModel
  3. 回退到基于可用认证的最佳推测提供商默认值

如果无法解析出可用模型,pdf 工具不会暴露。

  • pdfstring):单个 PDF 路径或 URL
  • pdfsstring[]):多个 PDF 路径或 URL,总计最多 10 个
  • promptstring):分析提示词,默认 Analyze this PDF document.
  • pagesstring):页面过滤器,如 1-51,3,7-9
  • modelstring):可选模型覆盖(provider/model
  • maxBytesMbnumber):每个 PDF 的大小上限,以 MB 为单位

输入说明:

  • pdfpdfs 在加载前会合并并去重。
  • 如果未提供 PDF 输入,工具会报错。
  • pages 按 1 为基准的页码解析,去重、排序,并限制在配置的最大页数内。
  • maxBytesMb 默认为 agents.defaults.pdfMaxBytesMb10
  • 本地文件路径(包括 ~ 展开)
  • file:// URL
  • http://https:// URL

引用说明:

  • 其他 URI 方案(例如 ftp://)会以 unsupported_pdf_reference 被拒绝。
  • 在沙箱模式下,远程 http(s) URL 会被拒绝。
  • 启用仅工作区文件策略后,允许根目录外的本地文件路径会被拒绝。

原生模式用于提供商 anthropicgoogle。该工具直接将原始 PDF 字节发送到提供商 API。

原生模式限制:

  • 不支持 pages。如果设置了该参数,工具会返回错误。

回退模式用于非原生提供商。

流程:

  1. 从选定页面提取文本(最多 agents.defaults.pdfMaxPages 页,默认 20)。
  2. 如果提取的文本长度低于 200 个字符,将选定页面渲染为 PNG 图片并包含在内。
  3. 将提取的内容加提示词发送到选定模型。

回退详情:

  • 页面图片提取使用 4,000,000 的像素预算。
  • 如果目标模型不支持图片输入且没有可提取的文本,工具会报错。
  • 提取回退需要 pdfjs-dist(和用于图片渲染的 @napi-rs/canvas)。
{
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,回退模式为 false
  • attempts:成功前失败的回退尝试次数

路径字段:

  • 单个 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:

{
"pdf": "/tmp/report.pdf",
"prompt": "Summarize this report in 5 bullets"
}

多个 PDF:

{
"pdfs": ["/tmp/q1.pdf", "/tmp/q2.pdf"],
"prompt": "Compare risks and timeline changes across both documents"
}

按页面过滤的回退模型:

{
"pdf": "https://example.com/report.pdf",
"pages": "1-3,7",
"model": "openai/gpt-5-mini",
"prompt": "Extract only customer-impacting incidents"
}