OpenClaw Codex

文章

插件入门:把“一个能力”做成可复用插件

插件不是“方便装一下”的小脚本,而是运行在网关进程里的代码。写插件的目标是可复用,可控,可审计,可回滚。

先说安全边界

插件与网关同进程运行。不要在公开文章里贴真实配置,不要把密钥写进代码示例。你要写的是结构、边界和占位符。

一个可运营插件应该具备的四件事

  • 清晰的配置入口:每个参数都有默认值和约束。
  • 可观察:关键路径日志、可关联的请求 id、失败原因可定位。
  • 可回滚:升级失败能回到上一版本,不破坏数据格式。
  • 最小权限:只拿必要的 token,只调用必要的外部接口。

目录骨架(示例)

真实字段以官方 Plugins 文档为准,这里只展示“运营友好”的最小结构。

my-plugin/
  openclaw.plugin.json
  package.json
  src/
    index.ts
  README.md

配置占位符写法

公开内容里,永远用占位符,并标注“从哪里来”。

{
  "plugins": {
    "entries": {
      "my-plugin": {
        "enabled": true,
        "config": {
          "apiBaseUrl": "<YOUR_API_BASE_URL>",
          "apiKey": "<STORE_IN_SECRET_MANAGER>",
          "timeoutMs": 8000
        }
      }
    }
  }
}

写作建议:让读者“看完能复用”

  • 把文章写成清单:输入是什么,输出是什么,失败怎么定位。
  • 强调升级策略:版本号、变更点、如何回滚。
  • 给“最小闭环”:先跑通 1 条消息,再扩展到更多通道。

进一步阅读(官方)

官方 Plugins 文档