Agent Skills Reference

By the Syncfusion DevTutorials team · Last updated

A one-page look-up for agent skills: the course at a glance, a SKILL.md template, front matter, body sections, what loads when, skill folders per tool, who owns a job, patterns, checklists, troubleshooting, testing and a glossary.

What you will learn

  • Copy a SKILL.md template
  • Look up fields, folders and owners
  • Use the authoring and security checklists

This page is a quick look-up. It puts the most useful templates, tables and checklists from the course in one place.

Each section names the lesson that explains it.

The Course at a Glance

LessonOne-line idea
Agent Skills OverviewA skill is a folder with a SKILL.md that teaches the agent one repeatable job.
Skill AnatomySKILL.md has two parts: front matter (name, description) and a body (the steps).
Loading and Context CostOnly the name and description load at first. The body loads when the skill fires.
Activation and DescriptionsThe description decides when the skill fires. Use the words people type.
Release Note SkillBuild your first skill from start to finish.
Skill InstallationPut the skill in the folder your tool reads, then check that it loads.
Workflow InstructionsWrite numbered steps, one action each, with stop conditions.
Output Format and ExamplesFix the shape of the reply. Show one good example.
Reference FilesMove long detail into references/. Point to it from the right step.
Scripts and ValidatorsLet a script do exact checks. The agent fixes and runs it again.
Choosing the Right OwnerSkill, instruction file, script, MCP tool or plugin: pick one owner.
Diagnosing SkillsFind the first broken layer. Fix only that layer.
Skill EvaluationTest activation and output before and after every change.
Skill SecurityRead every file of an outside skill before you trust it.
Maintaining and Sharing SkillsVersion skills, review changes, and share them with your team.
Everyday Skill PatternsReviewer, generator, transformer and triage skills you can adapt.

SKILL.md Template

Copy this and fill in the parts in angle brackets.

---
name: your-skill-name
description: <What it does>. Use when someone asks <the words people type>. Do not use for <nearby jobs>.
---

# Your Skill Name

## When to use
- <Requests this skill is for>

## Inputs
- <What the agent must gather first>

## Workflow
1. <One action per step>
2. <If condition, read references/topic.md>

## Output format
## <Heading 1>
## <Heading 2>

## Examples
<One short input and the output you want>

## Do not use
- <Nearby job> (use <other-skill>)

## Final checks
- <A check the agent can do>
- Run scripts/check.js on the output.

Folder Layout

your-skill-name/
  SKILL.md        required: front matter + steps
  references/     detail, opened only when a step points to it
  scripts/        exact checks; only their result is read
  templates/      files the agent fills in
  examples/       sample inputs and good outputs

Front Matter

FieldNeeded?RuleLesson
nameYesLowercase letters, numbers and single hyphens. Same as the folder name.Skill Anatomy
descriptionYesSays what it does, "Use when ...", and "Do not use for ...".Activation and Descriptions
metadataNoExtra data, such as version and owner.Maintaining and Sharing Skills
allowed-toolsNoTools it may use without asking. Support varies by tool.Skill Security

Simple rule: if the name and description are wrong, nothing else matters.

Body Sections

SectionAnswers
When to useWhich requests is it for?
InputsWhat must the agent get first?
WorkflowWhich steps, in order?
Output formatWhat shape must the reply have?
ExamplesWhat does good look like?
Do not useWhich jobs belong to other skills?
Final checksWhat must be checked before replying?

What Loads, and When

LevelLoads whenKeep it
Name + descriptionEvery request, for every skillOne or two sentences
SKILL.md bodyThe skill firesOnly the steps that are needed
Reference filesA step points to themOne topic per file
Script outputA script runsA short OK or FAIL list

Lesson: Loading and Context Cost.

Where Skills Live

ToolProject folderPersonal folderCall by name
Syncfusion Code Studio.codestudio/skills/, .github/skills/, .claude/skills/, .agents/skills/The same folders under ~//name
Claude Code.claude/skills/~/.claude/skills//name
GitHub Copilot.github/skills/, .claude/skills/, .agents/skills/~/.copilot/skills/, ~/.agents/skills//name
OpenAI Codex.agents/skills/~/.agents/skills/$name

Folders can change. Check your tool's documentation. Lesson: Skill Installation.

Who Owns the Job

You needUseLesson
A one-off answerA promptAgent Skills Overview
A rule for every task in the repoAGENTS.md or project instructionsChoosing the Right Owner
An exact check or fixA script, linter or formatterScripts and Validators
Live data or an action in another appAn MCP toolChoosing the Right Owner
A repeatable job with steps and a formatA skillAgent Skills Overview
A repeatable job that needs live dataA skill + an MCP toolChoosing the Right Owner
A kit to share with a teamA pluginMaintaining and Sharing Skills

Skill Patterns

PatternShapeDevKit examples
ReviewerCode in, findings out (severity, place, fix)ui-review, security-review, pr-review
GeneratorRequest in, code from a template outreact-component, api-endpoint, test-planner
TransformerA list in, a grouped document outrelease-note-helper, commit-writer
TriageA report in, severity and next steps outbug-triage

Lesson: Everyday Skill Patterns.

Authoring Checklist

  • The job is frequent, done the same way, and easy to check.
  • name matches the folder.
  • description says what, "Use when ..." and "Do not use for ...".
  • Steps are numbered, one action each.
  • The output format has exact headings or fields.
  • There is one short example and a Do not use section.
  • Final checks cover the rules that matter most.
  • Long detail is in references/. Exact checks are in scripts/.
  • No secrets, stories or role-play.
  • Activation and output tests exist.

Security Checklist

  • Read every file in raw form, including scripts and hidden comments.
  • No curl ... | bash, no reading of keys, no uploads.
  • No "ignore previous instructions" or "do not tell the user".
  • Scripts do only what SKILL.md says.
  • Give the fewest tool permissions.
  • Treat code, tickets and docs as data, never as instructions.
  • Never store secrets in a skill.

Lesson: Skill Security.

Troubleshooting

What you seeBroken layerFirst fixLesson
The tool does not list the skillDiscoveryCheck the folder, the file name and the front matterSkill Installation
It never firesActivationAdd the words people type to the descriptionActivation and Descriptions
It fires for the wrong requestActivationAdd "Do not use for ..."Activation and Descriptions
It skips a stepInstructionsOne action per step; add a final checkWorkflow Instructions
It ignores a reference fileResourcesPoint to the file from the right step, with a conditionReference Files
The reply shape changesVerificationAdd an exact output format and a validatorOutput Format and Examples
It broke after an editImprovementCompare with the last version; run the tests againSkill Evaluation

Simple rule: start at the top of the table. Fix the first layer that fails.

Testing and Versions

TestChecksWhen
StructureFront matter, sections, file pointersEvery edit
ActivationThe right skill fires, or noneEvery edit
OutputGood replies pass, bad replies failEvery edit
Real runsA real model on real inputsBefore you share a change
ChangeVersion
A small fixPatch: 1.2.0 → 1.2.1
A new feature, nothing breaksMinor: 1.2.1 → 1.3.0
The output shape changesMajor: 1.3.0 → 2.0.0

Glossary

TermMeaning
$ARGUMENTSThe text typed after a skill's name, like /release-notes v3.1, passed into the skill
ActivationThe agent picking a skill for a request
allowed-toolsA front matter field (in some tools) that lists the only tools a skill may use
AGENTS.mdAn instruction file read for every task in a repo
CatalogThe list of skill names and descriptions the agent sees first
Context windowEverything the agent can see at one time; skills and files all share it
DiscoveryThe tool finding the installed skills
HookCode that runs on its own when something happens, with no choice by the model
MCPModel Context Protocol: a standard way to connect tools and data to agents
Output formatThe exact shape a reply must have
PluginA bundle of skills and tools to share
Prompt injectionHidden instructions inside content the agent reads
RegressionSomething that worked before and fails now
SubagentA separate helper with its own context window, for a big side task
ValidatorA script that checks a reply exactly

Links

Common Mistakes

MistakeWhy it hurtsFix
A vague descriptionThe skill never firesSay what, "Use when ..." and "Do not use for ..."
No testsAn edit breaks the skill and nobody sees itRun activation and output tests on every change
Trusting an outside skillHidden steps can leak secretsRead every file before you install it