@@ -9,7 +9,7 @@ Custom agents are specialized configurations that help GitHub Copilot provide mo
99## Available Agents
1010
1111### 1. TypeScript React Development Agent
12- ** File:** ` typescript-react-agent.yml `
12+ ** File:** ` typescript-react-agent.md `
1313
1414Expert in TypeScript and React development for the CIA Compliance Manager.
1515
@@ -28,7 +28,7 @@ Expert in TypeScript and React development for the CIA Compliance Manager.
2828---
2929
3030### 2. Testing Agent
31- ** File:** ` testing-agent.yml `
31+ ** File:** ` testing-agent.md `
3232
3333Expert in testing using Vitest and Cypress.
3434
@@ -47,7 +47,7 @@ Expert in testing using Vitest and Cypress.
4747---
4848
4949### 3. Code Review Agent
50- ** File:** ` code-review-agent.yml `
50+ ** File:** ` code-review-agent.md `
5151
5252Expert in code quality, security, and best practices.
5353
@@ -68,7 +68,7 @@ Expert in code quality, security, and best practices.
6868---
6969
7070### 4. Documentation Agent
71- ** File:** ` documentation-agent.yml `
71+ ** File:** ` documentation-agent.md `
7272
7373Expert in technical documentation and API documentation.
7474
@@ -87,7 +87,7 @@ Expert in technical documentation and API documentation.
8787---
8888
8989### 5. Security and Compliance Agent
90- ** File:** ` security-compliance-agent.yml `
90+ ** File:** ` security-compliance-agent.md `
9191
9292Expert in security best practices and compliance frameworks.
9393
@@ -138,31 +138,46 @@ All agents follow these core project principles:
138138
139139## Agent Configuration Format
140140
141- Each agent configuration file follows this structure:
141+ Each agent configuration file is a Markdown file with YAML frontmatter that follows this structure:
142142
143- ``` yaml
144- name : Agent Name
143+ ``` markdown
144+ ---
145+ name: agent-name
145146description: Brief description of the agent's expertise
147+ tools: [ "read", "edit", "search"] # optional - list of tool names or aliases
148+ ---
149+
150+ Agent prompt and instructions in Markdown format.
146151
147- instructions : |
148- Detailed instructions for the agent including:
149- - Area of expertise
150- - Project-specific guidelines
151- - Best practices
152- - When to use the agent
153- - How to respond to requests
152+ ## Expertise Area
153+ - Detailed instructions for the agent
154+ - Project-specific guidelines
155+ - Best practices
156+ - When to use the agent
157+ - How to respond to requests
154158```
155159
160+ ** Key Properties:**
161+ - ` name ` : Unique identifier for the agent (lowercase with hyphens)
162+ - ` description ` : Brief description of the agent's purpose and expertise
163+ - ` tools ` : (Optional) List of tools the agent can use. If omitted, the agent has access to all available tools.
164+
165+ The Markdown content below the frontmatter defines the agent's behavior, expertise, and instructions.
166+
156167## Contributing to Agent Configurations
157168
158169When updating or adding agents:
159170
160- 1. Follow the existing YAML structure
161- 2. Ensure instructions are clear and actionable
162- 3. Include project-specific guidelines
163- 4. Reference relevant files and directories
164- 5. Align with the v1.0 release priorities
165- 6. Validate YAML syntax before committing
171+ 1 . Create a Markdown file (` .md ` extension) with YAML frontmatter
172+ 2 . Use lowercase with hyphens for the filename (e.g., ` my-agent.md ` )
173+ 3 . Include ` name ` and ` description ` in the YAML frontmatter
174+ 4 . Optionally specify ` tools ` list if the agent should have restricted tool access
175+ 5 . Write agent instructions in Markdown format below the frontmatter
176+ 6 . Ensure instructions are clear and actionable
177+ 7 . Include project-specific guidelines
178+ 8 . Reference relevant files and directories
179+ 9 . Align with the v1.0 release priorities
180+ 10 . Validate YAML frontmatter syntax before committing
166181
167182## Related Files
168183
@@ -175,16 +190,23 @@ When updating or adding agents:
175190To validate agent configuration files:
176191
177192``` bash
178- # Using js-yaml to validate a specific agent
179- npx js-yaml .github/agents/typescript-react-agent.yml
193+ # Validate YAML frontmatter in a specific agent
194+ npx js-yaml -t < <( sed -n ' /^---$/,/^---$/p ' .github/agents/typescript-react-agent.md | sed ' 1d;$d ' )
180195
181196# Or validate all agents at once
182- for file in .github/agents/*.yml; do
183- echo "Validating $file..."
184- npx js-yaml "$file" && echo "✓ Valid"
197+ for file in .github/agents/* .md; do
198+ if [ " $file " != " .github/agents/README.md" ]; then
199+ echo " Validating $file ..."
200+ npx js-yaml -t < <( sed -n ' /^---$/,/^---$/p' " $file " | sed ' 1d;$d' ) && echo " ✓ Valid frontmatter"
201+ fi
185202done
186203
187- # Or use any YAML validator
204+ # Or check the Markdown structure
205+ npx markdownlint .github/agents/* .md --ignore .github/agents/README.md
188206```
189207
190- All agent files must be valid YAML and follow the defined structure.
208+ All agent files must:
209+ - Be valid Markdown files with YAML frontmatter
210+ - Follow the defined structure
211+ - Have valid YAML in the frontmatter section
212+ - Include the required ` name ` and ` description ` properties
0 commit comments