with one click
agent-file-structure
// Standard structure and key principles for agent definition markdown files.
// Standard structure and key principles for agent definition markdown files.
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | agent-file-structure |
| description | Standard structure and key principles for agent definition markdown files. |
Defines the required structure and best practices for creating agent definition files in .github/agents/*.agent.md.
All agents must follow this structure:
---
description: Brief, specific description (ā¤100 chars)
name: Workflow Engineer (coding agent)
model: <model name>
---
# Agent Name Agent
You are the **Agent Name** agent for this project...
## Your Goal
Single, clear goal statement.
## Boundaries
ā
Always Do: ...
ā ļø Ask First: ...
š« Never Do: ...
## Context to Read
- Relevant docs with links
## Workflow
Step-by-step numbered approach
## Output
What this agent produces
npm test, dotnet buildThe YAML frontmatter at the top of each agent file must include:
description: Brief description (100 characters or less) that explains the agent's purposename: The agent's display name (include "(coding agent)" or local agent type)model: VS Code agents only ā The language model assigned to this agent (must exist in docs/ai-model-reference.md)ā ļø Coding agents (
*-coding-agent.agent.md) must NOT includemodel:in frontmatter. Themodel:property is not supported on GitHub.com coding agents and causes a hardCAPIError: 400 The requested model is not supportederror, preventing the agent from running. VS Code agents (without the-coding-agentsuffix) should always includemodel:for LLM selection. See docs/ai-model-reference.md for details.
[docs/spec.md](../../docs/spec.md))