Skip to main content

JSON Schema

Agent Format definitions (.agf.yaml files) are validated against a JSON Schema that defines the complete structure, field types, required properties, and conditional validation rules for the format.

Canonical Schema URL​

The authoritative schema is published at:

https://agentformat.org/schema/1.0/agentformat-schema.json

You can also validate files interactively using the Playground.

Editor Integration​

VS Code​

Install the YAML extension and add the following to your settings.json:

{
  "yaml.schemas": {
    "https://agentformat.org/schema/1.0/agentformat-schema.json": "*.agf.yaml"
  }
}

JetBrains IDEs​

  1. Open Settings > Languages & Frameworks > Schemas and DTDs > JSON Schema Mappings.
  2. Click + to add a new mapping.
  3. Set the schema URL to https://agentformat.org/schema/1.0/agentformat-schema.json.
  4. Add a file path pattern: *.agf.yaml.

SDK-Embedded Schema​

info

SDKs for Java, Python, TypeScript, and Go will be publicly available soon.

The JSON Schema will be embedded in all four official SDKs, enabling offline validation without network access. Each SDK's validate function will use the bundled schema by default.

Full Schema Reference​

View full JSON Schema

The complete schema is available as a static file:

/schema/1.0/agentformat-schema.json