Specification Data Model

Overview

Specifications for AI agents must follow a strictly defined format. This section describes the structure of all artifacts.

Section Contents

Chapter	Description
Spec File Format	Main structure of spec.yaml
Field Types	Definition of field types
Workflow	Workflow definitions
Layouts	UI layouts
Integrations	Integration definitions
JSON Schema	Specification validation
Naming Conventions	Naming rules

---

Main spec.yaml Structure

# spec.yaml - main specification file
module:
  name: string          # Module name (PascalCase)
  version: string       # Semantic versioning
  description: string   # Module description
  dependencies: list    # Dependencies

entities: dict          # Entity definitions
workflows: dict         # Workflow definitions
integrations: dict      # External integrations
ui_customizations: dict # UI customizations

---

➡️ Continue with Spec File Format.