Schema overview

This tab is the formal reference for gaal.yaml. For prose explanations and design rationale, see Concepts → The gaal.yaml file. For working examples, see the Configure section.

Top-level keys

Key	Type	Required	Page
`schema`	integer	recommended	Schema version
`repositories`	map	no	Repositories
`skills`	array	no	Skills
`content`	array	no	Content
`mcps`	array	no	MCPs
`tools`	array	no	Tools
`hooks`	object	no	Hooks
`telemetry`	bool	no	Telemetry

Generating the JSON Schema

gaal schema writes the canonical JSON Schema (draft 2020-12) for gaal.yaml:

gaal schema -f schema.json

Drop the file into your editor’s JSON-Schema mappings to get inline validation and auto-completion as you type. See gaal schema for IDE setup.

Validation

Two ways to validate a gaal.yaml:

# In gaal itself
gaal doctor

# Against the schema with any JSON-Schema validator
gaal schema -f schema.json
ajv validate -s schema.json -d gaal.yaml

Stability

The schema field is stable forever. gaal reads schema: 1 files now and will continue to read them. When breaking changes happen they will use schema: 2 with a documented migration path, older files will keep working.

​Top-level keys

​Generating the JSON Schema

​Validation

​Stability

​Related

The gaal.yaml file

gaal schema

gaal doctor

Top-level keys

Generating the JSON Schema

Validation

Stability

Related