skill-authoring
$
npx mdskill add microsoft/GitHub-Copilot-for-Azure/skill-authoringWrite compliant Agent Skills using the agentskills.io specification.
- Helps developers create new skills and review existing ones.
- Depends on the agentskills.io specification for format rules.
- Decides compliance by checking frontmatter and structure.
- Delivers clear guidelines for SKILL.md and references folders.
SKILL.md
.github/skills/skill-authoringView on GitHub ↗
--- name: skill-authoring description: "Guidelines for writing Agent Skills that comply with the agentskills.io specification. WHEN: \"create a skill\", \"new skill\", \"write a skill\", \"skill template\", \"skill structure\", \"review skill\", \"skill PR\", \"skill compliance\", \"SKILL.md format\", \"skill frontmatter\", \"skill best practices\"." license: MIT metadata: author: Microsoft version: "1.0.1" --- # Skill Authoring Guide This skill provides guidance for writing Agent Skills that comply with the [agentskills.io specification](https://agentskills.io/specification). ## When to Use - Creating a new skill for this repository - Reviewing a skill PR for compliance - Checking if an existing skill follows best practices - Understanding token budgets and progressive disclosure ## Constraints - `name`: 1-64 chars, lowercase + hyphens, match directory - `description`: 1-1024 chars, ≤60 words, explain WHAT and WHEN - Use `WHEN:` with quoted trigger phrases (preferred over `USE FOR:`) - Avoid `DO NOT USE FOR:` unless the skill has trigger overlap with a broader skill (see [frontmatter guidelines](references/guidelines/frontmatter.md)) - Use inline double-quoted strings (not `>-` folded scalars) - SKILL.md: <500 tokens (soft), <5000 (hard) - references/*.md: <1000 tokens each ## Structure - `SKILL.md` (required) - Instructions - `references/` (optional) - Detailed docs - `scripts/` (optional) - Executable code Frontmatter: `name` (lowercase-hyphens), `description` (WHAT + WHEN) ## Progressive Disclosure Metadata (~100 tokens) loads at startup. SKILL.md (<5000 tokens) loads on activation. References load **only when explicitly linked** (not on activation). Keep SKILL.md lean. ## Reference Loading References are JIT (just-in-time) loaded: - Only files explicitly linked via `[text](references/file.md)` load - **Link to files, not folders** - `[Recipes](references/recipes/README.md)` not `[Recipes](references/recipes/)` - Each file loads in full (not sections) - No caching between requests - write self-contained files - Use recipes/services patterns for multi-option skills See [REFERENCE-LOADING.md](references/REFERENCE-LOADING.md) for details. ## Validation ```bash # Run from the scripts directory cd scripts npm run references # Validate all skill links npm run tokens -- check # Check token limits ``` ### Integrity Checks When reviewing or authoring skills, verify: 1. **No broken links** - All referenced files exist 2. **No orphaned references** - All reference files are linked 3. **Token budgets** - References under 1000 tokens (split if exceeded) 4. **No duplicates** - Consolidate repeated content 5. **No out-of-place guidance** - Service-specific content belongs in service-specific references See [Validation](references/validation/README.md) for detailed procedures. ## Reference Documentation - [Guidelines](references/guidelines/README.md) - Detailed writing guidelines - [Token Budgets](references/token-budgets.md) - Limits and splitting guidance - [Reference Loading](references/REFERENCE-LOADING.md) - How references load - [Checklist](references/CHECKLIST.md) - Pre-submission checklist - [Validation](references/validation/README.md) - Link and reference validation - [agentskills.io/specification](https://agentskills.io/specification) - Official spec
More from microsoft/GitHub-Copilot-for-Azure
- airunway-aks-setupSet up AI Runway on AKS — from bare cluster to running model. Covers cluster verification, controller install, GPU assessment, provider setup, and first deployment. WHEN: \"setup AI Runway\", \"onboard AKS cluster\", \"install AI Runway\", \"airunway setup\", \"deploy model to AKS\", \"GPU inference on AKS\", \"KAITO setup on AKS\", \"run LLM on AKS\", \"vLLM on AKS\", \"set up model serving on AKS\", \"AI Runway controller\".
- analyze-skill-issuesQuery the integration-test storage account to find why a specific skill's tests are failing. Reads blob-stored test result files and surfaces error details. TRIGGERS: why is skill failing, skill test failures, debug skill tests, skill failing tests, analyze skill failures, why are tests failing for skill, skill test errors, investigate skill issues. DO NOT USE FOR: analyzing a GitHub Actions run report or comparing test runs across runs (use analyze-test-run).
- analyze-test-runAnalyze a GitHub Actions integration test run and produce a skill invocation report with failure root-cause issues. TRIGGERS: analyze test run, skill invocation rate, test run report, compare test runs, skill invocation summary, test failure analysis, run report, test results, action run report
- appinsights-instrumentationGuidance for instrumenting webapps with Azure Application Insights. Provides telemetry patterns, SDK setup, and configuration references. WHEN: how to instrument app, App Insights SDK, telemetry patterns, what is App Insights, Application Insights guidance, instrumentation examples, APM best practices.
- azure-aiUse for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybrid search, speech-to-text, text-to-speech, transcription, OCR. WHEN: AI Search, query search, vector search, hybrid search, semantic search, speech-to-text, text-to-speech, transcribe, OCR, convert text to speech.
- azure-aigatewayConfigure Azure API Management as an AI Gateway for AI models, MCP tools, and agents. WHEN: semantic caching, token limit, content safety, load balancing, AI model governance, MCP rate limiting, jailbreak detection, add Azure OpenAI backend, add AI Foundry model, test AI gateway, LLM policies, configure AI backend, token metrics, AI cost control, convert API to MCP, import OpenAPI to gateway.
- azure-cloud-migrateAssess and migrate cross-cloud workloads to Azure with reports and code conversion. Supports Lambda→Functions, Beanstalk/Heroku/App Engine→App Service, Fargate/Kubernetes/Cloud Run→Container Apps. WHEN: migrate Lambda to Functions, AWS to Azure, migrate Beanstalk, migrate Heroku, migrate App Engine, Cloud Run migration, Fargate to ACA, ECS/Kubernetes/GKE/EKS to Container Apps, cross-cloud migration.
- azure-complianceRun Azure compliance and security audits with azqr plus Key Vault expiration checks. Covers best-practice assessment, resource review, policy/compliance validation, and security posture checks. WHEN: compliance scan, security audit, BEFORE running azqr (compliance cli tool), Azure best practices, Key Vault expiration check, expired certificates, expiring secrets, orphaned resources, compliance assessment.
- azure-computeAzure VM and VMSS router for recommendations, pricing, autoscale, orchestration, connectivity troubleshooting, and capacity reservations. WHEN: Azure VM, VMSS, scale set, recommend, compare, server, website, burstable, lightweight, VM family, workload, GPU, learning, simulation, dev/test, backend, autoscale, load balancer, Flexible orchestration, Uniform orchestration, cost estimate, connect, refused, Linux, black screen, reset password, reach VM, port 3389, NSG, troubleshoot, capacity reservation, CRG, reserve VMs, guarantee capacity, pre-provision capacity, CRG association, CRG disassociation.
- azure-costUnified Azure cost management: query historical costs, forecast future spending, and optimize to reduce waste. WHEN: \"Azure costs\", \"Azure spending\", \"Azure bill\", \"cost breakdown\", \"cost by service\", \"cost by resource\", \"how much am I spending\", \"show my bill\", \"monthly cost summary\", \"cost trends\", \"top cost drivers\", \"actual cost\", \"amortized cost\", \"forecast spending\", \"projected costs\", \"estimate bill\", \"future costs\", \"budget forecast\", \"end of month costs\", \"how much will I spend\", \"optimize costs\", \"reduce spending\", \"find cost savings\", \"orphaned resources\", \"rightsize VMs\", \"cost analysis\", \"reduce waste\", \"unused resources\", \"optimize Redis costs\", \"cost by tag\", \"cost by resource group\", \"AKS cost analysis add-on\", \"namespace cost\", \"cost spike\", \"anomaly\", \"budget alert\", \"AKS cost visibility\". DO NOT USE FOR: deploying resources, provisioning infrastructure, diagnostics, security audits, or estimating costs for new resources not yet deployed.