skill

Documentation

Overview

Package skill loads and validates Prism Agent Skills from SKILL.md files.

Index

• func LoadMany(skillsRoot string, names []string) (map[string]*Skill, error)
• func ValidateStructure(dir string) error
• type Skill
  • func DiscoverAll(skillsRoot string) ([]*Skill, error)
  • func LoadDir(skillsRoot, name string) (*Skill, error)
  • func ParseFile(skillMDPath string) (*Skill, error)
  • func (s *Skill) CollectScriptPath() string
  • func (s *Skill) FullText() string
  • func (s *Skill) MetadataSummary() string
  • func (s *Skill) ReferenceContent() (string, error)

Functions

func LoadMany

func LoadMany(skillsRoot string, names []string) (map[string]*Skill, error)

LoadMany loads all named skills from skillsRoot and returns a map keyed by skill name. All errors are collected so callers see every missing skill at once.

func ValidateStructure

func ValidateStructure(dir string) error

ValidateStructure ensures a skill directory has SKILL.md, references/, and scripts/.

Types

type Skill

type Skill struct {
	// Required frontmatter fields per agentskills.io spec.
	Name        string `yaml:"name"`
	Description string `yaml:"description"`

	// Optional frontmatter fields Prism honours when present.
	Compatibility string            `yaml:"compatibility"`
	Metadata      map[string]string `yaml:"metadata"`

	// Body is the Markdown body of SKILL.md after the frontmatter block.
	Body string `yaml:"-"`
	// Dir is the skill directory path (useful for loading references/scripts).
	Dir string `yaml:"-"`
}

Skill holds the parsed SKILL.md frontmatter and body for one Agent Skill.

func DiscoverAll

func DiscoverAll(skillsRoot string) ([]*Skill, error)

DiscoverAll loads every skill subdirectory under skillsRoot. Structure and frontmatter validation errors are aggregated.

func LoadDir

func LoadDir(skillsRoot, name string) (*Skill, error)

LoadDir resolves a skill by name from the skills root directory. It expects skills/<name>/SKILL.md to exist.

func ParseFile

func ParseFile(skillMDPath string) (*Skill, error)

ParseFile reads a SKILL.md file and returns a Skill.

func (*Skill) CollectScriptPath

func (s *Skill) CollectScriptPath() string

CollectScriptPath returns the expected path to scripts/collect.sh. It does not guarantee the file exists.

func (*Skill) FullText

func (s *Skill) FullText() string

FullText returns the skill content formatted for prompt injection. It includes a Markdown heading, the description, optional compatibility note, and the full skill body.

func (*Skill) MetadataSummary

func (s *Skill) MetadataSummary() string

MetadataSummary returns a one-line summary for the skills index section ("progressive disclosure metadata phase").

func (*Skill) ReferenceContent

func (s *Skill) ReferenceContent() (string, error)

ReferenceContent reads references/REFERENCE.md for the skill if present. Returns an empty string without error when the file does not exist.