agentic-workflows/schema/workflow.schema.json at main · ftchvs/agentic-workflows · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/ftchvs/agentic-workflows/schema/workflow.schema.json",
  "title": "Agentic Workflow",
  "description": "A repo-native operating file for controlled AI work.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "goal",
    "trigger",
    "inputs",
    "allowed_tools",
    "authority",
    "risk_level",
    "required_permissions",
    "external_side_effects",
    "destructive_actions",
    "dry_run",
    "approval_required",
    "steps",
    "verification",
    "artifacts",
    "memory_update"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "goal": {
      "type": "string",
      "minLength": 1
    },
    "trigger": {
      "type": "string",
      "minLength": 1
    },
    "inputs": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "allowed_tools": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "authority": {
      "type": "string",
      "enum": [
        "read_only",
        "local_write",
        "external_draft",
        "external_write_requires_approval",
        "destructive_forbidden"
      ]
    },
    "risk_level": {
      "type": "string",
      "enum": [
        "read-only",
        "local-write",
        "external-write",
        "destructive",
        "credentialed"
      ],
      "description": "Public safety label for the workflow."
    },
    "required_permissions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "description": "Permissions or access the workflow needs before it can run."
    },
    "external_side_effects": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "description": "External reads, writes, network calls, posts, messages, or account actions the workflow may cause."
    },
    "destructive_actions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "description": "Delete, overwrite, revoke, merge, publish, or other hard-to-reverse actions."
    },
    "dry_run": {
      "type": "string",
      "minLength": 1,
      "description": "Default no-side-effect behavior and what the workflow emits before any gated action."
    },
    "approval_required": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "description": "Actions that require explicit human approval before execution."
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "verification": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "artifacts": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "memory_update": {
      "type": "string",
      "minLength": 1,
      "description": "What durable, public-safe lesson should be saved after the workflow completes."
    }
  }
}