@awebai/oats 0.22.0

package/docs/capability-manifest.schema.json

@@ -0,0 +1,223 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://oats.dev/schemas/capability-manifest.schema.json",
+  "title": "OATS capability package manifest",
+  "type": "object",
+  "required": [
+    "capability",
+    "version",
+    "description"
+  ],
+  "properties": {
+    "capability": {
+      "type": "string",
+      "pattern": "^(?:@?[a-z0-9][a-z0-9._-]*[./])[a-z0-9][a-z0-9._/-]*$"
+    },
+    "command": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9-]*$"
+    },
+    "version": {
+      "type": "string",
+      "minLength": 1
+    },
+    "compatibility": {
+      "type": "object",
+      "properties": {
+        "oats": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "oats"
+      ],
+      "additionalProperties": false
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1
+    },
+    "layer": {
+      "enum": [
+        "knowledge",
+        "messaging",
+        "tasks"
+      ]
+    },
+    "skills": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    },
+    "inject": {
+      "type": "string"
+    },
+    "environment": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,127}$"
+      },
+      "uniqueItems": true,
+      "description": "Exact launch-environment names this artifact asks the executable trust gate to approve; spawn hook output must be a subset."
+    },
+    "requires": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "title": "host command requirement",
+            "description": "A command that must be present on PATH before the capability can work.",
+            "type": "object",
+            "required": [
+              "command",
+              "why"
+            ],
+            "properties": {
+              "command": {
+                "type": "string"
+              },
+              "why": {
+                "type": "string"
+              },
+              "install": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false
+          },
+          {
+            "title": "runtime package requirement",
+            "description": "A package that must be installed into a specific runtime's own package manager. Raised only for deployments using that runtime, satisfied by the runtime's package list rather than by PATH, and installed only with explicit consent.",
+            "type": "object",
+            "required": [
+              "runtime",
+              "package",
+              "why"
+            ],
+            "properties": {
+              "runtime": {
+                "type": "string",
+                "enum": [
+                  "pi",
+                  "claude"
+                ]
+              },
+              "package": {
+                "type": "string",
+                "description": "Source spec in that runtime's own naming: \"npm:@scope/name\" for pi, \"plugin@marketplace\" for Claude."
+              },
+              "why": {
+                "type": "string"
+              },
+              "install": {
+                "type": "string",
+                "description": "Documentation URL shown alongside the consent prompt."
+              },
+              "marketplace": {
+                "type": "string",
+                "description": "Optional source to register before installing (Claude marketplaces). Shown at the consent prompt, since registering a third-party source is part of what is being agreed to."
+              }
+            },
+            "additionalProperties": false
+          }
+        ]
+      }
+    },
+    "commands": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[a-z0-9][a-z0-9-]*$"
+      },
+      "additionalProperties": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "hooks": {
+      "type": "object",
+      "properties": {
+        "soul-scaffold": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "required": [
+                "command"
+              ],
+              "properties": {
+                "command": {
+                  "type": "string"
+                },
+                "required": {
+                  "const": false,
+                  "description": "Only the spawn hook may be required \u2014 retire and soul-scaffold run outside a spawn transaction."
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
+        "spawn": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "required": [
+                "command"
+              ],
+              "properties": {
+                "command": {
+                  "type": "string"
+                },
+                "required": {
+                  "type": "boolean",
+                  "description": "When true, a failure fails the spawn and rolls it back."
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
+        "retire": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "required": [
+                "command"
+              ],
+              "properties": {
+                "command": {
+                  "type": "string"
+                },
+                "required": {
+                  "const": false,
+                  "description": "Only the spawn hook may be required \u2014 retire and soul-scaffold run outside a spawn transaction."
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "agents": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Package-relative soul directories (soul.yaml + AGENTS.md) \u2014 capability-defined agents; they resolve like local souls where the capability is active, souls stay read-only in the package, instances home under the scope's local-agents/."
+    }
+  },
+  "additionalProperties": false
+}