Conjure.Frontmatter (Conjure v0.1.1-alpha)

View Source

Parsed YAML frontmatter from SKILL.md files.

The frontmatter contains structured metadata about a skill per the Agent Skills specification (https://agentskills.io/specification).

Required Fields

  • name - Max 64 chars, lowercase letters/numbers/hyphens
  • description - Max 1024 chars, what the skill does and when to use it

Optional Fields

  • license - License name or filename
  • compatibility - Max 500 chars, environment requirements
  • allowed_tools - List of pre-approved tools (experimental)
  • metadata - Additional key-value properties

Example

---
name: pdf
description: |
  Comprehensive PDF manipulation toolkit for extracting text and tables,
  creating new PDFs, merging/splitting documents, and handling forms.
license: MIT
compatibility: python3, poppler-utils
allowed-tools: Bash(pdftotext:*) Read
---

Summary

Types

t()

Functions

from_map(map)

Creates a Frontmatter struct from a parsed YAML map.

Types

t()

@type t() :: %Conjure.Frontmatter{
  allowed_tools: String.t() | nil,
  compatibility: String.t() | nil,
  description: String.t(),
  license: String.t() | nil,
  metadata: map(),
  name: String.t()
}

Functions

from_map(map)

@spec from_map(map()) :: {:ok, t()} | {:error, term()}

Creates a Frontmatter struct from a parsed YAML map.

Returns {:ok, frontmatter} on success, or {:error, reason} if required fields are missing or validation fails.