mcpField
J
jerlin-weread-skill

jerlin-weread-skill

github.com/jerlinnProductivity11254 installsUpdated 23w ago
Repository

About jerlin-weread-skill

A WeRead skill that lets an agent access book discovery, reading progress, shelves, statistics, notes, and reviews through `scripts/weread.sh`. It includes reference-guided handling rules and WeRead deep links for opening books and annotations in the app.

Key features

  1. 01Search books and retrieve details
  2. 02Access shelves and reading progress
  3. 03Review reading statistics and preferences
  4. 04Retrieve notes, highlights, and reviews
  5. 05Generate WeRead deep links

Use cases

  1. 01Find a book and inspect its chapters
  2. 02Check reading time and progress
  3. 03Review saved highlights and notes
  4. 04Open a book or highlight in WeRead

Install

Copy the command and run it in a terminal.

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

After installing, type/jerlin-weread-skillin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with 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

Details

From the project 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 从上下文获取或省略。

Comments

Markdown supported