Fix autoentity validation & CLI/Schema mismatch bugs by RubenCerna2079 · Pull Request #3416 · Azure/data-api-builder

RubenCerna2079 · 2026-04-06T18:48:08Z

Why make this change?

[Bug]: Invalid CLI dab auto-config --template.mcp.dml-tool #3375
- The CLI and the schema have a mismatch in the autoentities.<def-name>.template.mcp.dml-tools, need to ensure that they are the same.
[Bug]: autoentities and dab validate #3335
- Using dab validate produces the wrong output message.

What is this change?

For issue #3375:

We changed the AutoConfigOption.cs file so that it uses the proper name and changed the name of the variable to also match the schema in the ConfigGenerator.cs.

For issue #3335:

We changed the log message in MsSqlMetadataProvider.cs so that it is easier for the user to understand the error.
We also added a try-catch to the validation logic in the ConfigGenerator.cs so that instead of outputing an exception when dab throws an error it just logs the exception.

How was this tested?

Integration Tests
Unit Tests
Local Testing
The issues were related to mismatches or to the output of log messages that can only be tested locally.

Sample Request(s)

dab auto-config --template.mcp.dml-tools true/false
dab validate --config test.json

Copilot

Pull request overview

This PR addresses two CLI/autoentities bugs in Data API builder: aligning the dab auto-config option naming with the JSON schema and improving dab validate behavior/error messaging when autoentity generation fails due to conflicts.

Changes:

Renames the CLI option from template.mcp.dml-tool to template.mcp.dml-tools to match the schema and updates related wiring in config generation.
Updates the autoentity/entity name conflict message in the MSSQL metadata provider to be more actionable.
Wraps CLI validation in try/catch to avoid unhandled exceptions and log errors instead.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
src/Core/Services/MetadataProviders/MsSqlMetadataProvider.cs	Updates conflict exception text for autoentity generation.
src/Cli/ConfigGenerator.cs	Adds exception handling to `IsConfigValid` and renames template MCP dml-tools option usage.
src/Cli/Commands/AutoConfigOptions.cs	Renames the CLI option to `template.mcp.dml-tools` and updates the corresponding property.

Copilot · 2026-04-06T18:52:30Z

src/Core/Services/MetadataProviders/MsSqlMetadataProvider.cs

                    {
                        throw new DataApiBuilderException(
-                            message: $"Entity with name '{entityName}' already exists. Cannot create new entity from autoentities definition '{autoentityName}'.",
+                            message: $"Entity '{entityName}' conflicts with autoentity pattern '{autoentityName}'. Use --patterns.exclude to skip it.",


This exception message comes from the runtime metadata provider (not just the CLI) but it points users to the CLI switch --patterns.exclude. Consider rewording to reference the config path (e.g., autoentities.<definition>.patterns.exclude) or mention both, so the guidance is actionable when the service is started from an existing config file.

Suggested change

message: $"Entity '{entityName}' conflicts with autoentity pattern '{autoentityName}'. Use --patterns.exclude to skip it.",

message: $"Entity '{entityName}' conflicts with autoentity pattern '{autoentityName}'. Exclude it in config at autoentities.{autoentityName}.patterns.exclude or use the CLI switch --patterns.exclude.",

Copilot · 2026-04-06T18:52:31Z

src/Cli/ConfigGenerator.cs

            }
+            catch (AggregateException ex)
+            {
+                foreach (Exception exception in ex.InnerExceptions)


The catch for AggregateException iterates ex.InnerExceptions directly, which can miss nested exceptions (AggregateExceptions can be nested). Consider using ex.Flatten().InnerExceptions so all underlying validation errors get logged.

Suggested change

foreach (Exception exception in ex.InnerExceptions)

foreach (Exception exception in ex.Flatten().InnerExceptions)

Copilot · 2026-04-06T18:52:31Z

src/Cli/ConfigGenerator.cs

+            bool isValid = false;
+            try
            {
-                if (runtimeConfigProvider.TryGetConfig(out RuntimeConfig? config) && config is not null)
+                isValid = runtimeConfigValidator.TryValidateConfig(runtimeConfigFile, LoggerFactoryForCli).Result;
+
+                // Additional validation: warn if fields are missing and MCP is enabled
+                if (isValid)
                {
-                    bool mcpEnabled = config.IsMcpEnabled;
-                    if (mcpEnabled)
+                    if (runtimeConfigProvider.TryGetConfig(out RuntimeConfig? config) && config is not null)
                    {
-                        foreach (KeyValuePair<string, Entity> entity in config.Entities)
+                        bool mcpEnabled = config.IsMcpEnabled;
+                        if (mcpEnabled)
                        {
-                            if (entity.Value.Fields == null || !entity.Value.Fields.Any())
+                            foreach (KeyValuePair<string, Entity> entity in config.Entities)
                            {
-                                _logger.LogWarning($"Entity '{entity.Key}' is missing 'fields' definition while MCP is enabled. " +
-                                    "It's recommended to define fields explicitly to ensure optimal performance with MCP.");
+                                if (entity.Value.Fields == null || !entity.Value.Fields.Any())
+                                {
+                                    _logger.LogWarning($"Entity '{entity.Key}' is missing 'fields' definition while MCP is enabled. " +
+                                        "It's recommended to define fields explicitly to ensure optimal performance with MCP.");
+                                }
                            }
                        }
-                    }

-                    // Warn if Unauthenticated provider is used with authenticated or custom roles
-                    if (config.Runtime?.Host?.Authentication?.IsUnauthenticatedAuthenticationProvider() == true)
-                    {
-                        bool hasNonAnonymousRoles = config.Entities
-                            .Where(e => e.Value.Permissions is not null)
-                            .SelectMany(e => e.Value.Permissions!)
-                            .Any(p => !p.Role.Equals("anonymous", StringComparison.OrdinalIgnoreCase));
-
-                        if (hasNonAnonymousRoles)
+                        // Warn if Unauthenticated provider is used with authenticated or custom roles
+                        if (config.Runtime?.Host?.Authentication?.IsUnauthenticatedAuthenticationProvider() == true)
                        {
-                            _logger.LogWarning(
-                                "Authentication provider is 'Unauthenticated' but some entities have permissions configured for non-anonymous roles. " +
-                                "All requests will be treated as anonymous.");
+                            bool hasNonAnonymousRoles = config.Entities
+                                .Where(e => e.Value.Permissions is not null)
+                                .SelectMany(e => e.Value.Permissions!)
+                                .Any(p => !p.Role.Equals("anonymous", StringComparison.OrdinalIgnoreCase));
+
+                            if (hasNonAnonymousRoles)
+                            {
+                                _logger.LogWarning(
+                                    "Authentication provider is 'Unauthenticated' but some entities have permissions configured for non-anonymous roles. " +
+                                    "All requests will be treated as anonymous.");
+                            }
                        }
                    }
                }
+
+                return isValid;
            }
+            catch (AggregateException ex)
+            {
+                foreach (Exception exception in ex.InnerExceptions)
+                {
+                    _logger.LogError(exception, exception.Message);
+                }

-            return isValid;
+                return isValid;
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, ex.Message);
+                return isValid;
+            }


IsConfigValid now has new behavior for validation failures coming from the engine (catching/logging AggregateException instead of crashing). There are existing ValidateConfigTests for ConfigGenerator.IsConfigValid, but none cover the autoentity/entity name conflict scenario from #3335. Adding a regression test that asserts IsConfigValid returns false and prints the friendly conflict message would prevent reintroducing the unhandled-exception behavior.

Copilot · 2026-04-06T18:52:31Z

src/Cli/Commands/AutoConfigOptions.cs

+        [Option("template.mcp.dml-tools", Required = false, HelpText = "Enable/disable DML tools for generated entities. Allowed values: true, false. Default: true")]
+        public string? TemplateMcpDmlTools { get; }


Changing the CLI option name from template.mcp.dml-tool to template.mcp.dml-tools fixes the schema mismatch, but it’s also a breaking CLI change for anyone using the old flag. Consider accepting both as aliases (and potentially marking the old one hidden/deprecated) to avoid silently breaking existing scripts.

Copilot · 2026-04-06T18:52:31Z

src/Cli/Commands/AutoConfigOptions.cs

        public AutoConfigOptions(
            string definitionName,
            IEnumerable<string>? patternsInclude = null,
            IEnumerable<string>? patternsExclude = null,
            string? patternsName = null,
            string? templateMcpDmlTool = null,
            bool? templateRestEnabled = null,
            bool? templateGraphqlEnabled = null,
            bool? templateCacheEnabled = null,
            int? templateCacheTtlSeconds = null,
            string? templateCacheLevel = null,
            bool? templateHealthEnabled = null,
            IEnumerable<string>? permissions = null,
            string? config = null)
            : base(config)
        {
            DefinitionName = definitionName;
            PatternsInclude = patternsInclude;
            PatternsExclude = patternsExclude;
            PatternsName = patternsName;
-            TemplateMcpDmlTool = templateMcpDmlTool;
+            TemplateMcpDmlTools = templateMcpDmlTool;
            TemplateRestEnabled = templateRestEnabled;


In the constructor assignment TemplateMcpDmlTools = templateMcpDmlTool;, the parameter name remains singular (templateMcpDmlTool) while the option/property are now plural (dml-tools). Renaming the parameter (and any call sites) to templateMcpDmlTools would reduce confusion and keep naming consistent.

souvikghosh04

Added some comments

souvikghosh04 · 2026-04-07T06:39:32Z

src/Cli/Commands/AutoConfigOptions.cs

-        [Option("template.mcp.dml-tool", Required = false, HelpText = "Enable/disable DML tools for generated entities. Allowed values: true, false. Default: true")]
-        public string? TemplateMcpDmlTool { get; }
+        [Option("template.mcp.dml-tools", Required = false, HelpText = "Enable/disable DML tools for generated entities. Allowed values: true, false. Default: true")]
+        public string? TemplateMcpDmlTools { get; }


do we have test coverage for this and the below changes?

souvikghosh04 · 2026-04-07T06:46:34Z

src/Cli/ConfigGenerator.cs

                    {
-                        foreach (KeyValuePair<string, Entity> entity in config.Entities)
+                        bool mcpEnabled = config.IsMcpEnabled;
+                        if (mcpEnabled)


nit: just use config.IsMcpEnabled instead of a new variable

souvikghosh04 · 2026-04-07T16:19:01Z

src/Cli/ConfigGenerator.cs

+            {
+                foreach (Exception exception in ex.InnerExceptions)
+                {
+                    _logger.LogError(exception, exception.Message);


you might not need to pass the exception object. just the message as its done in other places.

souvikghosh04 · 2026-04-07T16:19:16Z

src/Cli/ConfigGenerator.cs

+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, ex.Message);


RubenCerna2079 added 2 commits April 6, 2026 10:41

Fix CLI/Schema mismatch bug

22f7acb

Fix autoentities validation bug

ff187b0

Copilot AI review requested due to automatic review settings April 6, 2026 18:48

RubenCerna2079 requested review from Alekhya-Polavarapu, Aniruddh25, JerryNixon, aaronburtle, anushakolan, rusamant, sourabh1007, souvikghosh04, stuartpa and vadeveka as code owners April 6, 2026 18:48

RubenCerna2079 added the 2.0 label Apr 6, 2026

RubenCerna2079 added this to Data API builder Apr 6, 2026

github-project-automation bot moved this to Todo in Data API builder Apr 6, 2026

RubenCerna2079 added this to the April 2026 milestone Apr 6, 2026

This was linked to issues Apr 6, 2026

[Bug]: autoentities and dab validate #3335

Open

[Bug]: Invalid CLI dab auto-config --template.mcp.dml-tool #3375

Open

RubenCerna2079 moved this from Todo to Review In Progress in Data API builder Apr 6, 2026

RubenCerna2079 self-assigned this Apr 6, 2026

Copilot started reviewing on behalf of RubenCerna2079 April 6, 2026 18:49 View session

RubenCerna2079 assigned Aniruddh25 and souvikghosh04 Apr 6, 2026

Copilot AI reviewed Apr 6, 2026

View reviewed changes

RubenCerna2079 changed the title ~~Dev/rubencerna/fix autoentities bugs~~ Fix autoentity bugs Apr 6, 2026

RubenCerna2079 changed the title ~~Fix autoentity bugs~~ Fix autoentity validation & CLI/Schema mismatch bugs Apr 6, 2026

souvikghosh04 requested changes Apr 7, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix autoentity validation & CLI/Schema mismatch bugs#3416

Fix autoentity validation & CLI/Schema mismatch bugs#3416
RubenCerna2079 wants to merge 2 commits intomainfrom
dev/rubencerna/fix-autoentities-bugs

RubenCerna2079 commented Apr 6, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 6, 2026

Uh oh!

Copilot AI Apr 6, 2026

Uh oh!

Copilot AI Apr 6, 2026

Uh oh!

Copilot AI Apr 6, 2026

Uh oh!

Copilot AI Apr 6, 2026

Uh oh!

souvikghosh04 left a comment

Uh oh!

souvikghosh04 Apr 7, 2026

Uh oh!

souvikghosh04 Apr 7, 2026

Uh oh!

souvikghosh04 Apr 7, 2026

Uh oh!

souvikghosh04 Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	message: $"Entity '{entityName}' conflicts with autoentity pattern '{autoentityName}'. Use --patterns.exclude to skip it.",
	message: $"Entity '{entityName}' conflicts with autoentity pattern '{autoentityName}'. Exclude it in config at autoentities.{autoentityName}.patterns.exclude or use the CLI switch --patterns.exclude.",

	foreach (Exception exception in ex.InnerExceptions)
	foreach (Exception exception in ex.Flatten().InnerExceptions)

		[Option("template.mcp.dml-tools", Required = false, HelpText = "Enable/disable DML tools for generated entities. Allowed values: true, false. Default: true")]
		public string? TemplateMcpDmlTools { get; }

Conversation

RubenCerna2079 commented Apr 6, 2026

Why make this change?

What is this change?

How was this tested?

Sample Request(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

souvikghosh04 left a comment

Choose a reason for hiding this comment

Uh oh!

souvikghosh04 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

souvikghosh04 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

souvikghosh04 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

souvikghosh04 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants