Netlify now publishes a JSON schema for netlify.toml, so you can catch configuration errors in your editor instead of in a failed deploy. The schema describes the supported properties, the values they accept, and what they do, shortening the feedback loop for discovering and fixing mistakes.

To use it, add a $schema key at the top of your netlify.toml:

"$schema" = "https://open-api.netlify.com/netlify.schema.json"

[build]
  command = "npm run build"
  publish = "dist"

If you write code yourself, editors that support JSON schemas for TOML files can suggest properties as you type, show their descriptions inline, and flag invalid values as you work. In VS Code, install the Even Better TOML extension to turn on schema support for TOML files. You no longer need to keep the docs open in another tab or learn about a typo from your build log.

If an agent writes code for you, the same schema gives it a machine-readable contract for the file. Agents can check the configuration they generate against the schema and fix invalid properties or values before anything is deployed, instead of deploying, reading the failure, and trying again. That means fewer broken deploys for you to review and a faster path from a generated netlify.toml to one that works.

Netlify ignores the $schema key when it builds and deploys your project. Some checks, such as whether a configured directory exists, can only happen during the build, so a file that passes the schema can still fail to build.

Learn more about schema validation for netlify.toml.