Short summary
Custom Agents are sorted by filename instead of display name
Affected version or release
Latest
Installation context
GitHub Copilot App on Windows 11
What happened?
Description
Custom Agents in the Copilot desktop app are sorted by their filename instead of the name defined in the Markdown front matter.
GitHub documents name as the agent's display name, with the filename only used as a fallback when name is omitted.
Expected
Agents should be sorted alphabetically by their displayed name.
Actual
Agents are sorted alphabetically by their filename.
Steps to reproduce
No response
Expected behavior
Description
Custom Agents in the GitHub Copilot desktop app appear to be sorted alphabetically by their file name, rather than by the display name defined in the Markdown frontmatter.
This makes the ordering in the agent picker unexpected when file names are intentionally different from their user-facing names.
Steps to reproduce
Create multiple custom agents whose file names and display names sort differently, for example:
01-reviewer.agent.md
---
name: Zeta Reviewer
description: Reviews code changes
---
02-writer.agent.md
---
name: Alpha Writer
description: Helps write code and documentation
---
Open the Custom Agent picker in the GitHub Copilot desktop app.
Actual behavior
The agents are ordered according to their file names:
- Zeta Reviewer
- Alpha Writer
Expected behavior
The agents should be sorted by their displayed names:
- Alpha Writer
- Zeta Reviewer
Since the name frontmatter property represents the user-facing display name, sorting by that value would make the list consistent with what users actually see.
If name is omitted, the filename-derived name could naturally be used as the fallback sorting value.
Additional context
GitHub's Custom Agents documentation describes name as the display name for the custom agent and states that the filename is used as the default display name only when name is not specified.
This issue concerns the ordering of agents in the UI, not agent resolution/deduplication, where the filename may still be an appropriate identifier.
Additional context
No response
Short summary
Custom Agents are sorted by filename instead of display name
Affected version or release
Latest
Installation context
GitHub Copilot App on Windows 11
What happened?
Description
Custom Agents in the Copilot desktop app are sorted by their filename instead of the
namedefined in the Markdown front matter.GitHub documents
nameas the agent's display name, with the filename only used as a fallback whennameis omitted.Expected
Agents should be sorted alphabetically by their displayed
name.Actual
Agents are sorted alphabetically by their filename.
Steps to reproduce
No response
Expected behavior
Description
Custom Agents in the GitHub Copilot desktop app appear to be sorted alphabetically by their file name, rather than by the display name defined in the Markdown frontmatter.
This makes the ordering in the agent picker unexpected when file names are intentionally different from their user-facing names.
Steps to reproduce
Create multiple custom agents whose file names and display names sort differently, for example:
01-reviewer.agent.md02-writer.agent.mdOpen the Custom Agent picker in the GitHub Copilot desktop app.
Actual behavior
The agents are ordered according to their file names:
Expected behavior
The agents should be sorted by their displayed names:
Since the
namefrontmatter property represents the user-facing display name, sorting by that value would make the list consistent with what users actually see.If
nameis omitted, the filename-derived name could naturally be used as the fallback sorting value.Additional context
GitHub's Custom Agents documentation describes
nameas the display name for the custom agent and states that the filename is used as the default display name only whennameis not specified.This issue concerns the ordering of agents in the UI, not agent resolution/deduplication, where the filename may still be an appropriate identifier.
Additional context
No response