CommunityRédaction et éditiongithub.com

BuilderIO/adding-a-skill

Utilisez dans le dépôt BuilderIO/skills pour ajouter, mettre à jour, publier, documenter, valider ou connecter une compétence publique. Couvre les fichiers locaux du dépôt, la documentation du catalogue racine, les métadonnées du plugin, le chemin d'installation dynamique @agent-native/skills, les blocs d'instructions AGENTS/CLAUDE optionnels gérés dans ../agent-native/framework, et les pièges des compétences Plan générées/synchronisées.

Qu'est-ce que adding-a-skill ?

Ce skill guide les contributeurs du dépôt `BuilderIO/skills` dans le processus d'ajout, de mise à jour, de publication, de documentation, de validation ou de connexion d'un skill public. Il couvre l'ensemble des étapes nécessaires, de la création des fichiers de skill dans `skills/<nom>/` à la configuration des instructions gérées pour les assistants IA, en passant par la validation et les tests d'installation. Il prend en charge `@agent-native/skills` (Codex, Cursor, Claude Code) en tant que plateforme principale, avec des instructions spécifiques pour les skills standards, les skills avec blocs d'instructions gérés, les skills basés sur des applications ou MCP, et les skills Plan spéciaux comme `visual-plan` et `visual-recap`. Le document met en garde contre les pièges de synchronisation des skills Plan et fournit des commandes de validation concrètes. Il est indispensable pour maintenir la cohérence entre ce dépôt et le framework `agent-native`, et garantir que les skills sont correctement découverts et installables via la CLI.

Compatible avec✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/BuilderIO/skills/tree/main/.agents/skills/adding-a-skill

Installed? Explore more Rédaction et édition skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Ajouter une compétence

Utilisez ceci pour le travail sur les compétences publiques dans ce dépôt. Conservez les modifications de compétences ordinaires dans skills/<nom-de-la-compétence>/ ; conservez les instructions propres au dépôt sous .agents/skills/.

Déterminez d'abord le type de compétence

  • Compétence publique simple : un dossier normal sous skills/<nom>/ avec SKILL.md. C'est le cas courant. @agent-native/skills les découvre dynamiquement à partir de BuilderIO/skills@main, donc il n'y a pas de registre de framework à modifier juste pour que npx @agent-native/skills@latest add --skill <nom> fonctionne.
  • Compétence de type instruction : une compétence simple qui doit éventuellement écrire une ligne AGENTS.md / CLAUDE.md gérée et toujours active lorsque les utilisateurs passent --update-instructions. Ces compétences nécessitent une modification supplémentaire du framework ; voir « Blocs d'instructions gérés » ci-dessous.
  • Compétence avec application ou MCP : une compétence qui enregistre un serveur MCP hébergé ou local ou utilise un comportement d'installation appartenant au framework. Ce ne sont pas des compétences publiques simples ; examinez ../agent-native/framework/packages/core/src/cli/skills.ts et ../agent-native/framework/packages/skills/src/built-in-apps.ts.
  • Compétences Plan : visual-plan et visual-recap ont des copies générées/synchronisées entre ce dépôt et ../agent-native/framework. Ne les traitez pas comme un dossier de prose autonome.

Liste de contrôle pour les compétences publiques simples

  1. Créez ou mettez à jour skills/<nom-de-la-compétence>/SKILL.md.

  2. Ajoutez skills/<nom-de-la-compétence>/README.md lorsque la compétence doit apparaître dans le catalogue public. Ce dépôt utilise intentionnellement les README pour les pages de compétences publiques.

  3. Si le positionnement dans la collection change, mettez à jour le README.md racine, .codex-plugin/plugin.json, .claude-plugin/plugin.json et les descriptions dans package.json.

  4. Gardez la compétence concise. Placez uniquement les instructions essentielles pour l'agent dans SKILL.md ; évitez les documents supplémentaires sauf s'ils soutiennent directement la compétence.

  5. Validez avec :

    python3 /Users/steve/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/<nom-de-la-compétence>
    
  6. Testez la découverte d'installation localement avant d'affirmer que le chemin CLI fonctionne :

    node ../agent-native/framework/packages/skills/dist/cli.js add --copy . --skill <nom-de-la-compétence> --client codex --scope project --dry-run --json
    
  7. Exécutez npm run check. Si cela échoue sur la synchronisation visual-plan / visual-recap alors que la modification n'est pas liée, signalez-le spécifiquement au lieu de réécrire ces compétences à la légère.

Chemin d'installation de @agent-native/skills

Pour une compétence publique simple, le chemin d'installation est dynamique :

  • ../agent-native/framework/packages/skills/src/index.ts définit DEFAULT_SKILLS_SOURCE = "BuilderIO/skills".

  • Il matérialise ce dépôt, lit les manifestes des plugins via resolveSkillsRoot, et découvre chaque skills/*/SKILL.md via discoverSkills.

  • Par conséquent, un nouveau dossier sous skills/<nom>/ est suffisant pour :

    npx @agent-native/skills@latest add --skill <nom>
    

Aucune modification du registre intégré de @agent-native/core n'est nécessaire, sauf si la compétence est adossée à une application ou nécessite un comportement d'installation personnalisé.

Blocs d'instructions gérés

Si la compétence doit affecter AGENTS.md / CLAUDE.md via --update-instructions, mettez à jour le wrapper du framework :

  • Ajoutez une ligne concise dans ../agent-native/framework/packages/skills/src/index.ts à l'intérieur de instructionContentForSkill(skillName).

  • Ajoutez ou mettez à jour les tests dans ../agent-native/framework/packages/skills/src/index.spec.ts.

  • Exécutez :

    pnpm --filter @agent-native/skills test -- src/index.spec.ts --runInBand
    

Utilisez ceci pour les règles de comportement durables comme quick-recap, efficient-fable, stay-within-limits, et probablement les comportements axés sur la documentation comme read-the-damn-docs.

Compétences avec application ou MCP

Si une compétence nécessite des outils hébergés, une authentification, un enregistrement MCP, un mode de fichiers locaux ou des indicateurs d'installation spéciaux, examinez le framework avant de modifier :

  • ../agent-native/framework/packages/core/src/cli/skills.ts
  • ../agent-native/framework/packages/skills/src/built-in-apps.ts
  • ../agent-native/framework/packages/skills/src/sync-with-core.spec.ts

Gardez les descripteurs MCP du framework et de @agent-native/skills autonome synchronisés.

Pièges de synchronisation des compétences Plan

visual-plan et visual-recap sont spéciaux :

  • Le framework contient des copies canoniques/générées et des bundles du marketplace Plan.
  • La commande npm run check de ce dépôt compare ces copies et peut échouer en cas de dérive non liée à une nouvelle compétence simple.
  • Lorsque vous modifiez intentionnellement les compétences Plan, utilisez les chemins de synchronisation du framework au lieu de modifier manuellement les copies générées. Recherchez dans le framework sync-plan-marketplace, sync-workspace-skills et skills.sync.spec.ts.

Rapport final

En terminant une modification de compétence, informez l'utilisateur :

  • Quels fichiers de compétence ont été modifiés.
  • Si la découverte d'installation dynamique de @agent-native/skills est suffisante.
  • Si une modification d'instruction gérée du framework a été ajoutée ou intentionnellement laissée comme suivi.
  • Quelles commandes de validation ont réussi ou échoué, y compris les échecs de synchronisation Plan non liés.

Individual skills in this repo

This repo contains 10 individual skills — each has its own dedicated page.

BuilderIO/agent-watchdog

Use when asked to watch, babysit, audit, review, compare, or fix another agent's work from a Codex session ID, Claude Code session/transcript, chat/thread link, PR, branch, log, or pasted run summary. Monitor until the other agent is done or blocked, reconstruct what the user asked, inspect what the agent actually changed and verified, report gaps, and optionally make scoped fixes when the user authorizes repair.

BuilderIO/efficient-fable

Use when running Claude Fable on codebase-heavy or token-heavy work and the user wants Fable to orchestrate research, coding, and testing while cheaper subagents do bounded heavy lifting.

BuilderIO/efficient-frontier

Apply the same orchestration as `/efficient-fable` to any high-cost frontier model: delegate research, coding, and testing to cheaper subagents while keeping planning, synthesis, and final review with the expensive model.

BuilderIO/plan-arbiter

Use when asked to compare, cross-review, merge, judge, choose, or arbitrate competing plans from multiple agents such as Codex and Claude Code; when given two or more proposed plans, session IDs, transcripts, plan documents, PR descriptions, or pasted strategies; or when the user wants one recommended execution plan after agents review each other's proposals.

BuilderIO/plow-ahead

Use when the user explicitly wants autonomous progress without routine clarification stops: "plow ahead", "do not stop", "use your best judgment", "keep going until done", "finish while I am away", "do not ask questions unless truly blocked", or similar. Convert ordinary ambiguity into stated assumptions, proceed through implementation and validation, stop only for true blockers, and end with a clear recap of decisions, changes, verification, and residual risk.

BuilderIO/quick-recap

Use when adding or following the red/yellow/green final status block convention for agent responses, especially by installing managed AGENTS.md or CLAUDE.md instructions.

BuilderIO/read-the-damn-docs

Use when implementing, integrating, upgrading, debugging, or answering anything involving third-party APIs, libraries, frameworks, CLIs, cloud services, model/provider SDKs, fast-moving product behavior, user requests for latest/current/official behavior, unfamiliar repo docs/specs, errors that may indicate API drift, or high-stakes auth, security, billing, data, migration, deployment, compliance, or privacy behavior. Forces Codex to web-search for current official docs and read primary docs before assuming from memory.

BuilderIO/stay-within-limits

Use when long-running or parallel agent work must respect 5-hour and weekly usage limits by checking usage between waves, pausing near the cap, and resuming only when the window is clear.

BuilderIO/visual-plan

Turn ordinary text plans into rich interactive visual plans with diagrams, file maps, annotated code, open questions, and UI/prototype review when useful.

BuilderIO/visual-recap

Turn a PR, branch, commit, or git diff into an interactive visual recap with diagrams, file maps, API/schema summaries, annotated diffs, and focused review notes.

Skills associés