Next Gen UI Agent A2A Server Configuration (SchemaStore) JSON Schema

Type	object
File match	`ngui-a2a_.yaml` `ngui-a2a_.yml` `ngui-a2a_*.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/next-gen-ui-agent-a2a-server-configuration/latest.json
Source	https://raw.githubusercontent.com/RedHat-UX/next-gen-ui-agent/refs/heads/main/spec/a2a/a2a_agent_config.schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

A2A Agent Configuration.

Properties

component_system string | null

Component system to use to render the UI component. Default is json. UI renderers have to be installed to use other systems.

Default: "json"

Transformer used to parse the input data (can be overriden on 'data type' level). Default json, available transformers: yaml, csv-comma, csv-semicolon, csv-tab. Other transformers can be installed, see docs.

Default: "json"

List of components that can be selected by the agent's LLM for data visualization. If not set, all components are selectable.

Default: null

component_selection_strategy string | null

Strategy for LLM powered component selection and configuration step. Possible values: one_llm_call (default) - uses one LLM call, two_llm_calls - use two LLM calls - experimental!

Default: "one_llm_call"

data_types object | null

Mapping from InputData.type to UI component - currently only one dynamic component with pre-configuration, or hand-build component (aka HBC) can be defined here. Will be extended in the future.

Default: null

input_data_json_wrapping boolean | null

If True (default), the agent will wrap the JSON input data into data type field if necessary due to its structure. If False, the agent will never wrap the JSON input data into data type field.

Default: true

generate_all_fields boolean

If True, the agent will generate all possible view Fields for the UI component into its output configuration UIBlockComponentMetadata.fields_all, if False then all fields aren't generated. Can be overriden for individual data_types. Supported only for table and set-of-cards components.

Default: false

prompt AgentConfigPrompt | null

Prompt-related configuration for LLM interactions. Allows customizing component descriptions, rules, and examples used in agent prompts.

Default: null

enable_input_data_type_detection boolean

If True (default), the agent will attempt to auto-detect the appropriate input data transformer based on data structure when no transformer is explicitly configured for a data type. If False, auto-detection is disabled and the default transformer is always used.

Default: true

a2a A2AConfig | null

A2A related configuration.

Default: null

Definitions

A2AAgentCardInfo object

Information to override default values in the A2A Agent card.

name string | null

Name of the A2A Agent.

Default: null

description string | null

Description of the A2A Agent.

Default: null

url string | null

URL of the A2A Agent. Use if you want to override the real URL of the A2A Agent, eg. when running behind a proxy or load balancer.

Default: null

A2AAgentSkill object

Information to override default values in the A2A Agent skill.

name string | null

Name of the A2A Agent skill.

Default: null

description string | null

Description of the A2A Agent skill.

Default: null

tags string[] | null

Tags of the A2A Agent skill.

Default: null

examples string[] | null

Examples of the A2A Agent skill.

Default: null

A2AAgentSkills object

Skills info to override default values in the A2A Agent card.

generate_ui_components A2AAgentSkill | null

generate_ui_components skill info to override default values in the A2A Agent card.

Default: null

A2AConfig object

agent_card A2AAgentCardInfo | null

Information to override default values in the A2A Agent card.

Default: null

skills A2AAgentSkills | null

Skills info to override default values in the A2A Agent card.

Default: null

AgentConfigComponent object

Agent Configuration - one component config for data type.

component string required

Component name. Can be name of existing dynamic component supported by the UI Agent, or name for hand-build component.

configuration AgentConfigDynamicComponentConfiguration | null

Optional pre-configuration of the dynamic component to be used.

Default: null

llm_configure boolean | null

If True, LLM generates configuration. If False, pre-defined configuration must be provided and will be used. Only applicable to dynamic components, not hand-build components.

Default: true

prompt AgentConfigPromptComponent | null

Optional prompt customization for this component. Overrides global prompt.components configuration for this component in this data_type context. Has the same fields as prompt.components. For HBCs in multi-component scenarios, at least 'description' field is required.

Default: null

AgentConfigDataType object

Agent Configuration for the Data Type.

Transformer to use to transform the input data of this type. Available transformers: json, yaml, csv-comma, csv-semicolon, csv-tab. Other transformers can be installed, see docs.

Default: null

generate_all_fields boolean | null

If True, the agent will generate all possible view Fields for the UI component into its output configuration UIBlockComponentMetadata.fields_all, if False then all fields aren't generated, if None then agent's default setting is used. Supported only for table and set-of-cards components.

Default: null

components AgentConfigComponent[] | null

List of components to select from for the input data of this type.

Default: null

prompt AgentConfigPromptBase | null

Optional prompt configuration for this data type. Overrides global prompt settings from AgentConfig.prompt. All fields from AgentConfigPromptBase are available (system prompts, examples, chart instructions). Takes precedence over global configuration.

Default: null

AgentConfigDynamicComponentConfiguration object

Agent Configuration - pre-configuration of the one dynamic component for data type.

title string required

Title of the dynamic component to be shown in the UI

fields DataField[] required

Fields of the dynamic component to be shown in the UI

AgentConfigPrompt object

Global prompt configuration for LLM interactions.

Inherits all base prompt fields and adds component-specific metadata overrides.

system_prompt_start string | null

Override the initial system prompt section for one-step strategy. Available components list and other dynamically generated parts are added after this section. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step1select_system_prompt_start string | null

Override the initial system prompt section for two-step strategy step1 (component selection). Available components list and other dynamically generated parts are added after this section. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step2configure_system_prompt_start string | null

Override the initial system prompt section for two-step strategy step2 (field configuration). MUST contain {component} placeholder which is replaced with the selected component name from step1. Other dynamically generated component parts are added after this section. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

chart_instructions_template string | null

Override the chart instructions template used in both strategies. Supports placeholders: {charts_description}, {charts_fields_spec}, {charts_rules}, {charts_inline_examples} which will be replaced with dynamically generated component-specific content. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

examples_normalcomponents string | null

Override normal component examples (table, cards, image) for one-step strategy. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

examples_charts string | null

Override chart component examples for one-step strategy. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step1select_examples_normalcomponents string | null

Override normal component examples (table, cards, image) for two-step strategy step1. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step1select_examples_charts string | null

Override chart component examples for two-step strategy step1. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

components object | null

Component related prompt overrides. Keys are component names (e.g., 'table', 'chart-bar'), values are objects with prompt overrides for that component. Component names must match those in CONFIG_OPTIONS_ALL_COMPONETS.

Default: null

AgentConfigPromptBase object

Base prompt configuration (all prompt fields except components).

Used for data-type level prompt customization. Contains all prompt-related fields that can override global settings on a per-data-type basis.

system_prompt_start string | null

Default: null

twostep_step1select_system_prompt_start string | null

Default: null

twostep_step2configure_system_prompt_start string | null

Default: null

chart_instructions_template string | null

Default: null

examples_normalcomponents string | null

Override normal component examples (table, cards, image) for one-step strategy. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

examples_charts string | null

Override chart component examples for one-step strategy. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step1select_examples_normalcomponents string | null

Override normal component examples (table, cards, image) for two-step strategy step1. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

twostep_step1select_examples_charts string | null

Override chart component examples for two-step strategy step1. Precedence order is 'per data_type' > 'global' > 'hardcoded default'.

Default: null

AgentConfigPromptComponent object

Component metadata overrides for LLM prompts.

Allows overriding any field from COMPONENT_METADATA for a specific component. Available fields depend on component type:

All components: description, twostep_step2configure_example, twostep_step2configure_rules
Chart components: chart_description, chart_fields_spec, chart_rules, chart_inline_examples

description string | null

Override component description used in LLM prompts

Default: null

twostep_step2configure_example string | null

Override example for two-step strategy field selection (step2configure)

Default: null

twostep_step2configure_rules string | null

Override rules for two-step strategy field selection (step2configure)

Default: null

chart_description string | null

Override chart type description (chart components only)

Default: null

chart_fields_spec string | null

Override chart fields specification (chart components only)

Default: null

chart_rules string | null

Override chart-specific rules (chart components only)

Default: null

chart_inline_examples string | null

Override inline chart examples (chart components only)

Default: null

DataField object

UI Component Field Metadata.

id string required

Unique field ID. Can be used in CSS selectors to target the field, eg. to set its style, or during live refresh of the shown data from the backend.

name string required

Field name to be shown in the UI

data_path string required

JSON Path pointing to the input data structure (after input data transformation and JSON wrapping, if applied). It is used to pickup values to be shown in the UI.