229 lines
9.5 KiB
JSON
229 lines
9.5 KiB
JSON
{
|
||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||
"$id": "https://openclaw.local/skill-template/skill-actions.schema.json",
|
||
"title": "SkillActionManifest",
|
||
"description": "匠厂 skill-template 对新技能的严格 Action manifest 规范（schemaVersion 1）。additionalProperties=false 表示模板推荐契约；宿主运行时可能为兼容历史 manifest 接受部分缺省字段，但新技能不应依赖缺省行为。",
|
||
"type": "object",
|
||
"required": ["schemaVersion", "skill", "actions"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"schemaVersion": {
|
||
"type": "integer",
|
||
"const": 1
|
||
},
|
||
"skill": {
|
||
"type": "string",
|
||
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
|
||
"description": "与 SKILL.md metadata.openclaw.slug 一致"
|
||
},
|
||
"actions": {
|
||
"type": "array",
|
||
"minItems": 1,
|
||
"items": { "$ref": "#/$defs/action" },
|
||
"description": "Action 列表。同一 placement（toolbar/row/batch）下，宿主按本数组中匹配项的相对顺序展示。toolbar/batch：表顶栏全部直接展示（无「更多操作」溢出）。row：行级入口，宿主可呈现为操作列、行右键和/或行内「⋯」（同一批 Action、同一顺序）；不在本字段配置排序、截断或菜单树。调整顺序即调整数组先后。无独立 sortOrder 字段。宿主内置刷新/导出/查看等不参与本顺序。表顶栏宽时左右横排，窄时左右分栏且栏内竖排。"
|
||
}
|
||
},
|
||
"$defs": {
|
||
"placement": {
|
||
"type": "string",
|
||
"enum": ["toolbar", "row", "batch", "cron", "agent", "skill-detail"],
|
||
"description": "稳定支持 toolbar/row/batch/cron/agent/skill-detail（对齐匠厂宿主）。row=行级入口（操作列/行右键/⋯ 等由宿主呈现，无独立 row-context-menu placement）。placements 与 executionProfile 正交，不做条件限制。"
|
||
},
|
||
"mutationKind": {
|
||
"type": "string",
|
||
"enum": ["create", "update", "delete"],
|
||
"description": "可选。接管数据管理默认按钮：create=新增、update=编辑、delete=删除。须配合非空 bind.tables；无配置时宿主仍直写 SQLite。"
|
||
},
|
||
"scalarArg": {
|
||
"type": ["string", "number", "boolean"]
|
||
},
|
||
"inputProperty": {
|
||
"type": "object",
|
||
"required": ["type"],
|
||
"additionalProperties": true,
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": ["string", "number", "boolean", "object"],
|
||
"description": "模板 Phase 1 仅推荐 string/number/boolean；根 inputSchema.type=object 的 properties 使用基础标量类型"
|
||
},
|
||
"title": { "type": "string" },
|
||
"description": { "type": "string" },
|
||
"default": {},
|
||
"enum": {
|
||
"type": "array",
|
||
"minItems": 1
|
||
},
|
||
"sensitive": { "type": "boolean" },
|
||
"readOnly": {
|
||
"type": "boolean",
|
||
"description": "宿主数据管理表单只读展示该字段（仍会随提交传入 entrypoint）；用于行内/勾选预填的主键等"
|
||
},
|
||
"column": {
|
||
"type": "string",
|
||
"minLength": 1,
|
||
"pattern": "^[a-z][a-z0-9_]*$",
|
||
"description": "可选。绑定业务表物理列名；replaces create/update 时宿主可复用该列的中文名与 lookup 下拉"
|
||
}
|
||
}
|
||
},
|
||
"inputSchema": {
|
||
"type": "object",
|
||
"required": ["type", "properties"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"type": { "const": "object" },
|
||
"required": {
|
||
"type": "array",
|
||
"items": { "type": "string" }
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"additionalProperties": { "$ref": "#/$defs/inputProperty" }
|
||
}
|
||
}
|
||
},
|
||
"entrypoint": {
|
||
"type": "object",
|
||
"required": ["type", "command", "args"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"type": { "const": "cli" },
|
||
"command": {
|
||
"type": "string",
|
||
"minLength": 1
|
||
},
|
||
"args": {
|
||
"type": "array",
|
||
"items": { "$ref": "#/$defs/scalarArg" },
|
||
"description": "仅允许 string/number/boolean 标量数组"
|
||
}
|
||
}
|
||
},
|
||
"confirmation": {
|
||
"type": "object",
|
||
"required": ["message"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"message": {
|
||
"type": "string",
|
||
"minLength": 1
|
||
}
|
||
}
|
||
},
|
||
"bind": {
|
||
"type": "object",
|
||
"required": ["tables"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"tables": {
|
||
"type": "array",
|
||
"minItems": 1,
|
||
"uniqueItems": true,
|
||
"items": {
|
||
"type": "string",
|
||
"minLength": 1,
|
||
"pattern": "^[a-z][a-z0-9_]*$",
|
||
"description": "英文 snake_case 业务表名；须真实存在于技能 SQLite / _jiangchang_tables"
|
||
},
|
||
"description": "数据管理表级绑定：决定 toolbar/row/batch Action 出现在哪些表。宿主兼容旧技能时，缺失 bind 可视为全表展示；新技能 toolbar Action 必须显式声明。"
|
||
},
|
||
"inputMapping": {
|
||
"type": "object",
|
||
"additionalProperties": { "type": "string", "minLength": 1 },
|
||
"description": "可选。将 $row.$pk / $row.col / $selection.ids 等映射到 inputSchema 字段名，供 row/batch 预填。"
|
||
},
|
||
"columnMapping": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string",
|
||
"minLength": 1,
|
||
"pattern": "^[a-z][a-z0-9_]*$"
|
||
},
|
||
"description": "可选。将 inputSchema 属性名映射到业务表物理列名，供 replaces create/update 抽屉复用列 displayName / lookup options。"
|
||
}
|
||
},
|
||
"description": "表级绑定；toolbar 必填。可选 inputMapping / columnMapping。concurrency/locks 勿写入。"
|
||
},
|
||
"action": {
|
||
"type": "object",
|
||
"required": ["id", "label", "description", "placements", "entrypoint", "executionProfile"],
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
|
||
"minLength": 1
|
||
},
|
||
"label": {
|
||
"type": "string",
|
||
"minLength": 1
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"minLength": 1
|
||
},
|
||
"placements": {
|
||
"type": "array",
|
||
"minItems": 0,
|
||
"items": { "$ref": "#/$defs/placement" },
|
||
"description": "决定 Action 出现在哪里；与 executionProfile 正交。仅 replaces 接管默认 CRUD 时可为空数组。数据管理 toolbar/row/batch 的顺序由顶层 actions 数组相对顺序决定。表顶栏 toolbar/batch 全部直接展示（无溢出菜单）；row 为行级入口（操作列/行右键/⋯），不在本字段配置排序、截断或菜单树。"
|
||
},
|
||
"replaces": { "$ref": "#/$defs/mutationKind" },
|
||
"entrypoint": { "$ref": "#/$defs/entrypoint" },
|
||
"inputSchema": { "$ref": "#/$defs/inputSchema" },
|
||
"confirmation": { "$ref": "#/$defs/confirmation" },
|
||
"executionProfile": {
|
||
"type": "string",
|
||
"enum": ["sync", "async"],
|
||
"description": "sync=调用方等待结构化结果（不建 Job）；async=宿主建后台 Job 并进任务中心。必须显式写出；长耗时建议 async，但不限制 placements。"
|
||
},
|
||
"interaction": {
|
||
"type": "string",
|
||
"enum": ["auto", "direct", "confirm", "form"],
|
||
"description": "数据管理等可点击入口的交互方式（与 executionProfile 正交）。direct=一点即跑；confirm=轻量确认（文案用 confirmation.message）；form=参数表单；auto/省略=宿主按 inputSchema+confirmation 推断。cron 触发与 agent 忽略本字段。"
|
||
},
|
||
"interactionByPlacement": {
|
||
"type": "object",
|
||
"additionalProperties": false,
|
||
"properties": {
|
||
"toolbar": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"row": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"batch": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"cron": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"agent": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"skill-detail": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"create": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"update": { "type": "string", "enum": ["direct", "confirm", "form"] },
|
||
"delete": { "type": "string", "enum": ["direct", "confirm", "form"] }
|
||
},
|
||
"description": "按 placement / replaces 覆盖 interaction（只能写 concrete 模式，不能写 auto）。"
|
||
},
|
||
"bind": { "$ref": "#/$defs/bind" }
|
||
},
|
||
"if": {
|
||
"properties": {
|
||
"placements": {
|
||
"contains": { "const": "toolbar" }
|
||
}
|
||
},
|
||
"required": ["placements"]
|
||
},
|
||
"then": {
|
||
"required": ["bind"]
|
||
},
|
||
"allOf": [
|
||
{
|
||
"if": {
|
||
"required": ["replaces"]
|
||
},
|
||
"then": {
|
||
"required": ["bind"]
|
||
}
|
||
}
|
||
],
|
||
"description": "concurrency/locks 为未稳定预留字段，勿写入新技能 manifest。placements 含 toolbar 或声明 replaces 时必须声明 bind.tables。无 replaces 时 placements 建议非空（模板测试强制）。"
|
||
}
|
||
}
|
||
}
|