Skill Readme Linter

Description

XSpoonAi 0c0e58f 3 files · 10.2 KB Updated

File contents

Description

Lint SKILL.md and README.md files for required sections. Validates documentation completeness and compliance with standards.

Inputs

{
  "skill_path": "Path to skill directory"
}

Outputs

{
  "ok": true,
  "data": {
    "valid": true,
    "issues": [],
    "warnings": []
  }
}

Usage

Demo Mode

python scripts/main.py --demo

Lint Skill Docs

echo '{"skill_path":"./my-skill"}' | python3 scripts/main.py

Examples

Example 1: Check Documentation

$ echo '{"skill_path":"dao-proposal-starter"}' | python3 scripts/main.py
{
  "ok": true,
  "data": {
    "valid": true,
    "issues": [],
    "warnings": ["Missing example in SKILL.md"]
  }
}

Error Handling

When an error occurs, the skill returns:

{
  "ok": false,
  "error": "Error description",
  "details": {
    "skill_path": "Directory not found"
  }
}

XSpoonAi/spoon-awesome-skill/tree/main/platform-challenge/skill-readme-linter commit 0c0e58fefd

Frequently asked questions

npx skillmds@latest add xspoonai/skill-readme-linter