跳转到内容

第一个插件

准备已安装的 OpenAgent、Git,以及用于下列创作命令的 Bun 1.2 或更新版本。运行公开 Plugin Kit 自身测试时,遵守它的运行时要求。桌面监管的 JavaScript 插件使用 OpenAgent 内置 Node.js;在桌面之外直接运行脚本时再准备 Node.js。开发插件不需要访问 OpenAgent 的私有 SDK,也不需要从源码构建桌面应用。

从你的项目根目录执行。示例把插件放在 plugins/,工具链放在 tools/;已有项目约定时沿用项目目录。

Terminal window
git clone https://github.com/BANG404/openagent-plugin-kit.git tools/openagent-plugin-kit
bun tools/openagent-plugin-kit/scripts/new-plugin.mjs project-notes --template minimal --dir plugins

生成的目录为 plugins/project-notes/。让 plugin.json 保持在包根目录,保留模板生成的协议兼容性和语言声明。

将生成的 skills/ 子目录改名为 project-notes,移除不用的示例 Skill,然后把其中的 SKILL.md 替换为:

---
name: project-notes
description: 当用户要求记录或回顾项目决策时,整理项目决策摘要。
---
先阅读相关项目文件,再总结。
区分已经确认的决策与待解决的问题。
用户要求保存时,写入用户指定的项目路径。
附上文件引用,不包含凭据。

Skill 从 skills/ 的直接子目录发现,必须有 YAML name 和 description;name 与目录名一致,只使用 1–64 个小写字母、数字或单个连字符。Skill 提供指令,本身不会注册可执行工具。是否加载取决于任务,因此描述要明确适用场景。

Terminal window
bun tools/openagent-plugin-kit/scripts/validate-plugin.mjs plugins/project-notes --require-i18n

安装前修复错误并检查警告。校验器检查包结构,不执行插件命令或服务。只声明已经覆盖元数据和可见界面的 UI 语言。

打开 集成 → 插件 → 安装,选择 plugins/project-notes/。启用插件,打开项目对话,让 Agent 使用 project-notes 总结一项具体决策。

OpenAgent 会把源码复制到托管插件目录,并为本地安装关联所选源码目录。修改后,源码同步会校验并替换已安装副本;也可点击已安装卡片或“已安装”工具栏的刷新明确请求同步。激活会等待活动会话任务结束,无效修改保留可工作的安装。关联、刷新和诊断方法见本地开发。

隔离验收时使用独立测试安装或任务专属的 OPENAGENT_HOME,保留日常数据。再提交一个与项目决策无关的请求,确认 Skill 描述不会引起无关加载。

确认目标任务能发现 Skill、引用真实项目文件,并遵守选定的审批策略,再阅读插件包约定。

安装插件开发助手(openagent-plugin-kit),通过 /openagent-plugin-kit:create 工作流创建和验收插件。辅助开发流程说明创建、报告、恢复与验收,也列出所需 Runtime 前提。