Read Properties • AI Agent SDK

read_properties: Read skill properties from SKILL.md frontmatter.

read_properties

Function

</div>

This function is defined in the parser module.

Read skill properties from SKILL.md frontmatter.

This function parses the frontmatter and returns properties. It does NOT perform full validation. Use validate() for that.

Signature

python
def read_properties(skill_dir: Path) -> SkillProperties

Parameters

ParamField Path

Path to the skill directory

Returns

ResponseField SkillProperties

SkillProperties with parsed metadata

Exceptions

ParseError

If SKILL.md is missing or has invalid YAML

ValidationError

If required fields (name, description) are missing

Uses

  • Path
  • find_skill_md
  • ParseError
  • skill_md.read_text
  • parse_frontmatter
  • ValidationError
  • SkillProperties
  • SkillRequirements.from_frontmatter
  • SkillAutomation.from_metadata

Used By

Source

View on GitHub

praisonaiagents/skills/parser.py at line 92