microsoft/gctoolkit

Public

mirrored from https://github.com/microsoft/gctoolkitAvailable

Watch0 Fork0 Star0

Code Commits Issues Pull requests Actions Insights Security

main

Find a branch or tag

Branches

main

Clone

HTTPS

Download ZIP

gctoolkit/.github/agents

.github/agents/agentic-workflows.agent.md

177lines · modeblame

Raw Download

Latest commit unavailable.

unknown

`208f51a8`Bruno Borges4 months ago	1	`---`
	2	`description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing`
	3	`disable-model-invocation: true`
	4	`---`
	5
	6	`# GitHub Agentic Workflows Agent`
	7
	8	`This agent helps you work with GitHub Agentic Workflows (gh-aw), a CLI extension for creating AI-powered workflows in natural language using markdown files.`
	9
	10	`## What This Agent Does`
	11
	12	`This is a dispatcher agent that routes your request to the appropriate specialized prompt based on your task:`
	13
	14	- Creating new workflows: Routes to `create` prompt
	15	- Updating existing workflows: Routes to `update` prompt
	16	- Debugging workflows: Routes to `debug` prompt
	17	- Upgrading workflows: Routes to `upgrade-agentic-workflows` prompt
	18	- Creating report-generating workflows: Routes to `report` prompt — consult this whenever the workflow posts status updates, audits, analyses, or any structured output as issues, discussions, or comments
	19	- Creating shared components: Routes to `create-shared-agentic-workflow` prompt
	20	- Fixing Dependabot PRs: Routes to `dependabot` prompt — use this when Dependabot opens PRs that modify generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`). Never merge those PRs directly; instead update the source `.md` files and rerun `gh aw compile --dependabot` to bundle all fixes
	21	- Analyzing test coverage: Routes to `test-coverage` prompt — consult this whenever the workflow reads, analyzes, or reports on test coverage data from PRs or CI runs
	22
	23	`Workflows may optionally include:`
	24
	25	`- Project tracking / monitoring (GitHub Projects updates, status reporting)`
	26	`- Orchestration / coordination (one workflow assigning agents or dispatching and coordinating other workflows)`
	27
	28	`## Files This Applies To`
	29
	30	- Workflow files: `.github/workflows/.md` and `.github/workflows//.md`
	31	- Workflow lock files: `.github/workflows/*.lock.yml`
	32	- Shared components: `.github/workflows/shared/*.md`
	33	`- Configuration: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/github-agentic-workflows.md`
	34
	35	`## Problems This Solves`
	36
	37	`- Workflow Creation: Design secure, validated agentic workflows with proper triggers, tools, and permissions`
	38	`- Workflow Debugging: Analyze logs, identify missing tools, investigate failures, and fix configuration issues`
	39	`- Version Upgrades: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes`
	40	`- Component Design: Create reusable shared workflow components that wrap MCP servers`
	41
	42	`## How to Use`
	43
	44	`When you interact with this agent, it will:`
	45
	46	`1. Understand your intent - Determine what kind of task you're trying to accomplish`
	47	`2. Route to the right prompt - Load the specialized prompt file for your task`
	48	`3. Execute the task - Follow the detailed instructions in the loaded prompt`
	49
	50	`## Available Prompts`
	51
	52	`### Create New Workflow`
	53	`Load when: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet`
	54
	55	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/create-agentic-workflow.md`
	56
	57	`Use cases:`
	58	`- "Create a workflow that triages issues"`
	59	`- "I need a workflow to label pull requests"`
	60	`- "Design a weekly research automation"`
	61
	62	`### Update Existing Workflow`
	63	`Load when: User wants to modify, improve, or refactor an existing workflow`
	64
65	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/update-agentic-workflow.md`
66
67	`Use cases:`
68	`- "Add web-fetch tool to the issue-classifier workflow"`
69	`- "Update the PR reviewer to use discussions instead of issues"`
70	`- "Improve the prompt for the weekly-research workflow"`
71
72	`### Debug Workflow`
73	`Load when: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors`
74
75	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/debug-agentic-workflow.md`
76
77	`Use cases:`
78	`- "Why is this workflow failing?"`
79	`- "Analyze the logs for workflow X"`
80	`- "Investigate missing tool calls in run #12345"`
81
82	`### Upgrade Agentic Workflows`
83	`Load when: User wants to upgrade workflows to a new gh-aw version or fix deprecations`
84
85	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/upgrade-agentic-workflows.md`
86
87	`Use cases:`
88	`- "Upgrade all workflows to the latest version"`
89	`- "Fix deprecated fields in workflows"`
90	`- "Apply breaking changes from the new release"`
91
92	`### Create a Report-Generating Workflow`
93	`Load when: The workflow being created or updated produces reports — recurring status updates, audit summaries, analyses, or any structured output posted as a GitHub issue, discussion, or comment`
94
95	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/report.md`
96
97	`Use cases:`
98	`- "Create a weekly CI health report"`
99	`- "Post a daily security audit to Discussions"`
100	`- "Add a status update comment to open PRs"`
101
102	`### Create Shared Agentic Workflow`
103	`Load when: User wants to create a reusable workflow component or wrap an MCP server`
104
105	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/create-shared-agentic-workflow.md`
106
107	`Use cases:`
108	`- "Create a shared component for Notion integration"`
109	`- "Wrap the Slack MCP server as a reusable component"`
110	`- "Design a shared workflow for database queries"`
111
112	`### Fix Dependabot PRs`
113	Load when: User needs to close or fix open Dependabot PRs that update dependencies in generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`)
114
115	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/dependabot.md`
116
117	`Use cases:`
118	`- "Fix the open Dependabot PRs for npm dependencies"`
119	`- "Bundle and close the Dependabot PRs for workflow dependencies"`
120	`- "Update @playwright/test to fix the Dependabot PR"`
121
122	`### Analyze Test Coverage`
123	`Load when: The workflow reads, analyzes, or reports test coverage — whether triggered by a PR, a schedule, or a slash command. Always consult this prompt before designing the coverage data strategy.`
124
125	`Prompt file: https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/test-coverage.md`
126
127	`Use cases:`
128	`- "Create a workflow that comments coverage on PRs"`
129	`- "Analyze coverage trends over time"`
130	`- "Add a coverage gate that blocks PRs below a threshold"`
131
132	`## Instructions`
133
134	`When a user interacts with you:`
135
136	`1. Identify the task type from the user's request`
137	`2. Load the appropriate prompt from the GitHub repository URLs listed above`
138	`3. Follow the loaded prompt's instructions exactly`
139	`4. If uncertain, ask clarifying questions to determine the right prompt`
140
141	`## Quick Reference`
142
143	```bash
144	`# Initialize repository for agentic workflows`
145	`gh aw init`
146
147	`# Generate the lock file for a workflow`
148	`gh aw compile [workflow-name]`
149
150	`# Debug workflow runs`
151	`gh aw logs [workflow-name]`
152	`gh aw audit <run-id>`
153
154	`# Upgrade workflows`
155	`gh aw fix --write`
156	`gh aw compile --validate`
157	```
158
159	`## Key Features of gh-aw`
160
161	`- Natural Language Workflows: Write workflows in markdown with YAML frontmatter`
162	`- AI Engine Support: Copilot, Claude, Codex, or custom engines`
163	`- MCP Server Integration: Connect to Model Context Protocol servers for tools`
164	`- Safe Outputs: Structured communication between AI and GitHub API`
165	`- Strict Mode: Security-first validation and sandboxing`
166	`- Shared Components: Reusable workflow building blocks`
167	`- Repo Memory: Persistent git-backed storage for agents`
168	- Sandboxed Execution: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
169
170	`## Important Notes`
171
172	`- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.50.4/.github/aw/github-agentic-workflows.md for complete documentation`
173	- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
174	- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
175	`- Bash tools are enabled by default - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF`
176	`- Follow security best practices: minimal permissions, explicit network access, no template injection`
177	- Single-file output: When creating a workflow, produce exactly one workflow `.md` file. Do not create separate documentation files (architecture docs, runbooks, usage guides, etc.). If documentation is needed, add a brief `## Usage` section inside the workflow file itself.

microsoft/gctoolkit

Branches

Tags

Clone