agentfile/schema/workflow.schema.json at main · TisoneK/agentfile · 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/TisoneK/agentfile/schema/workflow.schema.json",
  "title": "Agentfile Workflow",
  "description": "Schema for Agentfile workflow.yaml configuration files.",
  "type": "object",
  "required": [
    "name",
    "version",
    "description",
    "trigger",
    "steps",
    "specVersion"
  ],
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "Workflow identifier. Lowercase, hyphenated.",
      "pattern": "^[a-z][a-z0-9-]*$",
      "examples": [
        "code-reviewer",
        "pr-summarizer",
        "doc-generator"
      ]
    },
    "version": {
      "type": "string",
      "description": "Semantic version of this workflow.",
      "pattern": "^\\d+\\.\\d+\\.\\d+$",
      "examples": [
        "1.0.0",
        "2.1.0"
      ]
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of what this workflow does."
    },
    "execution": {
      "type": "object",
      "description": "Execution preferences for this workflow.",
      "additionalProperties": false,
      "properties": {
        "preferred": {
          "type": "string",
          "description": "Preferred execution mode for IDE environments.",
          "enum": [
            "ide",
            "cli"
          ],
          "default": "ide",
          "examples": [
            "ide",
            "cli"
          ]
        }
      }
    },
    "trigger": {
      "type": "object",
      "description": "Defines how and when this workflow is started.",
      "required": [
        "type"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "description": "The trigger mechanism.",
          "enum": [
            "natural-language",
            "file",
            "schedule",
            "command"
          ]
        },
        "input_var": {
          "type": "string",
          "description": "Environment variable name that holds the trigger input.",
          "examples": [
            "AGENT_INPUT",
            "WORKFLOW_REQUEST"
          ]
        }
      }
    },
    "output": {
      "type": "object",
      "description": "Where the workflow's final output is written.",
      "additionalProperties": false,
      "properties": {
        "directory": {
          "type": "string",
          "description": "Target directory for the final output.",
          "examples": [
            "workflows/{workflow_name}",
            "outputs/"
          ]
        }
      }
    },
    "steps": {
      "type": "array",
      "description": "Ordered list of steps to execute.",
      "minItems": 1,
      "items": {
        "oneOf": [
          {
            "$ref": "#/definitions/agentStep"
          },
          {
            "$ref": "#/definitions/shellStep"
          }
        ]
      }
    },
    "specVersion": {
      "type": "string",
      "description": "Agentfile spec version this workflow targets.",
      "enum": [
        "1.0"
      ],
      "examples": [
        "1.0"
      ]
    }
  },
  "definitions": {
    "agentStep": {
      "type": "object",
      "title": "Agent Step",
      "description": "A step that calls an LLM agent.",
      "required": [
        "id",
        "name",
        "agent",
        "input",
        "goal",
        "produces"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique step identifier. Lowercase, hyphenated.",
          "pattern": "^[a-z][a-z0-9-]*$"
        },
        "name": {
          "type": "string",
          "description": "Human-readable step name."
        },
        "agent": {
          "type": "string",
          "description": "Relative path to the agent .md file.",
          "examples": [
            "agents/reviewer.md",
            "agents/analyst.md"
          ]
        },
        "skill": {
          "type": "string",
          "description": "Relative path to a skill .md file to inject into the user prompt.",
          "examples": [
            "skills/code-analysis.md",
            "skills/write-review.md"
          ]
        },
        "input": {
          "type": "string",
          "description": "Input to the step. A file path or $VAR reference.",
          "examples": [
            "$AGENT_INPUT",
            "outputs/analysis.md"
          ]
        },
        "goal": {
          "type": "string",
          "description": "What this step is trying to achieve."
        },
        "produces": {
          "type": "string",
          "description": "Path to the artifact this step writes.",
          "examples": [
            "outputs/analysis.md",
            "outputs/review.md"
          ]
        },
        "gate": {
          "type": "string",
          "description": "If set to human-approval, pause for user confirmation before continuing.",
          "enum": [
            "human-approval"
          ]
        }
      }
    },
    "shellStep": {
      "type": "object",
      "title": "Shell Step",
      "description": "A step that runs a shell script directly.",
      "required": [
        "id",
        "name",
        "action",
        "script",
        "goal"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique step identifier. Lowercase, hyphenated.",
          "pattern": "^[a-z][a-z0-9-]*$"
        },
        "name": {
          "type": "string",
          "description": "Human-readable step name."
        },
        "action": {
          "type": "string",
          "description": "Must be 'shell' for shell steps.",
          "enum": [
            "shell"
          ]
        },
        "script": {
          "type": "object",
          "description": "Paths to the scripts to execute.",
          "additionalProperties": false,
          "properties": {
            "bash": {
              "type": "string",
              "description": "Path to the Bash script.",
              "examples": [
                "scripts/register.sh"
              ]
            },
            "pwsh": {
              "type": "string",
              "description": "Path to the PowerShell script.",
              "examples": [
                "scripts/register.ps1"
              ]
            }
          }
        },
        "goal": {
          "type": "string",
          "description": "What this step does."
        }
      }
    }
  }
}