Skip to content

Commit 16e76ab

Browse files
brunoborgesCopilot
brunoborges
and
Copilot
committed
Add Copilot agentic workflows and VS Code configuration
- Add agentic workflows agent definition - Add copilot-setup-steps workflow - Add VS Code settings and MCP server config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 43a78d5 commit 16e76ab

File tree

4 files changed

+186
-0
lines changed

4 files changed

+186
-0
lines changed

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

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
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 shared components**: Routes to `create-shared-agentic-workflow` prompt
19+
20+
Workflows may optionally include:
21+
22+
- **Project tracking / monitoring** (GitHub Projects updates, status reporting)
23+
- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)
24+
25+
## Files This Applies To
26+
27+
- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`
28+
- Workflow lock files: `.github/workflows/*.lock.yml`
29+
- Shared components: `.github/workflows/shared/*.md`
30+
- Configuration: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/github-agentic-workflows.md
31+
32+
## Problems This Solves
33+
34+
- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions
35+
- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues
36+
- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes
37+
- **Component Design**: Create reusable shared workflow components that wrap MCP servers
38+
39+
## How to Use
40+
41+
When you interact with this agent, it will:
42+
43+
1. **Understand your intent** - Determine what kind of task you're trying to accomplish
44+
2. **Route to the right prompt** - Load the specialized prompt file for your task
45+
3. **Execute the task** - Follow the detailed instructions in the loaded prompt
46+
47+
## Available Prompts
48+
49+
### Create New Workflow
50+
**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet
51+
52+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/create-agentic-workflow.md
53+
54+
**Use cases**:
55+
- "Create a workflow that triages issues"
56+
- "I need a workflow to label pull requests"
57+
- "Design a weekly research automation"
58+
59+
### Update Existing Workflow
60+
**Load when**: User wants to modify, improve, or refactor an existing workflow
61+
62+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/update-agentic-workflow.md
63+
64+
**Use cases**:
65+
- "Add web-fetch tool to the issue-classifier workflow"
66+
- "Update the PR reviewer to use discussions instead of issues"
67+
- "Improve the prompt for the weekly-research workflow"
68+
69+
### Debug Workflow
70+
**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors
71+
72+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/debug-agentic-workflow.md
73+
74+
**Use cases**:
75+
- "Why is this workflow failing?"
76+
- "Analyze the logs for workflow X"
77+
- "Investigate missing tool calls in run #12345"
78+
79+
### Upgrade Agentic Workflows
80+
**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations
81+
82+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/upgrade-agentic-workflows.md
83+
84+
**Use cases**:
85+
- "Upgrade all workflows to the latest version"
86+
- "Fix deprecated fields in workflows"
87+
- "Apply breaking changes from the new release"
88+
89+
### Create Shared Agentic Workflow
90+
**Load when**: User wants to create a reusable workflow component or wrap an MCP server
91+
92+
**Prompt file**: https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/create-shared-agentic-workflow.md
93+
94+
**Use cases**:
95+
- "Create a shared component for Notion integration"
96+
- "Wrap the Slack MCP server as a reusable component"
97+
- "Design a shared workflow for database queries"
98+
99+
## Instructions
100+
101+
When a user interacts with you:
102+
103+
1. **Identify the task type** from the user's request
104+
2. **Load the appropriate prompt** from the GitHub repository URLs listed above
105+
3. **Follow the loaded prompt's instructions** exactly
106+
4. **If uncertain**, ask clarifying questions to determine the right prompt
107+
108+
## Quick Reference
109+
110+
```bash
111+
# Initialize repository for agentic workflows
112+
gh aw init
113+
114+
# Generate the lock file for a workflow
115+
gh aw compile [workflow-name]
116+
117+
# Debug workflow runs
118+
gh aw logs [workflow-name]
119+
gh aw audit <run-id>
120+
121+
# Upgrade workflows
122+
gh aw fix --write
123+
gh aw compile --validate
124+
```
125+
126+
## Key Features of gh-aw
127+
128+
- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter
129+
- **AI Engine Support**: Copilot, Claude, Codex, or custom engines
130+
- **MCP Server Integration**: Connect to Model Context Protocol servers for tools
131+
- **Safe Outputs**: Structured communication between AI and GitHub API
132+
- **Strict Mode**: Security-first validation and sandboxing
133+
- **Shared Components**: Reusable workflow building blocks
134+
- **Repo Memory**: Persistent git-backed storage for agents
135+
- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default
136+
137+
## Important Notes
138+
139+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.46.1/.github/aw/github-agentic-workflows.md for complete documentation
140+
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
141+
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
142+
- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
143+
- Follow security best practices: minimal permissions, explicit network access, no template injection

‎.github/workflows/copilot-setup-steps.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Copilot Setup Steps"
2+
3+
# This workflow configures the environment for GitHub Copilot Agent with gh-aw MCP server
4+
on:
5+
workflow_dispatch:
6+
push:
7+
paths:
8+
- .github/workflows/copilot-setup-steps.yml
9+
10+
jobs:
11+
# The job MUST be called 'copilot-setup-steps' to be recognized by GitHub Copilot Agent
12+
copilot-setup-steps:
13+
runs-on: ubuntu-latest
14+
15+
# Set minimal permissions for setup steps
16+
# Copilot Agent receives its own token with appropriate permissions
17+
permissions:
18+
contents: read
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
- name: Install gh-aw extension
24+
uses: github/gh-aw/actions/setup-cli@v0.46.1
25+
with:
26+
version: v0.46.1

‎.vscode/mcp.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"servers": {
3+
"github-agentic-workflows": {
4+
"command": "gh",
5+
"args": [
6+
"aw",
7+
"mcp-server"
8+
],
9+
"cwd": "${workspaceFolder}"
10+
}
11+
}
12+
}

‎.vscode/settings.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"github.copilot.enable": {
3+
"markdown": true
4+
}
5+
}

0 commit comments

Comments
 (0)