Agent skill
smith-skills
Agent skills authoring guide for AGENTS.md and SKILL.md files. Use when creating or editing agent instructions, rules, or documentation. Covers progressive disclosure, rule loading, XML tag usage, and token budget guidelines.
Install this agent skill to your Project
npx add-skill https://github.com/tianjianjiang/smith/tree/main/smith-skills
SKILL.md
Agent Skills Authoring Guide
- Scope: Writing AGENTS.md, SKILL.md, and steering files
- Load if: Creating or editing agent instructions, rules, or documentation
- Prerequisites:
@smith-xml/SKILL.mdfor approved XML tags - Based on: agentskills.io standards
Progressive Disclosure Philosophy
Skills and rules follow 3-tier loading to minimize token usage:
- Layer 1: AGENTS.md entry point (~500 tokens, always loaded)
- Layer 2: Individual standards (<2000 tokens, on-demand by task)
- Layer 3: Detailed resources (loaded when explicitly needed)
Lost-in-the-Middle research: LLMs have U-shaped attention
- First 20% (primacy zone): CRITICAL rules,
<required>/<forbidden>tags - Middle 60%: Details, examples (weakest attention)
- Last 10% (recency zone): ACTION items, checklists,
<related>refs
Rule Loading Notification
Every AGENTS.md MUST define:
- Which files are always-active vs on-demand
- Notification format: "Loaded @file.md (reason)"
- Deactivation trigger: "Unload after N turns unused"
- Context thresholds: Claude Code 50%/60%, Cursor/Kiro 70%/80%
Enforcement: Reporting proves actual loading, not fake compliance
Critical Rules (Primacy Zone)
- Bullet lists over tables for ALL content (instructions AND reference data)
- LLMs parse bullet lists more reliably than tables
- XML tags for semantic boundaries:
<required>,<forbidden>,<context>,<examples> - Metadata blocks at file start for early loading
- Lines under 80 characters for better parsing
- No nested lists deeper than 2 levels
- Code blocks with language hints for all code examples
- Shell code blocks must be copy-paste ready - no inline comments, move descriptions outside as text or subsection titles
File Structure
AGENTS.md (entry point, <500 tokens):
- Standards index with descriptions
- Core principles summary
- Context thresholds
- Rule loading protocol
SKILL.md (Agent Skills format):
- YAML frontmatter:
name(kebab-case, max 64 chars),description(max 1024 chars) - Optional:
license,compatibility,metadata - Body: <500 lines recommended
Steering files (.md):
- Metadata block at start
- Critical rules in first 20% (primacy zone)
- Action items in last 10% (recency zone)
Skill Reference Convention
Backtick usage for skill references:
- Always-load skills (core): No backticks - @smith-principles/SKILL.md
- Dynamic skills: With backticks -
@smith-python/SKILL.md - Self-reference: Bold without @ - smith-skills
This distinguishes core skills (always in context) from contextual skills (loaded on demand).
Heading Hierarchy
- Use consistent levels (no skipping H2 → H4)
- H1: File title only
- H2: Major sections
- H3: Subsections
- Avoid H4+ (indicates over-nesting)
XML Tag Usage
Universal tags (cross-platform):
<instructions>- Step-by-step guidance<context>- Background information<examples>- Correct patterns only<constraints>- Behavioral limitations
Claude-specific:
<required>- Mandatory rules<forbidden>- Anti-patterns only<metadata>- File metadata<related>- Cross-references
- Mixing good/bad examples in same XML tag
- Inventing placeholder-style tags (
<type>,<scope>) - Markdown tables (use bullet lists for ALL content, even reference data)
- Nested lists deeper than 2 levels
- Skipped heading levels
- Inline comments inside shell code blocks
Token Budget Guidelines
- AGENTS.md entry point: <500 tokens
- Individual standard files: <2000 tokens
- SKILL.md files: <500 lines (~5000 tokens max)
- Session total: <5000 tokens (index + 1-2 active skills)
Good: Bullet list for rules
<required>
- Always use `uv` for Python packages
- Type hints on all public functions
- Run tests before committing
</required>
Good: Reference data (bullet list preferred over table)
**Context thresholds:**
- Claude Code: 50% warning, 60% critical
- Cursor: 70% warning, 80% critical
- Kiro: 70% warning, 80% critical
@smith-xml/SKILL.md- Approved XML tags and usage- @smith-ctx/SKILL.md - Context management strategies
- @smith-principles/SKILL.md - Core coding principles
ACTION (Recency Zone)
When creating AGENTS.md:
- Keep under 500 tokens
- Declare always-active files
- Define semantic activation triggers
- Add context thresholds
When creating skill files:
- Add
<metadata>with Load if condition - Put CRITICAL rules in first 20%
- Put ACTION items in last 10%
- Add
<related>cross-references
- Tables for instructions (use bullet lists)
- Nested lists deeper than 2 levels
- Custom/invented XML tags
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
smith-style
File naming, path standards, and conventional commits. Use when naming files, creating branches, writing commit messages, or setting up new projects. Covers underscore vs hyphen conventions, commit format, and branch naming patterns.
smith-stacks
Stacked pull request workflows for large features. Use when creating stacked PRs, managing dependent PRs, or rebasing after parent merges. Covers stack creation, merge order, and squash merge handling.
smith-python
Python development with uv, pytest, ruff, and type hints. Use when writing Python code, running tests, managing Python packages, or working with virtual environments. Covers import organization, type hints, pytest patterns, and environment variables.
smith-principles
Fundamental coding principles (DRY, KISS, YAGNI, SOLID, HHH). Use when starting any development task, evaluating implementation approaches, or reviewing code quality. Always active as foundation for all development decisions.
smith-nuxt
Nuxt 3 development patterns including auto-import stubbing for tests, environment variable conventions, and middleware testing. Use when working with Nuxt projects, testing Nuxt components/middleware, or configuring Nuxt environment variables.
smith-plan
Plan tracking protocol (portable). Progress tracking with checkboxes, iteration workflow, completion/blocker signals. Use when executing multi-step plans, tracking task progress, or working from plan files. IMPORTANT - Always update the plan file after completing tasks.
Didn't find tool you were looking for?