You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-14Lines changed: 34 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,22 @@
1
+
# Seclab Taskflow Agent
2
+
1
3
The Security Lab Taskflow Agent is an MCP enabled multi-Agent framework.
2
4
3
-
The Taskflow Agent is built on top of the [OpenAI Agents SDK](https://openai.github.io/openai-agents-python/) in contrast to the largely custom backend implementations of our original Copilot extensions framework.
5
+
The Taskflow Agent is built on top of the [OpenAI Agents SDK](https://openai.github.io/openai-agents-python/).
4
6
5
-
While the Taskflow Agent does not integrate into the dotcom Copilot UX, it does operate using the Copilot API (CAPI) as its backend.
7
+
While the Taskflow Agent does not integrate into the GitHub Doctom Copilot UX, it does operate using the Copilot API (CAPI) as its backend, similar to Copilot IDE extensions.
6
8
7
-
# Core Concepts
9
+
##Core Concepts
8
10
9
11
The Taskflow Agent leverages a GitHub Workflow-esque YAML based grammar to perform a series of tasks using a set of Agents.
10
12
13
+
It's primary value proposition is as a CLI tool that allows users to quickly define and script Agentic workflows without having to write any code.
14
+
11
15
Agents are defined through [personalities](personalities/), that receive a [task](taskflows/) to complete given a set of [tools](toolboxes/).
12
16
13
17
Agents can cooperate to complete sequences of tasks through so-called [Taskflows](taskflows/GRAMMAR.md).
14
18
15
-
# Installation
16
-
17
-
```sh
18
-
python -m venv .venv
19
-
source .venv/bin/activate
20
-
python -m pip install -r requirements.txt
21
-
```
22
-
23
-
## System Requirements
19
+
## Requirements
24
20
25
21
Python >= 3.9 or Docker
26
22
@@ -30,7 +26,15 @@ Provide a Copilot entitled GitHub PAT via the `COPILOT_TOKEN` environment variab
30
26
31
27
## Source
32
28
33
-
Run `python main.py` for help.
29
+
First install the required dependencies:
30
+
31
+
```sh
32
+
python -m venv .venv
33
+
source .venv/bin/activate
34
+
python -m pip install -r requirements.txt
35
+
```
36
+
37
+
Then run `python main.py`.
34
38
35
39
Example: deploying a prompt to an Agent Personality:
36
40
@@ -46,7 +50,7 @@ python main.py -t example
46
50
47
51
## Docker
48
52
49
-
Alternatively you can deploy the Agent via it's accompanying Docker image using `docker/run.sh`.
53
+
Alternatively you can deploy the Agent via its Docker image using `docker/run.sh`.
50
54
51
55
The image entrypoint is `main.py` and thus it operates the same as invoking the Agent from source directly.
52
56
@@ -246,3 +250,19 @@ taskflow:
246
250
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.
247
251
248
252
See the [taskflow examples](taskflows/examples) for other useful Taskflow patterns such as repeatable and asynchronous templated prompts.
253
+
254
+
## License
255
+
256
+
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
257
+
258
+
## Maintainers
259
+
260
+
[CODEOWNERS](./CODEOWNERS)
261
+
262
+
## Support
263
+
264
+
[SUPPORT](./SUPPORT.md)
265
+
266
+
## Acknowledgement
267
+
268
+
Security Lab team members @m-y-mo and @p- for contributing heavily to the testing and development of this framework, as well as the rest of the Security Lab team for helpful discussions and use cases.
0 commit comments