Skip to content

AGENTS.md

Latest commit

 

History

History
39 lines (32 loc) · 1.61 KB

AGENTS.md

File metadata and controls

39 lines (32 loc) · 1.61 KB

Agent Instructions

Skill Structure

plugins/sentry-skills/skills/<skill-name>/SKILL.md

Creating/Updating Skills

ALWAYS use /skill-writer — it handles requirements, writing, registration, and validation. (/skill-creator remains an alias.)

Alias Policy

  • Keep alias skills (for example create-pr, skill-creator) only for backward compatibility.
  • Do not list alias/symlink skills in "Available Skills" documentation tables.
  • List only canonical skills in public skill inventories (for example pr-writer, skill-writer).

Registration Checklist

  1. Create plugins/sentry-skills/skills/<skill-name>/SKILL.md
  2. Add to README.md Available Skills table (alphabetical by canonical skill name; exclude aliases/symlinks)
  3. Add to .claude/settings.json: Skill(sentry-skills:<skill-name>)
  4. Add to allowlist in plugins/sentry-skills/skills/claude-settings-audit/SKILL.md

Key Conventions

  • Frontmatter --- must be the first line of SKILL.md — no comments before it
  • name field must match the directory name exactly
  • description includes trigger keywords — this is how agents discover the skill
  • Attribution comments go after the closing ---
  • Python scripts: always use uv run <script>, never python or python3
  • Keep SKILL.md under 500 lines; move reference material to references/

Commit Attribution

AI commits MUST include:

Co-Authored-By: (the agent's name and attribution byline)

References

  • Skill template and optional fields: README.md
  • Testing and PR workflow: CONTRIBUTING.md
  • Agent Skills Spec