بنقرة واحدة
agent-file-structure
Standard structure and key principles for agent definition markdown files.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Standard structure and key principles for agent definition markdown files.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Minimum-requirements checklist for any change — code or docs-only. Run this before every PR creation or push to avoid CI failures on the first attempt.
Generate PNG screenshots for release notes using the repository's HtmlRenderer and ScreenshotGenerator tools. Use when asked to add screenshots to release notes or documentation.
Determine the next available issue number across all change types (feature, fix, workflow) by checking both local docs and remote branches, then reserve it by pushing an empty branch.
Convert the mermaid diagram in docs/agents.md to a blueprint-styled SVG for the website. Use when the workflow diagram in agents.md is updated and needs to be reflected on the website.
Run a focused accessibility pass for website changes (WCAG 2.1 AA-oriented).
Create and update interactive examples for the Eleventy website using page entrypoints and src/examples fragments.
| 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))