Skip to content

Commit 2ff455d

Browse files
committed
fix more docs
1 parent 7262577 commit 2ff455d

File tree

6 files changed

+86
-194
lines changed

6 files changed

+86
-194
lines changed

docs/astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ export default defineConfig({
204204
{ label: 'Command Triggers', link: '/reference/command-triggers/' },
205205
{ label: 'Compilation Process', link: '/reference/compilation-process/' },
206206
{ label: 'Concurrency', link: '/reference/concurrency/' },
207-
{ label: 'Copilot Custom Agents', link: '/reference/copilot-custom-agents/' },
207+
{ label: 'Copilot Agent Filess', link: '/reference/copilot-custom-agents/' },
208208
{ label: 'Custom Engines', link: '/reference/custom-engines/' },
209209
{ label: 'Custom Safe Outputs', link: '/reference/custom-safe-outputs/' },
210210
{ label: 'Environment Variables', link: '/reference/environment-variables/' },

docs/src/content/docs/examples/agent-imports.md

Lines changed: 0 additions & 166 deletions
This file was deleted.
Lines changed: 79 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
---
2-
title: Reusing Copilot Custom Agents
3-
description: Create and reuse specialized AI agents with custom instructions and behavior for GitHub Agentic Workflows
2+
title: Importing Copilot Agent Files
3+
description: Import and reuse Copilot agent files with GitHub Agentic Workflows
44
sidebar:
55
order: 650
66
---
77

8-
"Custom Agents" is a term used in GitHub Copilot for specialized prompts for behaviors for specific tasks. They are markdown documents stored in the `.github/agents/` directory and imported via the `imports` field. Copilot supports agents natively, while other engines (Claude, Codex) inject the markdown body as a prompt.
8+
"Custom agents" is a term used in GitHub Copilot for specialized prompts for behaviors for specific tasks. They are markdown files stored in the `.github/agents/` directory and imported via the `imports` field. Copilot supports agent files natively, while other engines (Claude, Codex) inject the markdown body as a prompt.
99

10-
## Creating a Copilot Custom Agent
11-
12-
Create a markdown file in `.github/agents/` with agent-specific instructions:
10+
A typical custom agent file looks like this:
1311

1412
```markdown title=".github/agents/my-agent.md"
1513
---
16-
name: My Copilot Custom Agent
14+
name: My Copilot Agent
1715
description: Specialized prompt for code review tasks
1816
---
1917

@@ -25,11 +23,11 @@ You are a specialized code review agent. Focus on:
2523
- Performance optimization
2624
```
2725

28-
## Using Copilot Custom Agents from Agentic Workflows
26+
## Using Copilot Agent Files from Agentic Workflows
2927

30-
Import agent files in your workflow using the `imports` field. Agents can be imported from local `.github/agents/` directories or from external repositories.
28+
Import Copilot agent files in your workflow using the `imports` field. Agent files can be imported from local `.github/agents/` directories or from external repositories.
3129

32-
### Local Agent Import
30+
### Local Agent File Import
3331

3432
Import an agent from your repository:
3533

@@ -44,9 +42,9 @@ imports:
4442
Review the pull request and provide feedback.
4543
```
4644

47-
### Remote Agent Import
45+
### Remote Agent File Import
4846

49-
Import an agent from an external repository using the `owner/repo/path@ref` format:
47+
Import an agent file from an external repository using the `owner/repo/path@ref` format:
5048

5149
```yaml wrap
5250
---
@@ -59,12 +57,6 @@ imports:
5957
Perform comprehensive code review using shared agent instructions.
6058
```
6159

62-
Remote agent imports support versioning:
63-
64-
- **Semantic tags**: `@v1.0.0` (recommended for production)
65-
- **Branch names**: `@main`, `@develop` (for development)
66-
- **Commit SHAs**: `@abc123def` (for immutable references)
67-
6860
The agent instructions are merged with the workflow prompt, customizing the AI engine's behavior for specific tasks.
6961

7062
## Agent File Requirements
@@ -73,8 +65,74 @@ The agent instructions are merged with the workflow prompt, customizing the AI e
7365
- **Format**: Markdown with YAML frontmatter
7466
- **Frontmatter**: Can include `name`, `description`, `tools`, and `mcp-servers`
7567
- **One per workflow**: Only one agent file can be imported per workflow
76-
- **Caching**: Remote agents are cached by commit SHA in `.github/aw/imports/`
68+
- **Caching**: Remote agent files are cached by commit SHA in `.github/aw/imports/`
69+
70+
## Copilot Agent File Collections
71+
72+
Organizations can create libraries of specialized custom agent files:
73+
74+
```text
75+
acme-org/ai-agents/
76+
└── .github/
77+
└── agents/
78+
├── code-reviewer.md # General code review
79+
├── security-auditor.md # Security-focused analysis
80+
├── performance-analyst.md # Performance optimization
81+
├── accessibility-checker.md # WCAG compliance
82+
└── documentation-writer.md # Technical documentation
83+
```
84+
85+
Teams import agent files based on workflow needs:
86+
87+
```yaml wrap title="Security-focused PR review"
88+
---
89+
on: pull_request
90+
engine: copilot
91+
imports:
92+
- acme-org/ai-agents/.github/agents/security-auditor.md@v2.0.0
93+
- acme-org/ai-agents/.github/agents/code-reviewer.md@v1.5.0
94+
---
95+
96+
# Security Review
97+
98+
Perform comprehensive security review of this pull request.
99+
```
100+
101+
## Combining Copilot Agent Files with Other Imports
102+
103+
You can mix custom agent file imports with tool configurations and shared components:
104+
105+
```yaml wrap
106+
---
107+
on: pull_request
108+
engine: copilot
109+
imports:
110+
# Import specialized custom agent file
111+
- acme-org/ai-agents/.github/agents/security-auditor.md@v2.0.0
112+
113+
# Import tool configurations
114+
- acme-org/workflow-library/shared/tools/github-standard.md@v1.0.0
115+
116+
# Import MCP servers
117+
- acme-org/workflow-library/shared/mcp/database.md@v1.0.0
118+
119+
# Import security policies
120+
- acme-org/workflow-library/shared/config/security-policies.md@v1.0.0
121+
permissions:
122+
contents: read
123+
pull-requests: write
124+
safe-outputs:
125+
create-pull-request-review-comment:
126+
max: 10
127+
---
128+
129+
# Comprehensive Security Review
130+
131+
Perform detailed security analysis using specialized agent files and tools.
132+
```
77133

78-
## The Copilot Custom Agent for Agentic Workflows
134+
## Related Documentation
79135

80-
The [Copilot Custom Agent for Agentic Workflows](/gh-aw/reference/custom-agent-for-aw/) (`agentic-workflows.agent.md`) is a specialized custom agent designed to assist with creating, updating, importing, and debugging agentic workflows. It provides tailored instructions and behaviors to streamline workflow management tasks.
136+
- [Imports Reference](/gh-aw/reference/imports/) - Complete import system documentation
137+
- [Packaging & Distribution](/gh-aw/guides/packaging-imports/) - Managing workflow imports
138+
- [Frontmatter](/gh-aw/reference/frontmatter/) - Configuration options reference

docs/src/content/docs/reference/custom-agent-for-aw.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Copilot Custom Agent support for Agentic Workflows
2+
title: Copilot Agent Files support for Agentic Workflows
33
description: How to create, update, import, and debug agentic workflows using our AI agent.
44
sidebar:
55
order: 1
@@ -11,7 +11,7 @@ import CopyEntireFileButton from '../../../components/CopyEntireFileButton.astro
1111

1212
In this guide, we show you how to install and use the custom agent `agentic-workflows` to create, update, import, and debug agentic workflows in your repository.
1313

14-
## Installing the Copilot Custom Agent for Agentic Workflows
14+
## Installing the Copilot Agent Files for Agentic Workflows
1515

1616
Follow these steps to set up your repository for agentic workflows using the custom `agentic-workflows` agent.
1717

@@ -21,7 +21,7 @@ Follow these steps to set up your repository for agentic workflows using the cus
2121
- Start [VSCode Agent Mode](https://code.visualstudio.com/docs/copilot/agents/overview), or
2222
- Start your coding agent in your repository
2323

24-
2. **Install the Copilot Custom Agent for Agentic Workflows into your repository**.
24+
2. **Install the Copilot Agent Files for Agentic Workflows into your repository**.
2525

2626
```text wrap
2727
Initialize this repository for GitHub Agentic Workflows using https://github.com/github/gh-aw/blob/main/install.md
@@ -42,7 +42,7 @@ After initialization, you'll have:
4242
- `.github/agents/agentic-workflows.agent.md` - [A Copilot file](/gh-aw/reference/glossary/#agent-files) (custom AI instructions) for the `/agent agentic-workflows` command in Copilot Chat
4343
- Additional configuration files for workflow authoring
4444

45-
## Using the Copilot Custom Agent for Agentic Workflows
45+
## Using the Copilot Agent Files for Agentic Workflows
4646

4747
Once your repository is set up for agentic workflows, you can use the `agentic-workflows` agent from VSCode or GitHub.com to perform a variety of tasks:
4848

docs/src/content/docs/reference/engines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ engine:
102102

103103
The `agent` field value should match the agent file name without the `.agent.md` extension. For example, `agent: technical-doc-writer` references `.github/agents/technical-doc-writer.agent.md`.
104104

105-
See [Copilot Custom Agents](/gh-aw/reference/copilot-custom-agents/) for details on creating and configuring custom agents.
105+
See [Copilot Agent Filess](/gh-aw/reference/copilot-custom-agents/) for details on creating and configuring custom agents.
106106

107107
### Engine Environment Variables
108108

skills/custom-agents/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ tools: [read, edit, pr]
562562

563563
## References
564564

565-
- [GitHub Copilot Custom Agents Configuration](https://docs.github.com/en/copilot/reference/copilot-custom-agents-configuration) - Official reference for custom agent configuration including tool aliases
565+
- [GitHub Copilot Agent Filess Configuration](https://docs.github.com/en/copilot/reference/copilot-custom-agents-configuration) - Official reference for custom agent configuration including tool aliases
566566
- [GitHub Copilot Custom Instructions Documentation](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions)
567567
- [About Custom Agents](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-custom-agents)
568568
- [GitHub Blog: Custom Instructions Support](https://github.blog/changelog/2025-07-23-github-copilot-coding-agent-now-supports-instructions-md-custom-instructions/)

0 commit comments

Comments
 (0)