1. 认准安装目标
先识别目标客户端、电脑和操作系统。用户明确指定安装目标时,以该目标为准;未另行指定时使用当前环境。代操作 Agent 不一定是安装目标:例如用户让 Claude Code 帮忙装到 Codex,仍按 Codex 安装。先确认你能操作目标电脑,远程环境中的安装不等于用户本机已安装。 各软件的命令和界面步骤只写在连接指引里:读https://docs.study.faroapi.cn/connect/<软件>.md ;不确定是哪个软件,先读 https://docs.study.faroapi.cn/connect/overview.md 。没有对应页时,按总览「列表里没有你的软件」核对 Skill、远程 HTTP MCP 和网页授权支持,再提方案。
不能联网或操作本机时,说明缺哪项能力,把连接指引里那一页的地址给用户。不要只返回“安装完成”。
2. 从官方仓库安装
官方插件仓库是moonlight-code-space/open-study,稳定安装分支是 plugin-stable。仓库已经公开,不需要仓库权限,也不必让用户重新登录 GitHub。
先查看目标客户端里是否已有 Open Study 及其来源。已有官方 GitHub 来源时,按连接指引里那一页的「更新」处理,保留原来源和安装范围;不要用本地下载目录覆盖它。来源是本地目录、其他仓库,或存在冲突时,先保留原配置并说明情况;需要迁移时让用户选择,不删除旧插件来绕过报错。
确认是首次安装后,按那一页的命令或界面步骤安装;第一条命令失败时先处理错误,不继续下一条。使用用户当前的权限范围,不自行改系统权限来强行安装。
3. 首次安装连不上 GitHub 时,可选择官方下载包
下载包是备用安装方式,会注册本地目录作为来源。已经从 GitHub 安装的,暂时连不上时保留原插件,恢复连接后更新;不要自动把来源改成本地目录。 官方发布入口:Open Study → 快速开始。按页面提供的版本下载;页面要求登录时,让用户完成网页登录。 下载地址里带版本号,旧链接不一定是最新版本。请以页面当前展示的版本为准,不要直接复用写死版本号的旧地址。形状是:open-study-plugin-v<版本>.zip;直接下载时请保存为 .zip 再解压。同名的 .zip 地址也可用,两者字节相同。如果返回网页或错误,不要当成安装包执行;让用户从官方页面下载并提供文件。
完整解压到用户准备长期保留的目录,找到包含以下文件的那一层:
INSTALL.md、插件声明和安装脚本后再运行;不要仅复制一个脚本,也不要在临时下载目录安装后把来源目录删掉。macOS / Linux 另需 python3 --version。在完整解压目录运行:
- macOS / Linux
- Windows
open-study@open-study。成功后说明安装版本和来源目录;下载包只是不依赖 GitHub 的安装方式,使用仍需联网。这个包同时带着 Codex 和 Claude Code 的清单,Codex、Claude Code、ZCode 都用它,各自怎么装见那一页;Claude Code 桌面端要用网站上的 .plugin 文件,传 ZIP 会报找不到 plugin.json。
4. 授权
- 插件已经带着产品 MCP 地址
https://study.faroapi.cn/mcp,不要再添加一份,也不要换成文档站的 MCP。 - 安装成功不等于已经授权;已有授权且能读取资料时无需重复登录。
- 由你发起授权,不要只告诉用户去哪里点。 不少软件的授权按钮点了不会打开浏览器,用户会以为没反应。按下面的顺序做,哪一步成功就停:
- 工具列表里有 open-study 的授权工具(名字里带
authenticate),直接调用,拿到授权链接。 - 这个软件有给 MCP 服务登录的命令,而你能运行命令时,由你运行。各软件的命令写在连接指引那一页的「授权」。用默认方式运行,不加
--no-browser一类要求把回跳地址粘贴回去的参数;命令会打印授权链接、在本机等待回调,要让它一直运行到报告成功。 - 拿到
https://study.faroapi.cn/authorize开头的链接后,用系统默认浏览器替用户打开,同时把链接原样发给用户备用。别的网址一律不要转发。 - 拿不到链接时(只能在界面里点的软件),按连接指引那一页,结合软件自己的设置或帮助,请用户说出看到了什么,再一步步指到 MCP 设置里 open-study 那一行的授权按钮。菜单会随版本变,以用户看到的为准。
- 工具列表里有 open-study 的授权工具(名字里带
- 发链接时提醒用户:在运行这个软件的同一台电脑上完成;网站没登录先登录;链接有时效,几分钟内点完。链接过期或命令退出了,就重新发起一次。
- 登录和浏览器里的 允许连接 只能用户本人完成。不要用浏览器自动化或电脑操作工具替用户填写或点击;不要改软件的权限、沙箱或审批设置,不要新增或删除 MCP 服务条目,不要读写软件保存的登录凭据。软件要你批准联网或本机端口时,告诉用户批准的是什么。
- 以软件收到回调并显示授权成功为准,单独登录网站不算。
- 用户还没有账号时,先到 study.faroapi.cn 注册。网站和 Agent 要连接同一个账号。
5. 交给用户确认能用
装插件的这个对话里,新插件还没加载。提醒用户重启后在新对话里发一条视频链接测试;只想确认连上、不整理新视频的,可以发那一页「确认能用」那句:library_search 查已有资料,需要看连接状态时调 system_status;没有调用结果不算连上。你不是被安装的那个软件时,不要拿本机已有的连接冒充。这一步只查已有资料,不提交视频、不重新整理,也不生成网站 AI 结果。
需要新开对话时,如果用户已经交代工作目标,给一段已填好的接力提示词,带上原目标、已有链接或内容 ID、资料的实际状态和下一步产出。有任务编号时一并带上,按原任务继续,不因换对话重复整理。不要让用户重新填写背景,也不要把尚未取得的资料写成已保存。
接下来按第一次使用说明任务或发送链接,或使用学习与工作模板。