MyBooks

Requirements

# 需要配置以下三个环境变量后方可使用
export MYBOOKS_HOST="http://127.0.0.1:8082"
export MYBOOKS_USER="admin"
export MYBOOKS_PASSWORD="your_password"
export MYBOOKS_SSL_VERIFY="false"   # 如服务器使用自签名证书，设为 false
# 明文 http 仅允许回环/内网地址（如 192.168.x.x）；公网地址必须用 https
# 确需对非内网地址使用明文 http 时：export MYBOOKS_ALLOW_INSECURE_HTTP="true"

然后按如下方式执行：
<skill-installation-path>/scripts/mybooks_api.py <tool-name> '<json-args>'

安全提示：请勿将凭据写入共享或全局配置文件（如 ~/.openclaw/.env），以避免凭据被其他 agent 或进程意外读取。建议通过会话级环境变量或专用密钥管理工具传入凭据。

权限与网络声明

• 网络访问（必需）：本 skill 是 MyBooks 服务器的 REST 客户端，所有工具都通过 HTTP(S) 访问且仅访问用户自己配置的 MYBOOKS_HOST，不连接任何其他地址，无遥测、无第三方回传。
• 会修改数据的工具：edit_book、set_folder、rename_folder、push_notes(dry_run:false)、clear_imported_notes、book_fill、save_meta_to_file、book_upload、book_add_by_isbn、wants/favorite/reading/read_done、set_reading_time、delete_reading_time、书单的创建/修改/删除/增删书/点赞、以及全部 tts_* 写操作。删除类工具（delete_booklist、delete_reading_time）脚本内强制 confirm:true 两步确认。
• 本地文件读取：仅 book_upload（限电子书扩展名 epub/mobi/azw/azw3/pdf/txt/lrf/rtf/djvu/docx）和 tts_clone_upload（限 mp3/wav，≤7MB）会读取用户明确给出路径的文件并上传到 MYBOOKS_HOST；agent 不得自行挑选文件上传。
• 本地文件写入：仅 tts_clone_audio 的 save_to（必须 .wav 结尾，且不覆盖已存在文件）。
• 凭据：见下方"认证方式"。

通用响应格式与认证方式

通用 JSON 响应结构

所有 API 均返回如下格式：

{
  "err": "ok",       // "ok" 表示成功，其他字符串表示错误码
  "msg": "...",      // 可选，人类可读的成功/错误说明
  "data": { }        // 可选，具体响应数据（因接口而异）
}

常见错误码：

认证方式

• 脚本通过 MYBOOKS_USER / MYBOOKS_PASSWORD 环境变量自动调用 /api/user/sign_in 完成登录
• 服务端通过 Secure Cookie（user_id + lt）维持会话
• 若响应中出现 err=user.need_login，脚本会自动重新登录后重试一次；仍失败则报错退出
• 凭据去向说明：MYBOOKS_USER / MYBOOKS_PASSWORD 只会以表单形式 POST 到用户自己配置的 MYBOOKS_HOST 的 /api/user/sign_in，不会发往任何其他地址；登录请求不跟随重定向；MYBOOKS_HOST 必须是 http(s)://host[:port] 且不含内嵌账号密码，对非内网地址要求 https
• 必须在调用前配置 MYBOOKS_HOST、MYBOOKS_USER、MYBOOKS_PASSWORD 三个环境变量，否则脚本直接报错退出

工具列表

get_user_info — 用户信息与系统统计

使用场景：获取当前登录用户信息，同时返回书库总体统计（书籍数、作者数等）

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py get_user_info '{}'

响应示例：

{
  "err": "ok",
  "user": { "is_login": true, "nickname": "管理员", "is_admin": true },
  "sys": { "books": 1280, "authors": 342, "tags": 86, "mtime": "2025-03-01" }
}

library_stats — 书库统计

使用场景：获取书库详细统计，包括电子书/实体书数量及本月新增

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py library_stats '{}'

响应示例：

{
  "err": "ok",
  "stats": {
    "total_books": 1280,
    "ebook_count": 1210,
    "physical_count": 70,
    "month_ebook_count": 12,
    "month_physical_count": 3,
    "current_year": 2025,
    "current_month": 3
  }
}

reading_stats — 阅读统计

使用场景：获取当前用户的阅读统计（在读/已读数量、本月数据）及当前在读书单

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py reading_stats '{}'

响应示例：

{
  "err": "ok",
  "stats": {
    "total_reading": 5,
    "total_read_done": 42,
    "month_reading": 2,
    "month_read_done": 3
  },
  "current_reading_books": [ /* 书籍对象列表 */ ],
  "month_read_done_books": [ /* 书籍对象列表 */ ]
}

search_books — 搜索书籍

使用场景：

• 关键词模糊搜索（书名/作者/简介），支持简繁体自动转换："有没有余华的书？" / "找一下《三体》"
• 按字段精确定位：只查书名、只查作者、按 ISBN 查找："ISBN 9787536692930 是哪本书？"
• 组合条件搜索：多个字段参数同时给出时按 AND 组合："余华在作家出版社出的书"
• Calibre 条件表达式：name 中写入 字段:值 形式的表达式，支持 AND/OR/NOT 与括号："评分 4 星以上的科幻小说"

参数（name/title/author/isbn/publisher/series/tag 至少提供一个）：

name 的三种解析方式（后台自动识别）：

1. 纯 ISBN（10/13 位数字，可含 -）→ 按 ISBN 精确查找。
2. Calibre 条件表达式（包含 字段: 形式，字段为 Calibre 内置搜索字段或 # 开头的自定义列）→ 原样交给 Calibre 搜索（同时追加简繁体转换版本以 OR 合并）。
3. 其它 → 普通关键字，在书名/作者/简介等所有字段中模糊搜索。

Calibre 表达式速查：

常用字段：title authors tags publisher series isbn identifiers comments rating pubdate timestamp formats languages id，以及 # 开头的自定义列。

执行脚本：

# 关键词
<skill-installation-path>/scripts/mybooks_api.py search_books '{"name":"三体"}'
# 按 ISBN
<skill-installation-path>/scripts/mybooks_api.py search_books '{"isbn":"978-7-5366-9293-0"}'
# 组合条件：余华 + 作家出版社
<skill-installation-path>/scripts/mybooks_api.py search_books '{"author":"余华","publisher":"作家出版社"}'
# 书名精确匹配
<skill-installation-path>/scripts/mybooks_api.py search_books '{"title":"活着"}'
# Calibre 表达式
<skill-installation-path>/scripts/mybooks_api.py search_books '{"name":"tags:科幻 AND rating:>=4","order":"rating"}'

选择建议：用户只给出模糊描述时用 name 关键词；明确说出"作者是…/出版社是…/ISBN…"时用对应字段参数；需要评分、日期、格式、排除等条件时用 Calibre 表达式。字段参数与 name 可同时使用，彼此为 AND 关系。

响应示例：

{
  "err": "ok",
  "title": "搜索作者:余华 出版社:作家出版社",
  "total": 3,
  "books": [ /* 书籍对象列表 */ ]
}

search_by_category — 按分类查询书籍

使用场景：查询指定分类下的所有书籍（基于自定义 #category 字段）

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py search_by_category '{"category":"科幻"}'

list_folders — 查看目录树

使用场景：查看书库的"目录"（层级有上限，当前为两级，如 文学.小说）及各目录书籍数量；未设置目录的书在根目录 /

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_folders '{}'

响应示例（count 含子目录，root_count 为未设置目录的书）：

{
  "err": "ok",
  "folders": [
    { "name": "文学", "count": 12, "children": [{ "name": "小说", "count": 8 }] }
  ],
  "root_count": 5,
  "max_depth": 2
}

search_by_folder — 按目录查询书籍

使用场景：查看某个目录下直属的书（不含子目录的书）；path 为空表示根目录

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py search_by_folder '{"path":"文学.小说"}'

set_folder — 设置书籍目录

使用场景：把一本或多本书放进某个目录。单本需管理员或书籍所有者；批量（book_ids）仅管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py set_folder '{"book_id":42,"folder":"文学.小说"}'

rename_folder — 重命名目录

使用场景：修改目录的最后一段名称（仅管理员），子目录随之改名，如 文学 → 读物 后 文学.小说 变为 读物.小说

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py rename_folder '{"path":"文学.小说","name":"故事"}'

get_book — 书籍详情

使用场景：获取指定书籍的完整信息，包括元数据、可用格式、封面、阅读状态等

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py get_book '{"book_id":42}'

响应示例：

{
  "err": "ok",
  "book": {
    "id": 42,
    "title": "活着",
    "authors": ["余华"],
    "tags": ["小说", "中国文学"],
    "publisher": "作家出版社",
    "isbn": "9787506365437",
    "pubdate": "2012-08-01",
    "rating": 9,
    "comments": "《活着》讲述了...",
    "category": "现代文学",
    "available_formats": ["epub", "pdf"],
    "files": [
      {
        "format": "EPUB",
        "size": 1330899,
        "href": "/api/book/42.EPUB"
      }
    ],
    "cover_url": "/get/cover/42",
    "series": "余华作品集",
    "series_index": 1,
    "state": {
      "favorite": 0,
      "wants": 0,
      "read_state": 1
    },
    "tags": ["小说", "中国文学"]
  },
  "kindle_sender": "sender@example.com"
}

edit_book — 编辑书籍元数据

使用场景：

• 手动修改书名、作者、标签、分类等字段
• 修改实体书数量或类型

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py edit_book '{"book_id":42,"tags":["小说","中国文学"],"category":"现代文学"}'

响应示例：

{ "err": "ok", "msg": "更新成功", "books": [42] }

push_notes — 导入第三方批注（微信读书等）

使用场景：把从其他阅读 App（目前是微信读书）读到的划线/想法，通过服务端全文检索定位到 MyBooks 书库里对应 EPUB 书籍的正文位置，写入这本书的阅读记录。详细方案见 plan/WeChatReading_Annotation_Import_Plan.md。

前提：目标书籍必须已经在 MyBooks 书库里，且必须有 EPUB 格式（定位算法依赖 EPUB 的正文结构，其它格式不支持）。

参数：

再次同步（判重）说明：微信读书没有增量接口，每次都会拿到全量划线/想法列表。直接把全量列表再传一遍给 push_notes 是安全且推荐的做法——服务端会按 anchors[].id 匹配上次导入的记录，text/chapterHint 没变的条目不会重新定位（省时间，也避免同一条批注每次定位到略有不同的位置），只有新增的、或者原文本身变了的条目才会真正重新检索。如果只是想法/评论内容改了但划线原文没变，也会被识别为"位置没变、内容更新"，只更新想法文本，不重新定位。

执行脚本：

# 第一步：预览（默认 dry_run:true），不会写入任何数据
<skill-installation-path>/scripts/mybooks_api.py push_notes '{
  "book_id": 42,
  "anchors": [
    {"id": "wx-bm-1001", "text": "他手里拿着两大块磁铁", "note": "开篇的魔幻现实主义笔法"},
    {"id": "wx-review-2001", "chapterHint": "第一章"}
  ]
}'

# 第二步：跟用户确认预览报告无误后，正式写入
<skill-installation-path>/scripts/mybooks_api.py push_notes '{
  "book_id": 42,
  "anchors": [
    {"id": "wx-bm-1001", "text": "他手里拿着两大块磁铁", "note": "开篇的魔幻现实主义笔法"},
    {"id": "wx-review-2001", "chapterHint": "第一章"}
  ],
  "dry_run": false
}'

响应示例（预览，dry_run:true）：

{
  "err": "ok",
  "book_id": 42,
  "book_hash": "cloud-42-epub",
  "dry_run": true,
  "results": [
    { "id": "wx-bm-1001", "status": "ok", "cfi": "epubcfi(/6/10!/4/4/2,/19:17,/21:4)", "matchCount": 1 },
    { "id": "wx-review-2001", "status": "ok", "cfi": "epubcfi(/6/8!/4)", "degraded": "chapter_start" }
  ]
}

响应示例（提交，dry_run:false，额外带 pushed）：

{
  "err": "ok",
  "book_id": 42,
  "book_hash": "cloud-42-epub",
  "dry_run": false,
  "results": [ /* 同上 */ ],
  "pushed": { "notes": [ /* 写入后的最终记录，字段与 GET /api/sync 一致 */ ] }
}

results[].status 取值：

常见错误：

get_notes — 查询书籍批注

使用场景：查看某本书已有的划线/批注/书签（通过 GET /api/sync 实现，type=notes）。

• "这本书我都划了哪些线？" / "看看《活着》的批注"
• 确认 push_notes 导入结果，或在 clear_imported_notes 前先看一眼现有批注

参数：

执行脚本：

# 按 book_id 查询自己的批注
<skill-installation-path>/scripts/mybooks_api.py get_notes '{"book_id":42}'

# 按书名查询，并包含其他用户共享的批注
<skill-installation-path>/scripts/mybooks_api.py get_notes '{"title":"活着","own":0}'

响应示例：

{
  "err": "ok",
  "book_id": 42,
  "book_hash": "cloud-42-epub",
  "books": null,
  "configs": null,
  "notes": [
    {
      "id": "wxread-wx-bm-1001",
      "book_hash": "cloud-42-epub",
      "type": "annotation",
      "cfi": "epubcfi(/6/10!/4/4/2,/19:17,/21:4)",
      "text": "他手里拿着两大块磁铁",
      "note": "开篇的魔幻现实主义笔法",
      "style": "highlight",
      "color": "yellow",
      "updated_at": 1755600000000,
      "deleted_at": null
    }
  ]
}

notes[] 每条记录的字段：

按书名查询时命中多本书会返回：

{ "status": "error", "message": "Multiple books matched this title; specify book_id", "candidates": [ {"id": 42, "title": "活着", "authors": ["余华"]}, ... ] }

常见错误：

clear_imported_notes — 清空某本书已导入的批注（重置用，非日常操作）

使用场景：撤销/重置某本书通过 push_notes 导入的全部批注——比如导入用错了数据、或者 on_ambiguous:"first_match" 选错了位置，用户明确要求"重新导入一遍"。不要把这个当成处理"再次同步"的常规手段——push_notes 本身已经会自动判重（见上），日常重复同步应该直接再调一次 push_notes，不需要先清空。

范围：只会清除当前登录用户通过 push_notes 导入的批注（id 带 wxread- 前缀的），不影响这本书上其他人的批注，也不影响用户自己在 MyReader 里手动做的批注。

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py clear_imported_notes '{"book_id":42}'

响应示例：

{ "err": "ok", "book_id": 42, "book_hash": "cloud-42-epub", "cleared": 5 }

常见错误：

book_fill — 自动联网填充书籍信息

使用场景：

• "帮我更新《XX》的封面和简介"
• "书库里有很多书信息不完整，帮我补全"
• 批量补全多本书的封面、简介、出版社、出版日期、标签等

权限：需要管理员权限

参数：

注意：任务在后台异步执行，调用后立即返回；书名默认保留原值不修改（防止错误覆盖）

执行脚本：

# 更新单本书
<skill-installation-path>/scripts/mybooks_api.py book_fill '{"idlist":[42]}'

# 批量更新
<skill-installation-path>/scripts/mybooks_api.py book_fill '{"idlist":[42,43,44]}'

响应示例：

{ "err": "ok", "msg": "任务启动成功！请耐心等待，稍后再来刷新页面" }

save_meta_to_file — 将元数据保存到电子书文件

使用场景：

• 在书库中修改了书名/作者/简介/标签等元数据后，希望这些信息也写入电子书文件本身（而不只是存在书库数据库里）
• 仅支持 epub / azw3 / pdf 格式；其余格式（如 mobi、txt）不受影响

权限：需要登录，且为管理员或该书籍的所有者

参数：

执行脚本：

# 同步所有支持的格式
<skill-installation-path>/scripts/mybooks_api.py save_meta_to_file '{"book_id":42}'

# 仅同步 epub
<skill-installation-path>/scripts/mybooks_api.py save_meta_to_file '{"book_id":42,"fmt":"epub"}'

响应示例：

{ "err": "ok", "msg": "成功将元数据同步到文件：EPUB", "success_formats": ["EPUB"], "failed_formats": [] }

常见错误：

mailto — 发送书籍到邮箱

使用场景：将书籍以附件形式发送到指定邮箱（如 Kindle 邮箱）

格式优先级：epub > azw3 > pdf > mobi > txt（取首个存在的格式）

权限：需要登录，且账号需有推送权限（can_push）

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py mailto '{"book_id":42,"email":"user@kindle.com"}'

响应示例：

{ "err": "ok", "msg": "后台正在推送，稍后可以刷新页面，在通知消息中查看结果。" }

send_to_device — 发送书籍到阅读器设备

使用场景：通过 WiFi 将书籍直接推送到阅读器设备（仅支持当前网络内的临时设备）

支持的设备类型（device_type）：

WiFi 传输格式优先级：epub > azw3 > pdf > txt

参数：

执行脚本：

# 发送到多看设备
<skill-installation-path>/scripts/mybooks_api.py send_to_device \
  '{"book_id":42,"device_type":"duokan","device_url":"192.168.1.100"}'

# 发送到 Kindle（通过邮件）
<skill-installation-path>/scripts/mybooks_api.py send_to_device \
  '{"book_id":42,"device_type":"kindle","mailbox":"mykindle@kindle.cn"}'

响应示例：

{ "err": "ok", "msg": "书籍发送成功" }

categories — 查看分类信息

使用场景：获取当前书库中所有自定义分类及各分类下的书籍数量

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py categories '{}'

响应示例：

{
  "err": "ok",
  "categories": [
    { "name": "现代文学", "count": 128 },
    { "name": "科幻", "count": 56 }
  ]
}

list_authors — 查看作者列表

使用场景：获取所有有在库书籍的作者及其书籍数量

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_authors '{}'

响应示例：

{
  "err": "ok",
  "meta": "author",
  "title": "全部作者",
  "items": [
    { "name": "余华", "count": 5 },
    { "name": "刘慈欣", "count": 8 }
  ],
  "total": 342
}

get_author_books — 查询作者的在库书籍

使用场景：获取指定作者在书库中的所有书籍

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py get_author_books '{"author_name":"余华"}'

book_upload — 上传电子书

使用场景：上传本地电子书文件到书库，支持 epub/mobi/azw/azw3/pdf/txt/lrf/rtf/djvu/docx 等格式

权限：需要登录，且账号需有上传权限（can_upload）

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py book_upload '{"file_path":"/path/to/book.epub"}'

响应示例：

{ "err": "ok", "book_id": 123 }

book_add_by_isbn — 通过 ISBN 添加实体书

使用场景：

• 扫描实体书的 ISBN 条码后，将书入库
• 若该 ISBN 书籍已存在，则自动将实体书数量 +1

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py book_add_by_isbn '{"isbn":"9787020024759"}'

响应示例（新增）：

{ "err": "ok", "msg": "图书添加成功", "book_id": 456 }

响应示例（已存在，更新数量）：

{ "err": "ok", "msg": "实体书数量已更新，当前数量：2", "book_id": 123 }

wants — 标记/取消想读

使用场景：将书籍加入/移出"想读（待读）"清单

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py wants '{"book_id":42}'

list_wants — 想读清单

使用场景：获取当前用户的"想读（待读）"书籍列表

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_wants '{}'

favorite — 收藏/取消收藏

使用场景：收藏或取消收藏指定书籍

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py favorite '{"book_id":42}'

list_favorites — 收藏列表

使用场景：获取当前用户的所有收藏书籍

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_favorites '{}'

reading — 设置阅读状态

使用场景：标记某本书的阅读状态（未读/在读/已读完）

参数：

执行脚本：

# 标记为在读
<skill-installation-path>/scripts/mybooks_api.py reading '{"book_id":42,"read_state":1}'

list_reading — 在读书单

使用场景：获取当前用户的"正在阅读"书籍列表

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_reading '{}'

read_done — 标记已读完

使用场景：快捷将某本书标记为已读完（即 reading 工具中 read_state=2 的简化版）

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py read_done '{"book_id":42}'

list_read_done — 已读清单

使用场景：获取当前用户的"已读完"书籍列表

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_read_done '{}'

get_book_reading_stats — 分格式阅读时长/进度统计

使用场景：查看某本书分格式（epub/pdf/mobi 等）的阅读时长、阅读进度、开始/完成阅读的时间、开始阅读的次数。与 reading/read_done 的整本书阅读状态不同，这个接口是"格式"级别的细粒度数据。

• "这本书我读了多久？" / "我读到哪了？" / "这本书 epub 版我什么时候开始读的？"

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py get_book_reading_stats '{"book_id":42}'

响应示例：

{
  "err": "ok",
  "stats": [
    {
      "format": "epub",
      "state": 0,
      "total_seconds": 5421,
      "progress_current": 3,
      "progress_total": 488,
      "progress_percent": 0.61,
      "start_time": "2026-08-20T10:00:00Z",
      "finish_time": null,
      "start_count": 1,
      "update_time": "2026-08-27T09:12:00Z"
    }
  ]
}

state：0=在读，1=已完成。没有任何格式统计数据时 stats 为空数组 []（比如从未通过 MyReader/网页阅读器打开过这本书）。

update_book_reading_stats — 手动更新阅读时长/进度

使用场景：手动补记或纠正某本书某个格式的阅读数据——导入历史阅读记录、用户口述"我刚读完这本书的 PDF 版"、或者网页阅读器等没有自动进度上报的场景。日常通过 MyReader 阅读的书籍会自动统计，不需要调用这个工具。

参数：

执行脚本：

# 补记刚读的 40 分钟，并更新进度
<skill-installation-path>/scripts/mybooks_api.py update_book_reading_stats \
  '{"book_id":42,"format":"pdf","duration_seconds":2400,"progress":[50,200]}'

# 手动标记这本书的 epub 版已读完
<skill-installation-path>/scripts/mybooks_api.py update_book_reading_stats \
  '{"book_id":42,"format":"epub","state":1}'

响应示例：

{ "err": "ok", "stats": { "format": "pdf", "state": 0, "total_seconds": 2400, "progress_current": 50, "progress_total": 200, "progress_percent": 25.0, "start_time": "2026-08-27T09:00:00Z", "finish_time": null, "start_count": 1, "update_time": "2026-08-27T09:40:00Z" } }

常见错误：

get_reading_time / set_reading_time / delete_reading_time — 按日期补录阅读时间

版本要求：MyBooks v4.3.0+（旧版本服务端没有 /api/book/<id>/reading_time，调用会 404）。

使用场景：某天读了书但没有通过 MyReader/网页阅读器自动计时（纸质书、其他 App 等），按日期补录一条手工阅读记录。每本书每天最多一条手工记录：再次 set_reading_time 同一天是覆盖（不是累加），差值会同步到当日阅读统计、该书分格式累计时长和用户总阅读时长。与 update_book_reading_stats（按格式累加时长/进度）不同，这里是按天的"覆盖式"记录。

限制：书籍必须有电子书格式（记录会挂到已有的阅读格式，否则挂到可用格式之一）；日期不能晚于今天；duration_seconds 范围 0~64800（18 小时）。均需登录，只影响当前用户自己的数据。

参数：

执行脚本：

# 查询某天的手工记录及参考数据（自动记录的秒数、手工秒数、该书总时长）
<skill-installation-path>/scripts/mybooks_api.py get_reading_time '{"book_id":42,"date":"2026-09-20"}'

# 补录（或覆盖）：当天读了 45 分钟
<skill-installation-path>/scripts/mybooks_api.py set_reading_time '{"book_id":42,"date":"2026-09-20","duration_seconds":2700,"start_time":"20:30","end_time":"21:15"}'

# 删除当天的手工记录（同步回退统计）
<skill-installation-path>/scripts/mybooks_api.py delete_reading_time '{"book_id":42,"date":"2026-09-20"}'
# ↑ 不带 confirm 只返回待删记录预览（err:"confirm.required"），不会删除；用户明确同意后加 "confirm":true 才真正删除
<skill-installation-path>/scripts/mybooks_api.py delete_reading_time '{"book_id":42,"date":"2026-09-20","confirm":true}'

响应示例：

// get_reading_time
{ "err": "ok", "entry": { "date": "2026-09-20", "duration_seconds": 2700, "format": "epub" }, "date_recorded_seconds": 600, "manual_recorded_seconds": 2700, "book_total_seconds": 8121 }
// set_reading_time
{ "err": "ok", "entry": { "date": "2026-09-20", "duration_seconds": 2700, "format": "epub" } }
// delete_reading_time
{ "err": "ok", "deleted": true }

entry 为 null 表示该日没有手工记录；deleted:false 表示本来就没有可删的记录。entry 的具体字段以服务端返回为准。

常见错误：

书单工具列表

版本要求：MyBooks v4.3.0+（旧版本没有 /api/booklist* 接口）。书单（booklist）是用户自建的书籍集合，每人数量有上限，可设为公开供他人浏览、点赞。

权限规则：浏览公开书单不需登录；创建/修改/删除书单、增删书籍、点赞需要登录，其中修改/删除/增删书籍仅限书单所有者或管理员；私有书单仅所有者/管理员可看，且不能点赞。

书单对象（各接口 booklist(s) 里的元素）主要字段：id、name、description、color、is_public、is_sticky、view_count、like_count、book_count、create_time、update_time、owner（id/username/avatar）、is_owner、liked_by_me；列表接口另带 cover_books（最多 12 本的封面卡片）。

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py list_my_booklists '{}'
<skill-installation-path>/scripts/mybooks_api.py create_booklist '{"name":"2026 科幻必读","description":"年度科幻","is_public":true}'
<skill-installation-path>/scripts/mybooks_api.py booklist_add_books '{"booklist_id":7,"book_ids":[42,43]}'
<skill-installation-path>/scripts/mybooks_api.py get_booklist '{"booklist_id":7,"page":1}'
<skill-installation-path>/scripts/mybooks_api.py booklist_remove_book '{"booklist_id":7,"book_id":43}'
# 删除书单：第一次调用只返回预览，不会删除
<skill-installation-path>/scripts/mybooks_api.py delete_booklist '{"booklist_id":7}'
# 用户明确同意后才带 confirm
<skill-installation-path>/scripts/mybooks_api.py delete_booklist '{"booklist_id":7,"confirm":true}'

响应示例（get_booklist）：

{
  "err": "ok",
  "booklist": {
    "id": 7, "name": "2026 科幻必读", "is_public": true, "book_count": 2, "like_count": 3,
    "is_owner": true, "liked_by_me": false,
    "books": [ { "book_id": 42, "title": "三体", "img": "...", "thumb": "...", "href": "/book/42" } ],
    "books_total": 2, "page": 1, "page_size": 24
  }
}

写操作响应：create_booklist/update_booklist 返回 booklist + msg；booklist_add_books 返回 added、book_count；booklist_remove_book 返回 book_count；like_booklist 返回 liked（当前是否已点赞）。

常见错误：

TTS 有声书工具列表（MiMo TTS，需管理员权限）

将 EPUB 电子书转换为有声书。所有 TTS 接口均需要管理员权限。

tts_save_config — 保存 TTS API 配置

使用场景：配置 TTS API 的连接参数（API URL、模型、密钥、类型等），保存后服务端加密存储

权限：管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_save_config '{"api_url":"https://api.xiaomimimo.com/v1/chat/completions","model_name":"mimo-v2.5-tts","api_type":"chat_completions","api_key":"sk-xxx","voice_name":"mimo_default"}'

响应示例：

{
  "err": "ok",
  "msg": "配置已保存"
}

tts_test_connection — 测试 API 连接

使用场景：使用当前保存的配置发送一次测试请求，验证 API Key 和端点是否可用

权限：管理员

参数：无（使用已保存的配置）

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_test_connection '{}'

响应示例：

{
  "err": "ok",
  "msg": "连接成功"
}

常见错误：

tts_convert — 开始 EPUB 转有声书

使用场景：将指定 EPUB 电子书转换为有声书，后台逐章合成 WAV 音频

权限：管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_convert '{"book_id":42,"api_url":"https://api.xiaomimimo.com/v1/chat/completions","model_name":"mimo-v2.5-tts","api_type":"chat_completions","api_key":"sk-xxx","voice_name":"mimo_default"}'

响应示例：

{
  "err": "ok",
  "msg": "转换任务已启动"
}

常见错误：

tts_progress — 查询转换进度

使用场景：查询当前 TTS 转换任务的进度、阶段和章节信息

权限：管理员

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_progress '{}'

响应示例：

{
  "err": "ok",
  "status": "running",
  "progress": 35,
  "stage": "converting",
  "current_chapter": 7,
  "total_chapters": 20,
  "current_title": "第七章 归途",
  "book_id": 42
}

status 值：

tts_clone_upload — 上传克隆音色

使用场景：上传 MP3/WAV 音频样本作为克隆音色，上传后自动切换到 mimo-v2.5-tts-voiceclone 模型

权限：管理员

参数：

限制：

• 格式：仅支持 .mp3 和 .wav
• 大小：原始文件 ≤ 7MB（Base64 编码后约 9.3MB，MiMo 官方限制 Base64 ≤ 10MB）

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_clone_upload '{"voice_name":"旁白","file_path":"/path/to/sample.mp3"}'

响应示例：

{
  "err": "ok",
  "msg": "克隆音色上传成功",
  "data": { "name": "旁白", "ext": "mp3", "size": 1048576 }
}

常见错误：

tts_clone_list — 克隆音色列表

使用场景：获取所有已上传的克隆音色列表

权限：管理员

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_clone_list '{}'

响应示例：

{
  "err": "ok",
  "clones": [
    { "name": "旁白", "ext": "mp3", "size": 1048576 },
    { "name": "男主", "ext": "wav", "size": 2097152 }
  ]
}

tts_clone_delete — 删除克隆音色

使用场景：删除指定的克隆音色

权限：管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_clone_delete '{"voice_name":"旁白"}'

响应示例：

{
  "err": "ok",
  "msg": "克隆音色已删除"
}

tts_clone_audio — 下载克隆音频

使用场景：下载/试听指定的克隆音色原始音频文件（返回二进制 WAV 数据）

权限：管理员

参数：

执行脚本：

# 保存到文件
<skill-installation-path>/scripts/mybooks_api.py tts_clone_audio '{"voice_name":"旁白","save_to":"/tmp/clone_preview.wav"}'

# 返回 base64（小文件）
<skill-installation-path>/scripts/mybooks_api.py tts_clone_audio '{"voice_name":"旁白"}'

响应示例（保存到文件）：

{
  "err": "ok",
  "msg": "音频已保存",
  "path": "/tmp/clone_preview.wav",
  "size": 1048576
}

tts_prompt_list — 提示词列表

使用场景：获取所有已保存的自定义语音提示词

权限：管理员

参数：无

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_prompt_list '{}'

响应示例：

{
  "err": "ok",
  "prompts": [
    { "name": "温柔女声", "desc": "温柔细腻的语调，语速偏慢，咬字清晰" },
    { "name": "沉稳男声", "desc": "沉稳厚重的语调，语速适中偏低" }
  ]
}

tts_prompt_save — 保存提示词

使用场景：将自定义音色描述保存为提示词（同名覆盖），存储于服务端 voice_prompts.json

权限：管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_prompt_save '{"name":"温柔女声","desc":"温柔细腻的语调，语速偏慢，咬字清晰，富有亲和力"}'

响应示例：

{
  "err": "ok",
  "msg": "提示词已保存"
}

tts_prompt_delete — 删除提示词

使用场景：删除指定的语音提示词

权限：管理员

参数：

执行脚本：

<skill-installation-path>/scripts/mybooks_api.py tts_prompt_delete '{"name":"温柔女声"}'

响应示例：

{
  "err": "ok",
  "msg": "提示词已删除"
}

使用场景决策指南

用户请求
│
├─ "书库有多少书？" / "统计书库"
│   → library_stats（详细分类统计）
│   → 或 get_user_info（快速总数）
│
├─ "我读了多少书？" / "阅读情况"
│   → reading_stats
│
├─ "找一下 XX 书" / "搜索 YY 作者"
│   → search_books（按关键词）
│
├─ "找 XX 分类下的书"
│   → search_by_category
│
├─ "XX 目录下有什么书" / "书库有哪些目录"
│   → search_by_folder / list_folders
│
├─ "查看书籍详情"
│   → get_book
│
├─ "这本书我都划了哪些线？" / "看看《XX》的批注/书签"
│   → get_notes（传 book_id 或 title；own:0 可连他人共享的批注一起看）
│
├─ "更新/补全《XX》的封面、简介、标签信息"（自动从网上获取）
│   → book_fill（需要管理员权限，传入 book_id 数组）
│
├─ "手动修改《XX》的标签/分类/书名等字段"
│   → 先 search_books 确认 book_id → 再 edit_book
│
├─ "把修改后的元数据也写入电子书文件本身" / "同步元数据到文件"
│   → save_meta_to_file（仅 epub/azw3/pdf，需管理员或书籍所有者权限）
│
├─ "把我在微信读书上的划线/想法导入这本书" / "导入第三方批注"
│   → 先确认目标书是 EPUB 格式，再用 push_notes（先 dry_run:true 预览，用户确认后再 dry_run:false 提交）
│   → 微信读书上有新批注后再次同步：直接把全量列表再传一遍 push_notes 即可，会自动判重，不用先清空
│
├─ "撤销/重置这本书导入的批注" / "刚才导入错了，重新来一遍"
│   → clear_imported_notes（只影响当前用户自己通过 push_notes 导入的批注），然后重新调 push_notes
│

├─ "把书发给我的 Kindle / 发到邮箱"
│   → mailto（发邮箱附件）
│
├─ "把书发到我的多看/掌阅/BOOX 设备"
│   → send_to_device（需设备在同一局域网并开启 WiFi 接收）
│
├─ "上传这本书" / "添加实体书"
│   → book_upload（电子书文件）
│   → book_add_by_isbn（实体书 ISBN）
│
├─ "这本书想读" / "加入待读清单"
│   → wants
│
├─ "收藏这本书"
│   → favorite
│
├─ "标记正在读" / "标记已读完"
│   → reading（read_state: 1 或 2）
│   → read_done（快捷标记已读完）
│
├─ "这本书读了多久？" / "读到哪了？" / "epub 版什么时候开始读的？"
│   → get_book_reading_stats（分格式的时长/进度/开始完成时间）
│
├─ "帮我补记这本书的阅读时长" / "标记这本书 XX 格式已读完"（无自动心跳的场景）
│   → update_book_reading_stats
│
├─ "补录某天的阅读时间" / "昨天晚上读了 45 分钟没记上"（v4.3.0+）
│   → set_reading_time（按日期覆盖）；查看用 get_reading_time；撤销用 delete_reading_time
│
├─ "我有哪些书单？" / "把这本书加到《XX》书单" / "新建一个书单"（v4.3.0+）
│   → list_my_booklists / booklist_add_books / create_booklist
│   → 看书单里的书：get_booklist；浏览大家的公开书单：list_public_booklists
│   → 这本书已经在哪些书单里：get_book_booklists
│
└─ "有哪些分类？" / "XX 作者有哪些书？"
    → categories / list_authors / get_author_books

TTS 场景

用户请求
│
├─ "配置 TTS API" / "设置 MiMo API Key"
│   → tts_save_config
│
├─ "测试 API 能不能用" / "连接正常吗"
│   → tts_test_connection
│
├─ "把这本书转成有声书" / "开始转换"
│   → tts_convert（需先有配置或直接传参）
│
├─ "转换到哪了" / "进度怎么样"
│   → tts_progress
│
├─ "上传克隆音色" / "我想用自己的声音"
│   → tts_clone_upload
│
├─ "有哪些克隆音色" / "看看上传的音色"
│   → tts_clone_list
│
├─ "删除克隆音色" / "不要这个音色了"
│   → tts_clone_delete
│
├─ "试听克隆音色" / "下载克隆音频"
│   → tts_clone_audio
│
├─ "有哪些提示词" / "保存的音色描述"
│   → tts_prompt_list
│
├─ "保存这个音色描述" / "存一个提示词"
│   → tts_prompt_save
│
└─ "删除提示词" / "不要这个描述了"
    → tts_prompt_delete

预置音色参考

MiMo TTS 类型（api_type=chat_completions）内置 9 个预置音色：

错误处理规范

注意事项

1. 认证：每次调用前脚本会自动登录，无需手动管理 Cookie；若未配置环境变量，脚本立即报错退出。
2. book_id：书籍的唯一整数标识符，可通过 search_books 或 get_book 获取。
3. book_fill 异步性：联网填充任务在后台运行，调用后立即返回；可通过 get_book 查看更新结果。
4. edit_book 标签替换：tags 参数会完整替换原有标签，如需追加请先 get_book 获取现有标签再合并传入。
5. send_to_device 限制：仅支持本地临时推送，不支持通过服务器中转到远程设备。
6. 在线数据源：book_fill 依赖豆瓣（douban）、百科（baike）等在线源，网络不可用或书籍较冷门时可能无结果。
7. 批量 book_fill：建议每批不超过 10 本，避免触发后台任务冲突（task.running 错误）。
8. TTS 管理员权限：所有 TTS 接口均需要管理员权限，普通用户无法使用。
9. TTS 异步转换：tts_convert 启动后台任务后立即返回，需用 tts_progress 轮询进度。
10. TTS 断点续传：重复转换同一本书时，自动跳过已存在的 WAV 文件（≥44 字节），中断后可继续。
11. TTS 音频输出：转换完成后，音频输出到 /audio/{book_id} 页面播放，也可通过 Web 界面访问。
12. TTS 克隆音色限制：MP3/WAV ≤ 7MB；上传后自动切换 mimo-v2.5-tts-voiceclone 模型。
13. TTS 提示词存储：提示词保存在服务端 voice_prompts.json，跨浏览器共享，不依赖本地存储。
14. TTS API Key 加密：API Key 经 PBKDF2-SHA256 + 流加密保存，密钥文件权限 0o600。
15. TTS 模型锁定：MiMo TTS 类型下模型 ID 固定为 mimo-v2.5-tts，不可修改；audio_speech 和 custom 类型可自由修改。