[docs] docs: unbloat Copilot custom agents reference - #55549
Merged
Conversation
github-actions
Bot
changed the title
github-actions
Bot
added
automation
doc-unbloat
documentation
pelikhan
marked this pull request as ready for review
August 25, 2026 02:02
Contributor
Author
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Condenses the Copilot custom-agent reference while retaining its examples and structure.
Changes:
- Streamlines explanatory prose and requirements.
- Simplifies import examples and removes inline commentary.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/copilot-custom-agents.md |
Condenses custom-agent import documentation. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Balanced
| --- | ||
|
|
||
| "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. | ||
| GitHub Copilot custom agents are Markdown prompt files stored in `.github/agents/` and imported with `imports`. Copilot supports these files natively; other engines such as Claude and Codex receive the Markdown body as prompt text. |
| - **Frontmatter**: Can include `name`, `description`, `tools`, and `mcp-servers` | ||
| - **One per workflow**: Only one agent file can be imported per workflow | ||
| - **Caching**: Remote agent files are cached by commit SHA in `.github/aw/imports/` | ||
| Agent files must live in `.github/agents/`, use Markdown with YAML frontmatter, and may define fields such as `name`, `description`, `tools`, and `mcp-servers`. Remote imports are cached by commit SHA in `.github/aw/imports/`. |
This was referenced Aug 25, 2026
Contributor
Author
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR condenses the Copilot custom agents reference documentation (
docs/src/content/docs/reference/copilot-custom-agents.md) by removing redundant phrasing, consolidating bullet-point lists into prose, and trimming a duplicated example import. No technical content, commands, or behavior descriptions were changed.Change Classification
Key Changes
docs/src/content/docs/reference/copilot-custom-agents.mdcode-reviewer.md@v1.5.0) and inline comments from a YAML exampleImpact Assessment
No downstream impact identified. Changes are purely editorial/documentation wording and formatting; no code, schema, or CLI behavior is affected.
Commits