OpenParable
Skip to content
← Back to skills

YAML Validator

Testing & Quality
yaml-validator

YAML Validator is an Agent Skill for testing & quality published in the yifanfeng97/Hyper-Extract repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Validate Hyper-Extract YAML templates for syntax and structure errors. Use when user says: "validate template", "check YAML", "fix errors", "validate syntax". Trigger: User wants to verify their YAML configuration is correct. Skip: User wants to design a new template (use record-designer or graph-designer instead).

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/yifanfeng97/Hyper-Extract/blob/HEAD/hyperextract-skills/yaml-validator/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/yaml-validator, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

YAML Validator

Validation Workflow

  1. Syntax check: YAML is valid
  2. Required fields: All required fields present
  3. Type check: Valid AutoType value
  4. Identifiers check: Proper configuration for type
  5. Field validation: Types and descriptions present

Quick Validation Checklist

All Types

- [ ] language: zh/en
- [ ] name: PascalCase
- [ ] type: valid AutoType
- [ ] tags: lowercase array
- [ ] description: non-empty
- [ ] output: exists
- [ ] guideline: exists

Graph Types

- [ ] output.entities: exists
- [ ] output.relations: exists
- [ ] identifiers.entity_id: exists
- [ ] identifiers.relation_id: exists
- [ ] identifiers.relation_members: configured

Hypergraph

- [ ] relation_members is string OR list
- [ ] If list: all fields are type: list

Temporal/Spatial

- [ ] identifiers.time_field: configured (temporal)
- [ ] identifiers.location_field: configured (spatial)

Validation Levels

LevelMeaningAction
ERRORMust fixWon't work without fix
WARNINGShould fixMay affect quality
INFOReferenceRecommended to follow

Reference Files

Important: Check these files only when needed during validation process.

TopicWhen to Check
references/rules-syntax.mdAlways (first step)
references/rules-types.mdType-specific validation
references/rules-identifiers.mdIdentifier configuration check
references/rules-errors.mdWhen errors are found

Validation Order

Recommended order: Follow this sequence for efficient validation:

  1. Syntax → rules-syntax.md - Check YAML validity first
  2. Structure → rules-types.md - Validate based on type
  3. Identifiers → rules-identifiers.md - Check identifier config
  4. Errors → rules-errors.md - Look up fixes if needed

Error Message Format

## Validation Results

### Syntax Validation
✅ PASSED

### Structure Validation
✅ PASSED
- language: ✅
- name: ✅
- type: ✅
- tags: ✅
- description: ✅
- output: ✅

### Semantic Validation
⚠️ 2 warnings
- WARNING: [message]
- WARNING: [message]

### Overall Assessment
✅ Configuration valid