Skip to content

Commit 7f64c4e

Browse files
authored
Merge pull request #220 from GitHubSecurityLab/copilot/fix-version-numbers-in-readme-and-docs
Align README/GRAMMAR docs with current YAML versioning and Jinja templating syntax
2 parents c08ad8c + b737e23 commit 7f64c4e

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -290,11 +290,11 @@ seclab-taskflow-agent:
290290
filetype: taskflow
291291
```
292292

293-
The `version` number in the header is currently 1. It means that the
294-
file uses version 1 of the seclab-taskflow-agent syntax. If we ever need
293+
The `version` in the header is currently `"1.0"`. It means that the
294+
file uses version 1.0 of the seclab-taskflow-agent syntax. If we ever need
295295
to make a major change to the syntax, then we'll update the version number.
296296
This will hopefully enable us to make changes without breaking backwards
297-
compatibility. Version can be specified as an integer, float, or string.
297+
compatibility. The version should be specified as a string (e.g. `"1.0"`).
298298

299299
The `filetype` determines whether the file defines a personality, toolbox, etc.
300300
This means that different types of files can be stored in the same directory.
@@ -318,7 +318,7 @@ Example:
318318
```yaml
319319
# personalities define the system prompt level directives for this Agent
320320
seclab-taskflow-agent:
321-
version: 1
321+
version: "1.0"
322322
filetype: personality
323323
324324
personality: |
@@ -385,7 +385,7 @@ For example, to start a stdio MCP server that is implemented in a python file:
385385
```yaml
386386
# stdio mcp server configuration
387387
seclab-taskflow-agent:
388-
version: 1
388+
version: "1.0"
389389
filetype: toolbox
390390
391391
server_params:
@@ -433,7 +433,7 @@ Example:
433433

434434
```yaml
435435
seclab-taskflow-agent:
436-
version: 1
436+
version: "1.0"
437437
filetype: taskflow
438438
439439
taskflow:
@@ -499,7 +499,7 @@ taskflow:
499499
agents:
500500
- seclab_taskflow_agent.personalities.assistant
501501
user_prompt: |
502-
What kind of fruit is {{ RESULT }}?
502+
What kind of fruit is {{ result }}?
503503
```
504504
505505
Taskflows support [Agent handoffs](https://openai.github.io/openai-agents-python/handoffs/). Handoffs are useful for implementing triage patterns where the primary Agent can decide to handoff a task to any subsequent Agents in the `Agents` list.
@@ -517,18 +517,18 @@ hatch run main -t examples.taskflows.CVE-2023-2283
517517

518518
Prompts are configured through YAML files of `filetype` `prompt`. They define a reusable prompt that can be referenced in `taskflow` files.
519519

520-
They contain only one field, the `prompt` field, which is used to replace any `{{ PROMPT_<import-path> }}` template parameter in a taskflow. For example, the following `prompt`.
520+
They contain only one field, the `prompt` field. Reusable prompts can be referenced in tasks using Jinja2's `{% include '<import-path>' %}` directive. For example, the following `prompt`.
521521

522522
```yaml
523523
seclab-taskflow-agent:
524-
version: 1
524+
version: "1.0"
525525
filetype: prompt
526526
527527
prompt: |
528528
Tell me more about bananas as well.
529529
```
530530

531-
would replace any `{{ PROMPT_examples.prompts.example_prompt }}` template parameter found in the `user_prompt` section in a taskflow:
531+
can be referenced from the `user_prompt` section in a taskflow:
532532

533533
```yaml
534534
- task:
@@ -537,7 +537,7 @@ would replace any `{{ PROMPT_examples.prompts.example_prompt }}` template parame
537537
user_prompt: |
538538
Tell me more about apples.
539539
540-
{{ PROMPTS_examples.prompts.example_prompt }}
540+
{% include 'examples.prompts.example_prompt' %}
541541
```
542542

543543
becomes:
@@ -558,7 +558,7 @@ Model configs are configured through YAML files of `filetype` `model_config`. Th
558558

559559
```yaml
560560
seclab-taskflow-agent:
561-
version: 1
561+
version: "1.0"
562562
filetype: model_config
563563
models:
564564
gpt_latest: gpt-5

doc/GRAMMAR.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For example, to use the `personality` defined in the following:
3636

3737
```yaml
3838
seclab-taskflow-agent:
39-
version: 1
39+
version: "1.0"
4040
filetype: personality
4141
4242
personality: |
@@ -456,7 +456,7 @@ and `examples.prompts.example_prompt` is the following:
456456

457457
```yaml
458458
seclab-taskflow-agent:
459-
version: 1
459+
version: "1.0"
460460
filetype: prompt
461461
462462
prompt: |
@@ -481,7 +481,7 @@ LLM models can be configured in a taskflow by setting the `model_config` field t
481481

482482
```yaml
483483
seclab-taskflow-agent:
484-
version: 1
484+
version: "1.0"
485485
filetype: taskflow
486486
487487
model_config: examples.model_configs.model_config
@@ -491,7 +491,7 @@ The variables defined in the `model_config` file can then be used throughout the
491491

492492
```yaml
493493
seclab-taskflow-agent:
494-
version: 1
494+
version: "1.0"
495495
filetype: model_config
496496
models:
497497
gpt_latest: gpt-5

0 commit comments

Comments
 (0)