mcpField
E
example-skill

example-skill

github.com/vincentkocAgent workflows11138 installsUpdated 3d ago
Repository

About example-skill

example-skill is a reusable template for creating and maintaining consistent skills. It guides contributors through required sections, deterministic checks, and stable output formats.

Key features

  1. 01Spec-aligned skill template
  2. 02Guided input and output structure
  3. 03On-demand reference loading
  4. 04Deterministic preflight script
  5. 05Frontmatter and path checks

Use cases

  1. 01Scaffold a skill with required sections
  2. 02Refactor details into reference files
  3. 03Add repeatable validation checks

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/vincentkoc/dotskills --skill example-skill

After installing, type/example-skillin Claude Code to confirm it loaded.

Details

From the project README

Example Skill

Purpose

Provide a spec-aligned template for creating consistent, reusable skills.

When to use

  • You are adding a new skill to this repository.
  • You want a starter structure with required sections.

Workflow

  1. State the objective in one sentence.
  2. Collect only required inputs.
  3. Execute deterministic steps.
  4. Load deeper context only when needed:
    • references/REFERENCE.md
    • assets/output-template.md
    • agents/openai.yaml
  5. Return output in a stable format.
  6. Use scripts/example-check.sh for a deterministic preflight check.

Inputs

  • Task objective
  • Constraints
  • Output destination

Outputs

  • Primary deliverable
  • Follow-up checks

Examples

  • Build a new skill skeleton with required sections and valid frontmatter.
  • Refactor an existing skill to move deep details into references/.
  • Add deterministic checks under scripts/ for repeatable verification.

Edge cases

  • Missing frontmatter fields: stop and add required fields first.
  • Invalid name format: normalize to lowercase-hyphen and match directory name.
  • Broken resource paths: fix links so all referenced files exist.

Guardrails

  • Keep instructions concrete and testable.
  • Avoid unnecessary context loading.
  • Prefer deterministic commands over manual steps.
  • Keep file references one level deep from SKILL.md.

Comments

Markdown supported