Skip to content

插件开发快速上手

迁移来源:docs/PLUGIN_DEVELOPER_QUICKSTART.md

这篇适合第一次给 Workova 开发插件的人。

如果你现在只想先把第一个插件跑起来,不想一开始就看完整协议,先看这篇就够了。

读完后你应该能做到什么

  1. 知道插件文件应该放哪里
  2. 知道最小 plugin.manifest.json 怎么写
  3. 知道怎么把插件接进 Agent
  4. 知道出问题时先去哪里排查

Workova 里常见的 3 类插件

skill

更适合技能增强、提示增强、总结类能力。

tool

更适合命令、本地工具、脚本、外部服务调用。

channel

更适合 IM、Webhook、消息渠道接入。

建议

第一次写插件,优先从 tool 开始。
它最容易做、最容易调试、也最容易看见结果。

插件建议放哪里

Workova 会扫描这些目录:

  • .agents/plugins
  • plugins
  • $CODEX_HOME/plugins
  • ~/.codex/plugins

最推荐的是直接放在当前项目里:

text
.agents/plugins/your-plugin/

最小目录结构

text
.agents/plugins/hello-workova/
  plugin.manifest.json

推荐开发顺序

  1. 先创建目录
  2. 先写最小 manifest
  3. 先让系统识别到插件
  4. 再补命令、脚本和配置

下一步看什么

内容通过 Markdown 维护,适合持续迭代。