Ship a skill with your module · AI & coding agents

A module that ships a skill teaches every agent when and how to use it, in the version the project installed. The antelopejs plugin links it into Claude Code and Codex, and the dms-ai assistant loads it, with nothing else to configure.

Write the skill

Create one folder per skill under skills/, each holding a SKILL.md with a frontmatter name and a description that says when to use it:

skills/dms-cookbook/SKILL.md

---
name: dms-cookbook
description: Adds recipes, ingredients and meal plans to a DMS project with @acme/dms-cookbook. Use when the user wants recipe pages, a meal planner, or asks about the cookbook module.
---

# Cookbook

Load the module in `antelope.config.ts`, then …

Declare it

List the folder that holds your skills in package.json, and publish it with the package:

package.json

{
  "files": ["dist", "frontend-vue", "skills"],
  "antelopeJs": {
    "skills": ["./skills"]
  }
}

Check it loads

In a project that installs your module, run /antelopejs:sync-skills in Claude Code, or npx -y github:AntelopeJS/agent-skills sync: the skill appears as .claude/skills/<package>--dms-cookbook and .agents/skills/<package>--dms-cookbook. In the dms-ai assistant, open Assistant → Skills.

Write it for an agent

Lead with when. The description is always loaded; the body only when it matches. Name the cases that should trigger it.
Keep it short. Put the steps in SKILL.md and push long reference material into a REFERENCE.md next to it, linked from the body.
Route, don't repeat. Point to the dms-* skills for pages, auth and the dev servers instead of restating them.
Stay current. The skill ships with each release, so update it with the API it describes.

Next steps

Distributable module

Package the module the skill describes.

Overview

The three layers of the skill suite.