Npm Agentskills

npm-agentskills

Bundle agent skills with your npm packages to help AI assistants understand your library.

What Are Agent Skills?

Agent Skills provide contextual documentation that AI coding assistants load automatically. When developers use your library, their AI agent reads your skill to deliver accurate guidance on your API, patterns, and best practices.

Skills follow the [agentskills](https://agentskills.io) open format, supported by Claude Code, GitHub Copilot, Cursor, and other AI coding tools.

This package enables library authors to bundle skills with their npm packages. When users install your package, their AI agent discovers and exports the skills to the appropriate location.

Installation

npm install npm-agentskills

For Library Authors: Bundling Skills

Add an `agents` field to your `package.json` that points to skill directories:

{
  "name": "my-awesome-library",
  "agents": {
    "skills": [
      { "name": "my-skill", "path": "./skills/my-skill" }
    ]
  }
}

Create skill directories with a `SKILL.md` file:

skills/my-skill/
├── SKILL.md           # Required: entry point with frontmatter
└── references/        # Optional: additional documentation files
    └── api.md

**Learn how to write skills:** See the [agentskills.io specification](https://agentskills.io/specification) for the complete guide on creating effective agent skills.

For End Users: Installing Skills

Nuxt Applications (Automatic)

Add the module to your Nuxt config. The module automatically discovers skills from `node_modules` and exports them when you run `nuxi prepare` or `nuxi dev`:

export default defineNuxtConfig({
  modules: ['npm-agentskills/nuxt'],
  agents: {
    targets: ['claude', 'cursor'],
  },
})

The module scans your dependencies for packages with `agents` fields and exports their skills to project-local directories.

Other Frameworks (CLI)

Run the CLI after installing packages that