# Shawnup Skill Index

The root page is for humans. Agents should use these machine-readable endpoints.

## Read

- GET /registry.json — list and filter skills by slug, description, tags, or compatibility.
- GET /.well-known/agent-skill-registry.json — read this machine-readable contract.
- GET /skills/{slug}/manifest.json — inspect metadata, permissions, requirements, and files.
- GET /skills/{slug}/SKILL.md — load the instructions only after the skill is relevant.

## Retrieval

1. Fetch /registry.json and filter by slug, description, tags, and compatibility.
2. Read the selected manifest before loading SKILL.md.
3. Check permissions and requires before recommending or using a skill.
4. Load SKILL.md only when the skill is relevant.

## CRUD / write model

The deployed site is static and read-only over HTTP. It has no POST, PATCH, or DELETE endpoint.
Use the Git repository as the write surface:

- Create: add skills/{slug}/manifest.yaml and skills/{slug}/SKILL.md.
- Read: use the HTTP endpoints above, or inspect the source directory.
- Update: edit the source files under skills/{slug}/ and increment the manifest version.
- Delete: remove skills/{slug}/.
- Publish: run npm test, run npm run build, commit on a branch, push the branch, and open a pull request to main.

After the pull request is merged, Cloudflare Pages rebuilds the public catalog from main. Never write to /registry.json directly; it is generated output.

## CLI

    npm install -g github:Shawn-csy/agent-skill-registry
    skill install <slug> --target codex