Skip to content

Commit 8aea876

Browse files
committed
Clean up documentation, add additional Docker example
1 parent 3ae0ae7 commit 8aea876

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can find a detailed overview of the taskflow grammar [here](https://github.c
2020

2121
## Use Cases and Examples
2222

23-
The Seclab Taskflow Agent framework was primarily designed to fit the iterative feedback loop driven work involved in Agentic security research workflows and vulnerability triage tasks.
23+
The Seclab Taskflow Agent framework was primarily designed to fit the iterative feedback loop driven work involved in Agentic security research workflows and vulnerability triage tasks.
2424

2525
Its design philosophy is centered around the belief that a prompt level focus of capturing vulnerability patterns will greatly improve and scale security research results as frontier model capabilities evolve over time.
2626

@@ -76,15 +76,15 @@ python main.py -t example
7676

7777
## Deploying from Docker
7878

79-
You can deploy the Taskflow Agent via its Docker image using `docker/run.sh`.
79+
You can deploy the Taskflow Agent via its Docker image using `docker/run.sh`.
8080

8181
WARNING: the Agent Docker image is _NOT_ intended as a security boundary but strictly a deployment convenience.
8282

8383
The image entrypoint is `main.py` and thus it operates the same as invoking the Agent from source directly.
8484

8585
You can find the Docker image for the Seclab Taskflow Agent [here](https://github.com/GitHubSecurityLab/seclab-taskflow-agent/pkgs/container/seclab-taskflow-agent) and how it is built [here](release_tools/).
8686

87-
Note that this image is based on a public release of the Taskflow Agent, and you will have to mount any custom taskflows, personalities, or prompts into the image for them to be available to the Agent.
87+
Note that this image is based on a public release of the Taskflow Agent, and you will have to mount any custom taskflows, personalities, or prompts into the image for them to be available to the Agent.
8888

8989
Optional image mount points to supply custom data are configured via the environment:
9090

@@ -107,6 +107,12 @@ Example: deploying a custom taskflow (custom_taskflow.yaml):
107107
MY_TASKFLOWS=~/my_taskflows docker/run.sh -t custom_taskflow
108108
```
109109

110+
Example: deploying a custom taskflow (custom_taskflow.yaml) and making local CodeQL databases available to the CodeQL MCP server:
111+
112+
```sh
113+
MY_TASKFLOWS=~/my_taskflows MY_DATA=~/codeql_databases CODEQL_DBS_BASE_PATH=/app/my_data docker/run.sh -t custom_taskflow
114+
```
115+
110116
For more advanced scenarios like e.g. making custom MCP server code available, you can alter the run script to mount your custom code into the image and configure your toolboxes to use said code accordingly.
111117

112118
Example: a custom MCP server deployment via Docker image:
@@ -163,7 +169,7 @@ personality: |
163169
164170
task: |
165171
Echo user inputs using the echo tools.
166-
172+
167173
# personality toolboxes map to mcp servers made available to this Agent
168174
toolboxes:
169175
- echo
@@ -210,13 +216,13 @@ taskflow:
210216
`vulnerable_c_example` memory key and explain why `strcpy`
211217
is insecure in the C programming language. Do this before handing off
212218
to any other agent.
213-
219+
214220
Then provide a summary of a high impact CVE ID that involved a `strcpy`
215221
based buffer overflow based on your GHSA knowledge as an additional
216222
example.
217223

218224
Finally, why are apples and oranges healthy to eat?
219-
225+
220226
# taskflows can set temporary environment variables, these support the general
221227
# "{{ env FROM_EXISTING_ENVIRONMENT }" pattern we use elsewhere as well
222228
# these environment variables can then be made available to any stdio mcp server
@@ -252,11 +258,11 @@ Taskflows support [Agent handoffs](https://openai.github.io/openai-agents-python
252258

253259
See the [taskflow examples](taskflows/examples) for other useful Taskflow patterns such as repeatable and asynchronous templated prompts.
254260

255-
## License
261+
## License
256262

257263
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
258264

259-
## Maintainers
265+
## Maintainers
260266

261267
[CODEOWNERS](./CODEOWNERS)
262268

0 commit comments

Comments
 (0)