mk.example

Validate SKILL.md frontmatter with name and description fields.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/mayknxyz/my-kit --skill mk-example
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mk.example
Source: https://github.com/mayknxyz/my-kit/tree/main/examples/example-skill
Command: npx skills add https://github.com/mayknxyz/my-kit --skill mk-example

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This is a template Skill Unit that demonstrates the required frontmatter and structure for a valid Skill Unit, including a SKILL.md with a name and description and a Markdown body loaded into context.

Core Features & Use Cases

  • Validates the presence of a SKILL.md frontmatter with name and description.
  • Documents the Skill Unit structure for discovery, indexing, and activation.
  • Serves as a ready-to-run template for demonstrations and onboarding.

Quick Start

Create a new skill folder with a SKILL.md frontmatter and verify the YAML defines a name and description.

Frequently Asked Questions about mk.example

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

FAQPage Schema
How do I validate YAML frontmatter in a SKILL.md file?

To validate YAML frontmatter in a SKILL.md file, ensure the metadata includes mandatory name and description fields. This template Skill Unit checks for these required fields to confirm your documentation is properly structured for repository discovery and automated loading.

What is a Skill Unit template and when do I need it?

A Skill Unit template is a standardized folder structure containing a SKILL.md file with YAML frontmatter. You need it when creating new skills for demonstrations or onboarding, as it provides the required structured metadata and readable Markdown body for automated indexing and activation.

How to set up a skill folder for automated repository discovery?

Set up a skill folder for automated repository discovery by creating a SKILL.md file with YAML frontmatter defining name and description. This template enforces mandatory fields and supports optional resources like scripts, references, and assets while surfacing safety checks for toxic content.

Does my skill metadata need a specific format for indexing and activation?

Your skill metadata needs YAML frontmatter in a SKILL.md file with mandatory name and description fields for proper indexing and activation. This template demonstrates the exact structured metadata format required to support repository discovery and automated loading mechanisms.

What are the mandatory and optional fields for skill documentation validation?

Mandatory fields for skill documentation validation are name and description in the YAML frontmatter. Optional resources include scripts, references, and assets, while the validation process also surfaces safety checks for toxic content within the readable Markdown body.

Why does my Skill Unit fail validation during automated loading?

Your Skill Unit fails validation during automated loading if the SKILL.md file is missing or lacks mandatory YAML frontmatter fields like name and description. This template validates the presence of these required fields to ensure proper documentation and successful repository discovery.