← 返回 Skills 市场
xiaobenyang-com

PDF阅读服务

作者 xiaobenyang-com · GitHub ↗ · v1.0.7 · MIT-0
cross-platform ⚠ suspicious
58
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install read-pdf
功能描述
一个支持AI助手读取和分析PDF文件的MCP服务器,提供PDF元数据提取、页面范围阅读和关键词搜索等功能。
使用说明 (SKILL.md)

PDF阅读服务器

一个支持AI助手读取和分析PDF文件的MCP服务器,提供PDF元数据提取、页面范围阅读和关键词搜索等功能。


⚠️ 强制要求:API 密钥

此 Skill 必须配置 API 密钥才能使用。

  • 首次使用时,如果 .env 中没有 XBY_APIKEY必须使用 AskUserQuestion 工具向用户询问 API 密钥
  • 拿到用户提供的密钥后,调用 scripts.config.set_api_key(api_key) 保存,然后继续处理
  • 获取 API 密钥:https://xiaobenyang.com
  • 禁止在缺少 API 密钥时自行搜索或编造数据

工作流程(必须遵守)

你(大模型)是路由层,负责理解用户意图、选择工具、提取参数。代码只负责调用API。

用户输入 → 你选择工具 → 提取该工具需要的参数 → 调用 scripts.tools 中的函数 → 返回结果给用户

步骤

  1. 检查 API 密钥:如果 scripts.config.settings.api_key 为空,使用 AskUserQuestion 询问用户,拿到后调用 scripts.config.set_api_key(key) 保存
  2. 选择工具:根据用户意图从下方工具列表中选择对应的工具函数
  3. 提取参数:根据选中的工具,提取该工具需要的参数
  4. 调用工具:使用关键字参数调用 scripts.tools 中的函数,例如 scripts.tools.search_schools(score='520', province='北京', category='综合')
  5. 返回结果:将工具返回的 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 向用户询问缺失的参数。


工具函数说明


scripts.tools.read_pdf

工具描述: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://)

scripts.tools.read_pdf_page

工具描述: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)

scripts.tools.get_pdf_metadata

工具描述: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://)

scripts.tools.search_pdf

工具描述: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

注意事项

  1. API 密钥是必需的,无密钥时必须通过 AskUserQuestion 询问用户
  2. 禁止在缺少 API 密钥时自行搜索或编造数据
安全使用建议
Review this carefully before installing. Do not use it for confidential PDFs, private file paths, internal URLs, or sensitive search terms unless you trust the XiaoBenYang service and its data handling. Prefer setting any API key through a secure runtime mechanism instead of letting the skill save it to .env, and consider pinning dependencies before deployment.
能力标签
requires-sensitive-credentials
能力评估
Purpose & Capability
The stated PDF reading purpose partly matches the tools, but the implementation is a remote API client for https://mcp.xiaobenyang.com rather than a local PDF reader, and the documentation does not clearly explain that document paths, URLs, and queries are sent externally.
Instruction Scope
The skill requires asking the user for an API key and storing it, accepts local paths or HTTP/HTTPS URLs, and includes copied gaokao examples and project names that do not match the PDF skill, weakening confidence in the documented scope.
Install Mechanism
The package uses ordinary Python files and common dependencies, but requirements are lower-bound only rather than pinned, so installs are not fully reproducible.
Credentials
Network access and credential use are expected for an API-backed service, but the artifact does not proportionately warn users about external processing, URL fetching, or leakage of local path names and search terms.
Persistence & Privilege
scripts/config.py writes the supplied XBY_APIKEY into a plaintext .env file and mirrors it into the process environment without a clear consent or non-persistent option.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install read-pdf
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /read-pdf 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.7
- Added detailed usage instructions, API key requirements, and workflow steps to SKILL.md. - Clarified that an API key is mandatory and must be obtained from the user if not set. - Specified strict rules on tool selection and parameter extraction based on user intent. - Provided a clear mapping table to match user actions with corresponding tool functions. - Included full parameter definitions and usage examples for all PDF-related tools. - Emphasized that data must not be fabricated or searched if the API key is missing.
元数据
Slug read-pdf
版本 1.0.7
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

PDF阅读服务 是什么?

一个支持AI助手读取和分析PDF文件的MCP服务器,提供PDF元数据提取、页面范围阅读和关键词搜索等功能。 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 58 次。

如何安装 PDF阅读服务?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install read-pdf」即可一键安装,无需额外配置。

PDF阅读服务 是免费的吗?

是的,PDF阅读服务 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

PDF阅读服务 支持哪些平台?

PDF阅读服务 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 PDF阅读服务?

由 xiaobenyang-com(@xiaobenyang-com)开发并维护,当前版本 v1.0.7。

💬 留言讨论