OpenClaw Contract Review Plugin
OpenClaw 合同审核插件,可作为独立 npm 包安装并由 OpenClaw 宿主加载。
环境要求
- Node.js 22 LTS+
- npm 10+
快速开始
作为 npm 包安装
npm install openclaw-contract-review-plugin
安装后的包内只包含发布态资产:dist/、openclaw.plugin.json、README.md 与 package.json 元数据;本地 Skill 资产与 Skill 校验脚本不会进入 tarball。
作为仓库工程开发
- 复制环境变量模板
- 安装依赖
- 执行质量校验
cp .env.example .env
npm install
npm run check
OpenClaw 宿主通过 openclaw.plugin.json 与 package.json.openclaw.extensions 读取同一个发布态入口 dist/index.js。
插件配置
插件通过 openclaw.plugin.json 的 configValues 字段或环境变量进行配置。
最小配置示例
{
"authBaseUrl": "http://localhost:3001",
"agentRestBaseUrl": "http://localhost:8100",
"a2aBaseUrl": "http://localhost:8080"
}
字段说明
| 字段 | 指向服务 | 默认端口 | 说明 |
|---|---|---|---|
authBaseUrl | lawyer-home | 3001 | 认证服务(登录、token 刷新、绑定)。默认路径由此地址推导(/api/auth/*)。 |
agentRestBaseUrl | lawyer-agent REST | 8100 | 业务 REST API(文件上传、状态查询、artifact 获取)。 |
a2aBaseUrl | lawyer-agent A2A | 8080 | 合同审核任务提交(A2A 协议)。 |
backendBaseUrl | — | — | [deprecated] 迁移期兼容字段。若 agentRestBaseUrl 未设置,此值用作 fallback。建议新部署使用 authBaseUrl + agentRestBaseUrl 替代。 |
说明:
authBaseUrl与agentRestBaseUrl分别对应认证服务与合同审核 Agent 服务,两者不可混用。
发布边界
- Plugin 通过 npm 分发,入口固定为
dist/index.js openclaw.plugin.json保留宿主加载所需 manifest 契约- Feature 099 已将 Skill 资产外置;本包不再携带
skills/、src/skills/或 Skill 专属校验脚本 npm run package:validate会执行npm pack --dry-run --json并校验 tarball 白名单/黑名单
常用命令
npm run dev:启动插件入口npm run dev:mock-backend:启动本地 mock backendnpm run lint:执行 ESLintnpm run typecheck:执行 TypeScript 严格类型检查npm run test:执行全部测试npm run build:构建dist/npm run package:validate:校验 npm tarball 内容边界npm run prepublishOnly:执行发布前完整门禁
目录说明
src/:插件源码tests/:unit / contract / integration / smoke 测试scripts/:开发、校验、发布辅助脚本docs/:架构与流程文档