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
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
4
4
sidebar:
5
5
order: 650
6
6
---
7
7
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.
9
9
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:
13
11
14
12
```markdown title=".github/agents/my-agent.md"
15
13
---
16
-
name: My Copilot Custom Agent
14
+
name: My Copilot Agent
17
15
description: Specialized prompt for code review tasks
18
16
---
19
17
@@ -25,11 +23,11 @@ You are a specialized code review agent. Focus on:
25
23
- Performance optimization
26
24
```
27
25
28
-
## Using Copilot Custom Agents from Agentic Workflows
26
+
## Using Copilot Agent Files from Agentic Workflows
29
27
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.
31
29
32
-
### Local Agent Import
30
+
### Local Agent File Import
33
31
34
32
Import an agent from your repository:
35
33
@@ -44,9 +42,9 @@ imports:
44
42
Review the pull request and provide feedback.
45
43
```
46
44
47
-
### Remote Agent Import
45
+
### Remote Agent File Import
48
46
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:
50
48
51
49
```yaml wrap
52
50
---
@@ -59,12 +57,6 @@ imports:
59
57
Perform comprehensive code review using shared agent instructions.
60
58
```
61
59
62
-
Remote agent imports support versioning:
63
-
64
-
-**Semantic tags**: `@v1.0.0` (recommended for production)
Perform detailed security analysis using specialized agent files and tools.
132
+
```
77
133
78
-
## The Copilot Custom Agent for Agentic Workflows
134
+
## Related Documentation
79
135
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
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/custom-agent-for-aw.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Copilot Custom Agent support for Agentic Workflows
2
+
title: Copilot Agent Files support for Agentic Workflows
3
3
description: How to create, update, import, and debug agentic workflows using our AI agent.
4
4
sidebar:
5
5
order: 1
@@ -11,7 +11,7 @@ import CopyEntireFileButton from '../../../components/CopyEntireFileButton.astro
11
11
12
12
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.
13
13
14
-
## Installing the Copilot Custom Agent for Agentic Workflows
14
+
## Installing the Copilot Agent Files for Agentic Workflows
15
15
16
16
Follow these steps to set up your repository for agentic workflows using the custom `agentic-workflows` agent.
17
17
@@ -21,7 +21,7 @@ Follow these steps to set up your repository for agentic workflows using the cus
21
21
- Start [VSCode Agent Mode](https://code.visualstudio.com/docs/copilot/agents/overview), or
22
22
- Start your coding agent in your repository
23
23
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**.
25
25
26
26
```text wrap
27
27
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:
42
42
-`.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
43
43
- Additional configuration files for workflow authoring
44
44
45
-
## Using the Copilot Custom Agent for Agentic Workflows
45
+
## Using the Copilot Agent Files for Agentic Workflows
46
46
47
47
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:
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/engines.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,7 +102,7 @@ engine:
102
102
103
103
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`.
104
104
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.
0 commit comments