mcpField
J
jerlin-weread-skill

jerlin-weread-skill

github.com/jerlinn生产力11254 次安装23 周前更新
代码仓库

关于 jerlin-weread-skill

用于通过 `scripts/weread.sh` 访问微信读书的技能,支持找书、阅读进度、书架、统计、笔记和点评。它提供按参考文档操作的规则,并可生成在 App 中打开书籍或划线的深链接。

主要功能

  1. 01搜索书籍并获取详情
  2. 02访问书架与阅读进度
  3. 03查看阅读统计和偏好
  4. 04获取笔记、划线和点评
  5. 05生成微信读书深链接

适用场景

  1. 01查找书籍并查看章节
  2. 02检查阅读时长和进度
  3. 03查看已保存的划线和笔记
  4. 04在微信读书中打开书籍或划线

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jerlinn/jerlin-weread --skill jerlin-weread-skill

安装后在 Claude Code 中输入/jerlin-weread-skill确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
book.md
discover.md
notes.md
profile.md
readdata.md
reading-profile.md
review.md
search.md
shelf.md
scripts/
weread.sh

详细介绍

来自项目 README

WeRead — 微信读书助手

所有接口通过 scripts/weread.sh 调用。脚本处理鉴权和参数平铺。查看子命令列表:weread.sh -h;查看某个子命令的参数和回包字段:weread.sh <subcmd> -h。

能力路由

用户意图子命令领域知识
搜书/找书searchreferences/search.md
书籍详情/章节/进度book-info chapters progressreferences/book.md
书架shelfreferences/shelf.md
阅读统计/时长/偏好readdatareferences/readdata.md
笔记/划线/想法notebooks bookmarks my-reviewsreferences/notes.md
热门划线/划线下想法best-bookmarks read-reviews underlines review-detailreferences/notes.md
公开点评reviewsreferences/review.md
推荐好书recommend similarreferences/discover.md
用户阅读概况(组合)references/profile.md
阅读画像(组合 + AskUser)references/reading-profile.md

CRITICAL: 调用任何接口前,先阅读对应 reference 确认字段含义、计数口径和工作流。回包字段名和直觉含义冲突时,服从 reference 说明。

鉴权

  • 环境变量 $WEREAD_API_KEY,格式 wrk-xxxxxxxx
  • 未设置时提示用户:export WEREAD_API_KEY=<你的apikey>
  • API Key 绑定用户身份(vid),无需手动传

通用规则

  1. errcode 非 0 表示错误,给出中文提示。回包出现 upgrade_info 时按其 message 指引完成升级后重试。
  2. 用户输入书名时,先调 weread.sh search 获取 bookId,再执行后续操作。
  3. 对话中记住已查询的 bookId,后续操作无需用户重复提供。
  4. 列表用编号展示方便选择。展示回包信息时,字段禁止直接翻译,参考 reference 中的说明。
  5. 时间戳展示为 YYYY-MM-DD 格式,不得直接展示原始数字。
  6. 阅读时长单位为秒,展示时转为「X 小时 Y 分钟」。

深度链接

展示书籍、章节、划线等内容时,回包字段足以构造链接的,附上跳转链接方便用户在 App 中打开。

场景URL Schema
打开书籍weread://reading?bId={bookId}
跳转章节weread://reading?bId={bookId}&chapterUid={chapterUid}
跳转划线位置weread://bestbookmark?bookId={bookId}&chapterUid={chapterUid}&rangeStart={rangeStart}&rangeEnd={rangeEnd}&userVid={userVid}

range 解析:划线接口返回的 range 格式为 起始-结束(如 900-2004),拆分后分别填入 rangeStart 和 rangeEnd。

划线位置链接的生成条件:回包同时包含 chapterUid 和 range。整本书评或无法定位到划线的点评不生成此链接。userVid 从上下文获取或省略。

评论

支持 Markdown