agents.yaml PraisonAI scaffolds comes pre-wired for editor autocomplete — no setup required.
Quick Start
1
Zero-config — scaffold a new project
agents.yaml has the schema directive on line 1:2
Add it to an existing agents.yaml
Paste this one line at the top of any Your editor fetches the schema and starts suggesting fields as you type.
agents.yaml:3
Pin the schema locally
For offline or air-gapped setups, write the schema to a file:Then point the header at the local copy:
How It Works
The header is a leading YAML comment, soyaml.safe_load ignores it — runtime parsing and execution are unchanged. It’s authoring-time only.
Editor Support
Two Flavours
The published (editor) schema is intentionally a touch more permissive than the strict runtime validator, so editors never red-underline valid, executable YAML. Two intentional relaxations in the editor schema:role/goal/backstoryare optional — the runtime auto-fillsrole/goalfrom the agent key and mapsinstructions→backstory.rolesandagentsaccept either the canonical dict form or a list form (anyOf).
praisonai validate still requires the dict form and all three fields, so run validate before shipping.
Best Practices
Pin the schema locally for air-gapped setups
Pin the schema locally for air-gapped setups
Run
praisonai validate schema -o agents.schema.json and point the header at ./agents.schema.json so authoring works with no network access.Use the header and praisonai validate together
Use the header and praisonai validate together
The header catches typos while you type;
praisonai validate enforces the strict runtime rules before you run. They cover different layers — use both.Regenerate the pinned schema after upgrading
Regenerate the pinned schema after upgrading
After
pip install -U praisonai, refresh your local copy: praisonai validate schema -o agents.schema.json.Embed the schema in your own tooling (advanced)
Embed the schema in your own tooling (advanced)
Power users can import
AGENTS_SCHEMA_URL, AGENTS_SCHEMA_HEADER, and generate_agents_schema() from praisonai.config to generate or host the schema themselves.Related
Validate CLI
Fail-fast YAML validation and the
schema --agents / -o flagsYAML Configuration Reference
Complete field reference for agents.yaml and workflow.yaml