copilot-yaml-reference

Summarize the YAML frontmatter specification for Copilot customization files.

Updated Oct 3, 2024
One-click install
npx skills add https://github.com/RuanBuitendag42/.dotfiles --skill copilot-yaml-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: copilot-yaml-reference
Source: https://github.com/RuanBuitendag42/.dotfiles/tree/main/home/.copilot/skills/copilot-yaml-reference
Command: npx skills add https://github.com/RuanBuitendag42/.dotfiles --skill copilot-yaml-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Authoritative knowledge of the VS Code Copilot YAML frontmatter specification for all customization file types enables teams to consistently create, validate, and reuse frontmatter across agents, instructions, and skills.

Core Features & Use Cases

  • Documents required fields (name, description) and optional properties (model, agents, tools, applyTo, etc.) for agents, instructions, and skills.
  • Provides example frontmatter usage for .agent.md, .instructions.md, SKILL.md, and demonstrates how to structure handoffs and resources.
  • Enables validation, tooling integration, and automated discovery of Copilot prompts and skills.

Quick Start

Validate or reference Copilot frontmatter in your project by inspecting your .agent.md, .instructions.md, and SKILL.md files against the reference.

Frequently Asked Questions about copilot-yaml-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What fields are required for YAML frontmatter in Copilot customization files?

Required YAML frontmatter fields for Copilot customization files are name and description. Optional properties include model, agents, tools, and applyTo, which configure behavior across .agent.md, .instructions.md, and SKILL.md files.

How do I validate frontmatter in VS Code Copilot skills and agents?

Validate Copilot frontmatter by inspecting your .agent.md, .instructions.md, and SKILL.md files against the YAML frontmatter reference specification. This ensures required fields and optional properties are correctly parsed and loaded within VS Code workflows.

How are scripts and references loaded in Copilot SKILL.md files?

Resources in references, scripts, and templates are loaded based on YAML frontmatter configuration in customization files. Structuring handoffs and resources correctly ensures automated discovery and tooling integration within VS Code Copilot workflows.

Can I use the same YAML frontmatter structure for agents, instructions, and skills?

Yes, the YAML frontmatter specification applies uniformly across agents, instructions, and skills. The reference documents shared fields like name and description alongside specific optional properties for .agent.md, .instructions.md, and SKILL.md files.

Why is my Copilot custom agent not loading in VS Code?

Copilot custom agents may fail to load if YAML frontmatter is missing required name or description fields. Validate your .agent.md or SKILL.md file against the frontmatter reference to ensure correct parsing and automated discovery.