Skip to content

ADL v1

adl.inference-gateway.com/v1 is the current stable major version of the Agent Definition Language. A manifest opts in by setting:

yaml
apiVersion: adl.inference-gateway.com/v1
kind: Agent

The schema is JSON Schema Draft-07 and lives in the repository at schema/v1/schema.json. Its $id is https://adl.inference-gateway.com/schemas/agent/v1.

What's in v1

SectionPurpose
metadataName, description, version, license, tags
spec.capabilitiesStreaming, push notifications, state transition history
spec.cardAgent card surfaced to clients
spec.agentProvider, model, system prompt
spec.configRuntime configuration knobs
spec.servicesExternal services the agent talks to
spec.toolsFunction-call entrypoints (deterministic operations)
spec.skillsMarkdown playbooks discoverable at runtime (metadata at startup, body lazy-loaded)
spec.serverHTTP server settings
spec.languageTarget language (Go, Rust, TypeScript) and deps
spec.artifactsFiles emitted alongside the agent
spec.hooksLifecycle hooks
spec.scmSource-control metadata
spec.developmentSandbox (flox / devcontainer / dockerCompose) and AI tooling
spec.deploymentKubernetes / Cloud Run deployment manifests

See the full field-by-field Schema Reference.

Pinning v1 in downstream tools

Pin to a specific git tag inside v1.x.y rather than tracking main. The schema file at any released tag is immutable, so a pin is a stable contract.

yaml
vars:
  ADL_SCHEMA_REF: v1.3.0
  ADL_SCHEMA_URL: https://raw.githubusercontent.com/inference-gateway/adl/{{.ADL_SCHEMA_REF}}/schema/v1/schema.json

New optional fields land as minor bumps inside v1; breaking changes wait for v2. See Versioning for the additive contract and the rules that govern what can change inside a major version.

Resources