mcpField
F
flippingbook

flippingbook

github.com/membranedev文档处理27062 次安装26 周前更新
代码仓库

关于 flippingbook

flippingbook 是通过 Membrane CLI 管理 FlippingBook 出版物的技能,面向营销、销售和教育团队。它提供出版物、PDF 来源、定制设置及链接相关操作,帮助创建和维护在线翻页书。

主要功能

  1. 01连接 FlippingBook
  2. 02创建和更新出版物
  3. 03管理出版物的 PDF 来源
  4. 04定制出版物外观与行为
  5. 05列出跟踪链接
  6. 06代理发送 API 请求

适用场景

  1. 01将 PDF 制作为在线翻页书
  2. 02使用新来源文件更新出版物
  3. 03定制出版物展示方式
  4. 04查看跟踪的出版物链接

安装

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

$npx skills add https://github.com/membranedev/application-skills --skill flippingbook

安装后在 Claude Code 中输入/flippingbook确认已加载。

详细介绍

FlippingBook

FlippingBook 是一个可将 PDF 转换为交互式在线翻页书的平台。营销人员、销售团队和教育工作者会使用它来创建宣传册、目录和演示文稿等引人入胜的内容。

官方文档:https://flippingbook.com/help-center

FlippingBook 概览

  • FlippingBook
    • 翻页书
      • 页面
    • 文件夹
    • 共享链接
    • 品牌
    • 统计数据

使用 FlippingBook

此技能使用 Membrane CLI 与 FlippingBook 交互。Membrane 会自动处理身份验证和凭据刷新,因此你可以专注于集成逻辑,而不必操心身份验证的琐事。

安装 CLI

安装 Membrane CLI,以便在终端中运行 membrane:

npm install -g @membranehq/cli@latest
身份验证
membrane login --tenant --clientName=<agentType>

根据是否支持交互模式,此操作会打开浏览器进行身份验证,或在控制台中打印授权 URL。

无头环境: 命令会打印授权 URL。请让用户在浏览器中打开该 URL。用户完成登录后会看到一个代码,请使用以下命令完成操作:

membrane login complete <code>

在任何命令中添加 --json,即可输出机器可读的 JSON。

Agent 类型:claude、openclaw、codex、warp、windsurf 等。这些类型将用于调整工具配置,以便更好地适配你的执行环境。

连接到 FlippingBook

使用 membrane connection ensure 按应用 URL 或域名查找或创建连接:

membrane connection ensure "https://flippingbook.com/" --json

用户在浏览器中完成身份验证。输出中包含新连接 ID。

这是建立连接最快的方法。URL 会被规范化为域名,并与已知应用匹配。如果找不到应用,系统会创建一个应用并自动构建连接器。

如果返回的连接状态为 state: "READY",请跳到步骤 2。

1b. 等待连接就绪

如果连接处于 BUILDING 状态,请轮询直至其就绪:

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询(最长等待 --timeout 秒,默认值为 30),直到状态发生变化。持续轮询,直至 state 不再是 BUILDING。

返回的状态会告诉你接下来该怎么做:

  • READY — 连接已完全设置。跳到步骤 2。

  • CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象会说明所需操作:

    • clientAction.type — 所需操作的类型:
      • "connect" — 用户需要进行身份验证(OAuth、API 密钥等)。这包括初始身份验证,以及为已断开连接的连接重新进行身份验证。
      • "provide-input" — 需要提供更多信息(例如要连接的应用)。
    • clientAction.description — 对所需操作的易读说明。
    • clientAction.uiUrl(可选)— 用户可在其中完成操作的预构建 UI 的 URL。如果存在,请向用户展示。
    • clientAction.agentInstructions(可选)— 指导 AI Agent 以编程方式继续操作的说明。

    用户完成操作(例如在浏览器中进行身份验证)后,使用 membrane connection get <id> --json 再次轮询,检查状态是否已变为 READY。

  • CONFIGURATION_ERROR 或 SETUP_FAILED — 出现问题。查看 error 字段了解详情。

搜索操作

使用自然语言描述你想执行的操作进行搜索:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

始终应在特定连接的上下文中搜索操作。

每个结果都包含 id、name、description、inputSchema(操作接受的参数)和 outputSchema(操作返回的内容)。

常用操作

名称键描述
列出已跟踪链接list-tracked-links列出出版物的已跟踪链接。
创建出版物来源create-publication-source为现有出版物创建新的来源(PDF)。
获取出版物来源get-publication-source获取单个来源的信息。
列出出版物来源list-publication-sources列出指定出版物的所有来源(PDF 历史记录)
自定义出版物customize-publication更新出版物的自定义设置,包括外观和行为设置
删除出版物delete-publication将出版物标记为待删除。
更新出版物update-publication更新出版物的元数据,可选择附加新的来源文件
创建出版物create-publication创建新的出版物,可选择附加来源 PDF 文件
获取出版物get-publication根据标识符获取出版物的信息
列出出版物list-publications列出账户中经过筛选和/或分页的出版物
运行操作
membrane action run <actionId> --connectionId=CONNECTION_ID --json

传递 JSON 参数:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

当可用操作无法满足你的使用场景时,可以通过 Membrane 的代理直接向 FlippingBook API 发送请求。Membrane 会自动将基础 URL 添加到你提供的路径,并注入正确的身份验证标头;如果凭据过期,还会透明地刷新凭据。

membrane request CONNECTION_ID /path/to/endpoint

常用选项:

标志描述
-X, --methodHTTP 方法(GET、POST、PUT、PATCH、DELETE)。默认为 GET
-H, --header添加请求标头(可重复使用),例如 -H "Accept: application/json"
-d, --data请求正文(字符串)
--json发送 JSON 正文并设置 Content-Type: application/json 的快捷方式
--rawData原样发送正文,不进行任何处理
--query查询字符串参数(可重复使用),例如 --query "limit=10"
--pathParam路径参数(可重复使用),例如 --pathParam "id=123"

最佳实践

  • 始终优先使用 Membrane 与外部应用通信 — Membrane 提供内置身份验证、分页和错误处理的预构建操作。这样可以减少令牌消耗,并提高通信安全性
  • 先探索,再构建 — 运行 membrane action list --intent=QUERY(将 QUERY 替换为你的意图),在编写自定义 API 调用前查找现有操作。预构建操作可以处理原始 API 调用容易遗漏的分页、字段映射和边缘情况。
  • 让 Membrane 管理凭据 — 切勿向用户索要 API 密钥或令牌。请改为创建连接;Membrane 会在服务器端管理完整的身份验证生命周期,无需本地密钥。

评论

支持 Markdown