# Skill Readme Linter

> Description

- Skill: `xspoonai/skill-readme-linter` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add xspoonai/skill-readme-linter`
- Raw SKILL.md: https://api.skillmd.com/api/skills/xspoonai/skill-readme-linter/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: XSpoonAi (https://skillmd.com/u/xspoonai)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/xspoonai/skill-readme-linter

---


## Description

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

## Inputs

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

## Outputs

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

## Usage

### Demo Mode
```bash
python scripts/main.py --demo
```

### Lint Skill Docs
```bash
echo '{"skill_path":"./my-skill"}' | python3 scripts/main.py
```

## Examples

### Example 1: Check Documentation
```bash
$ 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:

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