OpenClaw的插件开发需要遵循什么接口标准和规范?

酷芳小哥_1750

酷芳小哥_1750

2026-05-24

883人浏览

原创

openclaw插件必须满足五项核心要求才能被gateway识别:一、元数据需严格遵循openclaw.plugin.json规范;二、运行时须导出符合openclawplugin接口的类或对象;三、目录结构须满足posix权限与路径安全约束;四、构建产物须为es2020+ commonjs模块且禁用动态特性;五、configschema须符合json schema v7并确保类型与默认值一致。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

openclaw的插件开发需要遵循什么接口标准和规范?

如果您尝试为OpenClaw开发插件,但插件无法被Gateway识别或注册失败,则可能是由于未遵循其强制性的接口标准与结构规范。以下是确保插件合法加载与运行所必需满足的核心要求:

一、插件元数据接口标准

OpenClaw在加载任何插件前,首先读取openclaw.plugin.json(不可替换为package.json或其他名称),该文件是插件的唯一元数据凭证,必须严格符合JSON Schema校验规则。缺失、字段类型错误或权限声明越界均会导致发现阶段直接拒绝加载。

1、必须包含id字段,值为全小写ASCII字符加连字符组成的唯一标识符,禁止使用下划线、大写字母或空格。

2、main字段必须指向插件根目录下的相对路径入口文件,路径须以"./"开头且不得包含../逃逸序列。

3、permissions数组若存在,仅允许填写OpenClaw白名单中的能力标识,例如"file.read"、"http.request",不允许自定义权限字符串。

二、插件运行时API契约规范

插件在运行时必须导出一个符合OpenClawPlugin接口的类或对象,该接口定义了生命周期钩子与能力注册方法。Gateway通过调用register(api)函数完成能力绑定,此调用必须在模块顶层同步执行,不可包裹于异步回调或条件分支中。

1、register函数接收单个api参数,该参数为只读对象,禁止对其属性赋值或添加新键。

2、注册HTTP路由时,路径前缀必须为/plugins/{pluginId}/,不得注册根路径"/"或跨插件路径如"/api/"。

3、注册斜杠命令(Slash Command)时,command字段值须全小写且长度不超过32字符,禁止包含冒号、斜杠或控制字符。

三、目录结构与文件系统安全约束

OpenClaw采用声明式发现机制,对插件所在目录实施严格的POSIX权限与路径拓扑校验。违反任一约束将触发安全拦截,插件被标记为“untrusted”并静默跳过加载。

1、插件根目录所有者必须为当前运行OpenClaw进程的用户,若属主为root则仅当进程以root身份启动时才允许加载。

OpenClaw Money Maker
OpenClaw Money Maker

OpenClaw赚钱完整指南——平台、策略、工作流与自动化,教你如何像AI代理一样实现24/7盈利。

下载

2、目录权限掩码不得包含全局可写位(即octal 002),chmod 755为最低合规要求,777将导致立即拒绝。

3、所有源文件路径必须位于插件根目录内,禁止通过symbolic link指向外部路径,否则触发逃逸检测并终止加载。

四、类型系统与构建产物兼容性要求

尽管OpenClaw支持JavaScript与TypeScript源码,但最终交付给Gateway执行的必须是ES2020+语法、无动态import()、无Top-Level Await的CommonJS模块。构建工具链需确保输出符合运行时环境限制。

1、入口文件(main指定路径)必须导出默认值(export default),命名导出(export const x = ...)不被识别为有效插件主体。

2、若使用TypeScript,tsconfig.json中module必须设为commonjs,target不得低于ES2020,lib中禁止包含"dom",仅允许"es2020", "node"。

3、打包产物中不得包含eval()、Function constructor或vm模块调用,Webpack的eval-source-map模式将导致校验失败。

五、配置驱动能力注册规范

插件行为可通过configSchema声明运行时可配置项,该Schema用于生成UI表单及启动前参数校验。其结构直接影响插件在管理界面中的可用性与健壮性。

1、configSchema必须为合法JSON Schema v7对象,不支持$ref远程引用或循环引用。

2、每个属性的default值类型必须与type声明完全一致,字符串default不可设为null,布尔default不可设为0。

3、若声明required数组,则对应字段在插件启用前必须提供有效值,空字符串对string类型不视为有效,需显式设置为null或删除该字段。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

openclaw

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3128

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

4709

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3749

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

426

15

OpenClaw如何卸载
OpenClaw如何卸载

《OpenClaw如何卸载?OpenClawAI小龙虾安全卸载最新指南》为您提供详尽、安全的卸载步骤,帮助用户彻底移除OpenClaw及其相关组件。本指南针对Windows与macOS系统分别说明操作流程,涵盖停止后台进程、清除配置文件、删除残留数据等关键环节,确保无痕卸载,避免系统冲突或隐私泄露。无论您是因更换工具、解决兼容问题,还是出于安全考虑,本文都将助您高效、安心地完成卸载操作。请务必按照最新版本指引执行,以保障设备稳定与数据安

2026.03.19

140

11

OpenClaw安装部署教程
OpenClaw安装部署教程

本合集涵盖2026最新版OpenClaw(小龙虾)本地部署全流程,适用于Windows系统,包含环境配置、模型接入、Web界面启动及飞书/Telegram/QQ等多平台对接。无论你是小白还是开发者,10分钟内即可完成安装,快速体验AI智能体“长手干活”的强大能力!

2026.03.19

201

11

OpenClaw初学者教程:如何使用和设置
OpenClaw初学者教程:如何使用和设置

《OpenClawAI初学者教程:如何使用和设置》是一套面向新手的入门指南,涵盖环境搭建、基础配置、模型加载及简单推理操作。通过本教程,你将快速掌握OpenClawAI的核心功能,轻松开启AI开发之旅。

2026.03.19

141

13

OpenClawAI技能系统基础介绍:OpenClawAISkills是什么
OpenClawAI技能系统基础介绍:OpenClawAISkills是什么

OpenClawAI Skills 是 OpenClaw 智能体的核心功能模块,用于定义和管理 AI 可执行的具体能力,如查询天气、发送消息、操作文件等。通过技能系统,用户可灵活扩展智能体功能,实现高度定制化的自动化任务。

2026.03.20

898

20

龙虾OpenClaw安全使用指南
龙虾OpenClaw安全使用指南

围绕龙虾OpenClawAI使用中的安全风险,本合集系统梳理常见漏洞与隐患,提供实用防护方法与最新安全指南,帮助用户在稳定运行的同时规避风险,提升整体使用安全性与体验。

2026.03.20

149

11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程