smith-skills

Define documentation standards for AGENTS.md and SKILL.md files.

1|Updated Nov 25, 2025

Search Tags:#documentation #guidelines #authoring #agents.md #skill.md #progressive-disclosure #xml-tags

Ready to run

npx skills add https://github.com/tianjianjiang/smith --skill smith-skills

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: smith-skills
Source: https://github.com/tianjianjiang/smith/tree/main/smith-skills
Command: npx skills add https://github.com/tianjianjiang/smith --skill smith-skills

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps teams write and maintain AGENTS.md and SKILL.md files that define how Smith loads and uses agent skills, ensuring consistent structure and safe loading practices.

Core Features & Use Cases

Provides a standardized frontmatter schema (name, description) and content layout for skills.
Documents progressive disclosure, rule loading, and XML tag usage to improve clarity and safety.
Serves as a reference for authors creating or editing agent instructions, rules, and documentation.

Quick Start

Follow this guide to craft or update AGENTS.md and SKILL.md for new skills.

Frequently Asked Questions about smith-skills

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What is an AGENTS.md or SKILL.md file and when do I need one?▼

AGENTS.md and SKILL.md files define how Smith loads and uses agent skills, ensuring consistent structure and safe loading practices. You need them when creating or editing agent instructions, rules, and steering documentation.

How do I structure frontmatter and content layout for agent documentation?▼

To structure agent documentation, use a standardized frontmatter schema with name and description fields, followed by a required three-section description layout. Apply clear content organization guidelines and use XML tags for progressive disclosure and rule loading.

What's the best way to write consistent agent instructions and rules?▼

The best way to write consistent agent instructions is to apply documentation standards that enforce frontmatter with name and description, the required three-section description layout, and clear content organization guidelines within Smith.

How does progressive disclosure work with XML tags in skill files?▼

Progressive disclosure with XML tags improves clarity and safety by controlling how rules and instructions are loaded in skill files. It documents rule loading practices to ensure structured, safe loading of agent skills within Smith.

Can I use this guide to update existing agent steering documentation?▼

Yes, you can use this guide to update existing agent steering documentation. It serves as a reference for authors creating or editing agent instructions, rules, and documentation, ensuring consistent structure and safe loading practices.

Do I need specific frontmatter fields for Smith to load skills safely?▼

Yes, you need a standardized frontmatter schema containing name and description fields for Smith to load skills safely. Enforcing this frontmatter alongside the required three-section description layout ensures consistent skill definitions.