write-a-skill

Créer de nouvelles compétences d'agent avec une structure appropriée, une divulgation progressive et des ressources groupées. Utiliser lorsque l'utilisateur souhaite créer, rédiger ou construire une nouvelle compétence.

npx skills add https://github.com/sanity-io/sanity --skill write-a-skill

Writing Skills

Process

  1. Gather requirements - ask user about:

    • What task/domain does the skill cover?
    • What specific use cases should it handle?
    • Does it need executable scripts or just instructions?
    • Any reference materials to include?
  2. Draft the skill - create:

    • SKILL.md with concise instructions
    • Additional reference files if content exceeds 500 lines
    • Utility scripts if deterministic operations needed
  3. Review with user - present draft and ask:

    • Does this cover your use cases?
    • Anything missing or unclear?
    • Should any section be more/less detailed?

Skill Structure

skill-name/
├── SKILL.md           # Main instructions (required)
├── REFERENCE.md       # Detailed docs (if needed)
├── EXAMPLES.md        # Usage examples (if needed)
└── scripts/           # Utility scripts (if needed)
    └── helper.js

SKILL.md Template

---
name: skill-name
description: Brief description of capability. Use when [specific triggers].
---

# Skill Name

## Quick start

[Minimal working example]

## Workflows

[Step-by-step processes with checklists for complex tasks]

## Advanced features

[Link to separate files: See [REFERENCE.md](REFERENCE.md)]

Description Requirements

The description is the only thing your agent sees when deciding which skill to load. It's surfaced in the system prompt alongside all other installed skills. Your agent reads these descriptions and picks the relevant skill based on the user's request.

Goal: Give your agent just enough info to know:

  1. What capability this skill provides
  2. When/why to trigger it (specific keywords, contexts, file types)

Format:

  • Max 1024 chars
  • Write in third person
  • First sentence: what it does
  • Second sentence: "Use when [specific triggers]"

Good example:

Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when user mentions PDFs, forms, or document extraction.

Bad example:

Helps with documents.

The bad example gives your agent no way to distinguish this from other document skills.

When to Add Scripts

Add utility scripts when:

  • Operation is deterministic (validation, formatting)
  • Same code would be generated repeatedly
  • Errors need explicit handling

Scripts save tokens and improve reliability vs generated code.

When to Split Files

Split into separate files when:

  • SKILL.md exceeds 100 lines
  • Content has distinct domains (finance vs sales schemas)
  • Advanced features are rarely needed

Review Checklist

After drafting, verify:

  • Description includes triggers ("Use when...")
  • SKILL.md under 100 lines
  • No time-sensitive info
  • Consistent terminology
  • Concrete examples included
  • References one level deep

Plus de skills de sanity-io

performance-optimization
sanity-io
Optimise les performances de l'application. À utiliser lorsque des exigences de performance existent, lorsque vous suspectez des régressions de performance, ou lorsque les Core Web Vitals ou les temps de chargement…
official
rxjs-like-a-pro
sanity-io
Cette compétence vous aide à écrire du code RxJS idiomatique, composable et exempt d'écueils courants. La philosophie centrale : gardez la logique dans la chaîne d'observables. Chaque fois que vous utilisez .subscribe(), demandez-vous si le travail pourrait plutôt être exprimé comme une transformation à l'intérieur de .pipe().
official
find-skills
sanity-io
Aide les utilisateurs à découvrir et installer des compétences d'agent lorsqu'ils posent des questions comme "comment faire X", "trouver une compétence pour X", "existe-t-il une compétence qui peut...", ou expriment...
official
next-cache-components
sanity-io
Composants de cache Next.js 16 - PPR, directive use cache, cacheLife, cacheTag, updateTag
official
vercel-react-best-practices
sanity-io
Directives d'optimisation des performances React et Next.js de Vercel Engineering. Cette compétence doit être utilisée lors de l'écriture, de la révision ou du refactoring de code React/Next.js…
official
frontend-design
sanity-io
Créez des interfaces frontend distinctives et de qualité professionnelle, avec un design de haut niveau. Utilisez cette compétence lorsque l'utilisateur demande de construire des composants web, des pages, ou…
official
plugin-transfer
sanity-io
Guide les agents dans la migration d'un plugin existant vers ce monorepo à l'aide du workflow du générateur copy-plugin.
official
test-studio-script-runner
sanity-io
Explique l'outil Script Runner de dev/test-studio. À utiliser lors de l'ajout, de la modification, de l'exécution ou de la documentation de scripts dans dev/test-studio/src/script-runner, ou lorsque le…
official