@workos/skills

WorkOS skills for AI coding agents. Two skills and 40 reference files covering AuthKit, SSO, Directory Sync, RBAC, Vault, Migrations, backend SDKs, and more.

Install as Claude Code Plugin

npx skills add workos/skills

This installs two skills: workos and workos-widgets. The workos skill acts as a router that automatically loads the right reference for your task (AuthKit setup, SSO, migrations, etc.) so you don't need to install references individually.

Works with Claude Code, Codex, Goose, and any agent that supports the skills.sh format.

Install as Cursor Plugin

Install from the Cursor Marketplace (search "WorkOS"), or clone and symlink locally — see Local Development below.

Install as npm Package

For programmatic access to skill/reference content (e.g., from the WorkOS CLI):

npm install @workos/skills

import { getReference, getSkill } from '@workos/skills';

// Read reference content directly
const content = await getReference('workos-authkit-nextjs');

// Read a skill's SKILL.md content
const router = await getSkill('workos');

Path helpers are also available for consumers that need file paths (e.g., skill discovery):

import { getReferencePath, getSkillsDir, getSkillPath } from '@workos/skills';

const refPath = getReferencePath('workos-authkit-nextjs'); // absolute path to .md file
const skillsDir = getSkillsDir(); // directory containing workos/ and workos-widgets/
const skillPath = getSkillPath('workos'); // absolute path to SKILL.md

Exports

Skills

Two registered skills:

Everything else is a reference file under references/. The router dispatches to the right reference via progressive disclosure.

References

Note: References are not standalone skills. They are loaded automatically by the workos skill based on your task. You do not need to install them individually.

Development

pnpm test          # vitest
pnpm lint          # oxlint
pnpm format        # oxfmt

Local Cursor development

Cursor loads local plugins from ~/.cursor/plugins/local/. Symlink this repo's plugin directory, then reload Cursor:

ln -s "$(pwd)/plugins/workos" ~/.cursor/plugins/local/workos

Then in Cursor: Cmd+Shift+P → Developer: Reload Window (or fully quit and relaunch Cursor if the reload doesn't pick up new skills).

Eval framework

Measures whether skills improve agent-generated code. Each case runs the same prompt with and without the skill, scores both outputs, and reports the delta.

pnpm eval -- --dry-run                        # verify cases load
pnpm eval -- --no-cache                       # full run (42 cases, ~$1.70)
pnpm eval -- --no-cache --case=sso-node-basic # single case
pnpm eval -- --no-cache --cases=sso-node-basic,sso-ruby-domain-routing # selected cases
pnpm eval -- --no-cache --fail-on-regression  # with gates
pnpm eval:risk -- --samples=8                 # rerun latest triage cases with saved samples

How it works

Each reference file follows the same pattern:

1. Doc URLs — source of truth links (agent fetches these first)
2. Gotchas — non-obvious traps the LLM gets wrong from training data
3. Endpoints (optional) — API endpoint table for quick reference

AuthKit and backend SDK references are richer — they include step-by-step installation instructions, decision trees, verification checklists, and error recovery.

The router (workos/SKILL.md) maps user intent to the right reference file.

License

MIT