Use when working with examples, tutorials, or skill documentation. Invoke when the user asks about skill configuration, manifest structure, or creating new skills.
The 'example-skill' is designed to assist users with understanding and working with example-based content, tutorials, or skill documentation. It helps guide users through various configurations, such as skill setup, manifest structure, and creating new skills. This skill addresses the need for clear and structured guidance when users require assistance in understanding the SKILL.md format or configuring their skills properly. It is particularly useful in environments where documentation and setup clarity are essential, allowing users to make informed decisions when creating or managing skills.
This skill includes several key features that help users understand the SKILL.md structure, including its YAML frontmatter, required fields, and the proper format. The skill also explains how the 'description' field aids in skill discovery and provides examples of both effective and ineffective descriptions. The skill empowers users to confidently create, document, and configure their skills by offering helpful tips, clear explanations, and best practices. Furthermore, it outlines what the skill is not intended to provide, such as CLI tools or plugins, which helps avoid any confusion.
Ideal users of this skill include those who are looking to improve their understanding of skill documentation or need to develop new skills. This can include developers, technical writers, or anyone interested in enhancing their ability to manage and configure AI-based skills. Use cases include creating new skills, configuring skill manifests, and learning best practices for skill documentation.
Use 'example-skill' when working with skill documentation, configuring skills, or understanding the SKILL.md format, especially when setting up new skills.
'example-skill' supports the tools Read, Glob, and Grep. These tools help with reading files, searching content, and extracting specific data within the documentation.
'example-skill' cannot be used for tasks like running CLI tools, interacting with MCP servers, or managing plugins and hooks. For such tasks, a full Claude Code plugin is required.
The SKILL.md file requires two main fields: 'name' (the skill identifier) and 'description' (which tells Claude when to invoke the skill). The description field is critical for proper skill discovery.
While 'name' and 'description' are required, you can optionally add 'allowed-tools' to specify the tools that the skill can invoke. However, custom fields beyond those described in the documentation are not supported.
Quick Setup:
.claude/skills/Repository
kraitsura/grimoire