tools-only Agent Configuration Spec
UI Agent Configuration JSON Schema is available here.
It can be used to validate agent configuration YAML files.
To use yaml configuration file auto completion or validation in your favorite IDE/editor, you can configure it, see next chapters.
Multiple IDEs - from JSON Schema Store
The schema is published in JSON Schema Store and its JSON API catalog.
It is bound to ngui_*.yaml, ngui_*.yml and ngui_*.json file patterns. So it is automatically used in supporting IDEs/editors
regarding their default configuration.
VS Code or Cursor
You need extension with YAML language support, eg. Red Hat provided YAML extension.
For this extension, JSON Schema Store is used by default, so the schema is immediatelly available.
It is bound to that file patterns, or can be autodetected/selected for other files.
You can also configure binding to other filenames by adding next section to your settings.json (it
can be accessed using menu File > Preferences > Settings > Extensions > YAML > Schemas):
"yaml.schemas": {
"https://raw.githubusercontent.com/RedHat-UX/next-gen-ui-agent/refs/heads/main/spec/config/agent_config.schema.json": ["ui_agent_config.yaml"]
},