Document YAML frontmatter fields for custom skill.md files #2848
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Addresses all review comments from PR #2847 by documenting YAML frontmatter fields for custom
skill.mdfiles.Changes Made
ai/skillmd.mdxwith table of all supported fieldsmetadata: Specified as "string key-value pairs" to prevent nested objectsallowed-tools: Described as "space-delimited" and marked as "experimental" to match specmintlify-docs: Avoids naming collisions as suggested in reviewReview Comments Addressed
✅ Comment 1: Changed "Custom skill.md files can start with YAML frontmatter" to "Custom skill.md files must start with YAML frontmatter"
✅ Comment 2: Updated metadata description to "Additional metadata as string key-value pairs"
✅ Comment 3: Updated allowed-tools description to "Space-delimited list of pre-approved tools the skill may use (experimental)"
✅ Comment 4: Used
mintlify-docsinstead ofmintlifyin example to avoid collisionsTest Plan
mint devvaleto check style complianceThis PR supersedes #2847 with all review feedback addressed.
Note
Adds concise guidance for creating custom
skill.mdfiles and tidies callout formatting.ai/skillmd.mdxwith a table of supported keys and an example YAML blockTipandNotecalloutsskill.mdfrontmatternamefrommintlify-docstomintlifyWritten by Cursor Bugbot for commit d69b539. This will update automatically on new commits. Configure here.