1.1 KiB
1.1 KiB
name, description, allowed-tools
| name | description | allowed-tools | |||
|---|---|---|---|---|---|
| validate-md | Validates markdown files with YAML frontmatter against JSON Schema definitions. |
|
Validating Markdown Files
Instructions
-
Run validation script for the target directory containing a
schema.yamlfile:python validate-md.py <directory> -
Review results:
- Success:
✓ OK: filename.md is valid - Errors: Shows validation error, field path, and file location
- Success:
Examples
Example 1: Validate contacts directory
python validate-md.py crm/contacts
Output:
✓ OK: smith-john.md is valid
✓ OK: doe-jane.md is valid
✓ SUCCESS: All 2 files are valid!
Example 2: Validation error - missing required field
python validate-md.py crm/opportunities
Output:
❌ deal-2024-q1.md validation error: 'stage' is a required property
In file: crm/opportunities/deal-2024-q1.md
Fix: Add stage: qualified to the frontmatter.
Scripts
validate-md.pythe python validation script
Required Python Packages
- pyyaml - for parsing YAML frontmatter
- jsonschema - for validating against JSON Schema