Install
openclaw skills install @alinklab/read-pdfopenclaw skills install @alinklab/read-pdf一个支持AI助手读取和分析PDF文件的MCP服务器,提供PDF元数据提取、页面范围阅读和关键词搜索等功能。
此 Skill 必须配置 API 密钥才能使用。
.env 中没有 XBY_APIKEY,必须使用 AskUserQuestion 工具向用户询问 API 密钥scripts.config.set_api_key(api_key) 保存,然后继续处理你(大模型)是路由层,负责理解用户意图、选择工具、提取参数。代码只负责调用API。
用户输入 → 你选择工具 → 提取该工具需要的参数 → 调用 scripts.tools 中的函数 → 返回结果给用户
scripts.config.settings.api_key 为空,使用 AskUserQuestion 询问用户,拿到后调用 scripts.config.set_api_key(key) 保存scripts.tools 中的函数,例如 scripts.tools.search_schools(score='520', province='北京', category='综合')raw 数据整理后展示给用户根据用户意图选择对应的工具函数:
| 用户意图 | 工具函数 |
|---|---|
| Read and extract text content from a PDF file. Returns the full text content and metadata. | scripts.tools.read_pdf |
| Read a specific page or range of pages from a PDF file. | scripts.tools.read_pdf_page |
| Get metadata information from a PDF file without reading all content. | scripts.tools.get_pdf_metadata |
| Search for specific text within a PDF file. | scripts.tools.search_pdf |
如果参数不完整,使用 AskUserQuestion 向用户询问缺失的参数。
工具描述:Read and extract text content from a PDF file. Returns the full text content and metadata.
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| path | string | true | Absolute or relative path to the PDF file, or a URL (http:// or https://) |
工具描述:Read a specific page or range of pages from a PDF file.
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| path | string | true | Absolute or relative path to the PDF file, or a URL (http:// or https://) | |
| page | number | false | Page number to read (1-indexed) | |
| startPage | number | false | Start page for range (1-indexed) | |
| endPage | number | false | End page for range (1-indexed) |
工具描述:Get metadata information from a PDF file without reading all content.
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| path | string | true | Absolute or relative path to the PDF file, or a URL (http:// or https://) |
工具描述:Search for specific text within a PDF file.
| 参数名称 | 参数类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
| path | string | true | Absolute or relative path to the PDF file, or a URL (http:// or https://) | |
| query | string | true | Text to search for | |
| caseSensitive | boolean | false | false | Whether search should be case-sensitive |
工具函数返回 dict 对象:
result["raw"] - API 原始返回数据(JSON),直接将此数据整理后展示给用户result["success"] - 是否成功(True/False)result["message"] - 状态消息xiaobenyang_gaokao_skill/
├── scripts/
│ ├── __init__.py
│ ├── config.py # 配置管理 + set_api_key()
│ ├── call_api.py # API 客户端 + call_api()
│ └── tools.py # 工具函数(直接调用)
├── requirements.txt
└── SKILL.md