[MCP]Fixed CLI bug in fields.primary-key updation when using update entity command. (#3077)

anushakolan · web-flow · commit 64f28dc49fa1 · 2026-01-29T01:07:37.000Z
## Why make this change?
When updating an entity with a command like: `dab update Incident
--fields.name "Id" --fields.description "Unique Key"`, the existing
`primary-key` flag on Id was being changed to `false`even though no
`primary-key` option was specified.
This change removes that surprise so primary-key metadata only changes
when explicitly requested.

## What is this change?
- Adjusts the entity update logic so that:
1. If the user does not provide any fields.primary-key option, existing
primary-key flags for fields mentioned in fields.name are preserved.
2. If the user does provide fields.primary-key, those true/false values
are still applied positionally to the corresponding fields exactly as
before.

- Adds a regression test that:
1. Starts from a config where Id is already a primary key.
2. Runs an update that only changes the description for Id via
`fields.name` and `fields.description`.
3. Verifies that the description changes and the primary-key flag on Id
remains true.

## How was this tested?

- [ ] Integration Tests
- [x] Unit Tests

1. Existing CLI unit tests for entity update.
2. New regression test that validates `primary-key` is preserved when
only the field description is updated.

## Sample Request(s)

- To demonstrate the fixed behavior:

1. Initial state: Id is configured as a primary key on the entity.
2. Command: `dab update Incident --fields.name "Id" --fields.description
"Unique Key 2"`
3. Result after this change:
4. The description for Id becomes “Unique Key 2”.
5. The primary-key flag for Id stays true.


- To explicitly change primary keys (still supported):
1. Set Id as primary key:
` dab update Incident --fields.name "Id" --fields.primary-key true`

2. Clear Id as primary key:
`dab update Incident --fields.name "Id" --fields.primary-key false`
diff --git a/src/Cli.Tests/UpdateEntityTests.cs b/src/Cli.Tests/UpdateEntityTests.cs
@@ -1100,6 +1100,92 @@ public void TestUpdateEntityDescription()
             Assert.AreEqual("Updated description", updatedRuntimeConfig.Entities["MyEntity"].Description);
         }
 
+        /// <summary>
+        /// Updating a field's description should either preserve or clear
+        /// the existing primary-key flag depending on whether an explicit
+        /// --fields.primary-key value is provided.
+        /// </summary>
+        [DataTestMethod]
+        [DataRow(null, true, DisplayName = "No primary-key flag: preserve existing true")]
+        [DataRow(false, false, DisplayName = "Explicit primary-key false: clear existing true")]
+        public void TestUpdateFieldDescriptionPrimaryKeyBehavior(bool? primaryKeyFlag, bool expectedPrimaryKey)
+        {
+            string initialConfig = GetInitialConfigString() + "," + @"
+                ""entities"": {
+                    ""MyEntity"": {
+                        ""source"": ""MyTable"",
+                        ""fields"": [
+                            {
+                                ""name"": ""Id"",
+                                ""description"": ""Primary key"",
+                                ""primary-key"": true
+                            }
+                        ],
+                        ""permissions"": [
+                            {
+                                ""role"": ""anonymous"",
+                                ""actions"": [""read""]
+                            }
+                        ]
+                    }
+                }
+            }";
+
+            IEnumerable<bool>? primaryKeyFlags = primaryKeyFlag.HasValue
+                ? new[] { primaryKeyFlag.Value }
+                : null;
+
+            UpdateOptions options = new(
+                source: null,
+                permissions: null,
+                entity: "MyEntity",
+                sourceType: null,
+                sourceParameters: null,
+                sourceKeyFields: null,
+                restRoute: null,
+                graphQLType: null,
+                fieldsToInclude: null,
+                fieldsToExclude: null,
+                policyRequest: null,
+                policyDatabase: null,
+                relationship: null,
+                cardinality: null,
+                targetEntity: null,
+                linkingObject: null,
+                linkingSourceFields: null,
+                linkingTargetFields: null,
+                relationshipFields: null,
+                map: null,
+                cacheEnabled: null,
+                cacheTtl: null,
+                config: TEST_RUNTIME_CONFIG_FILE,
+                restMethodsForStoredProcedure: null,
+                graphQLOperationForStoredProcedure: null,
+                description: null,
+                parametersNameCollection: null,
+                parametersDescriptionCollection: null,
+                parametersRequiredCollection: null,
+                parametersDefaultCollection: null,
+                fieldsNameCollection: new[] { "Id" },
+                fieldsAliasCollection: null,
+                fieldsDescriptionCollection: new[] { "Unique Key" },
+                fieldsPrimaryKeyCollection: primaryKeyFlags,
+                mcpDmlTools: null,
+                mcpCustomTool: null
+            );
+
+            Assert.IsTrue(RuntimeConfigLoader.TryParseConfig(initialConfig, out RuntimeConfig? runtimeConfig), "Parsed config file.");
+            Assert.IsTrue(TryUpdateExistingEntity(options, runtimeConfig!, out RuntimeConfig updatedRuntimeConfig), "Successfully updated entity in the config.");
+
+            Entity updatedEntity = updatedRuntimeConfig.Entities["MyEntity"];
+            Assert.IsNotNull(updatedEntity.Fields);
+            Assert.AreEqual(1, updatedEntity.Fields!.Count);
+            FieldMetadata field = updatedEntity.Fields[0];
+            Assert.AreEqual("Id", field.Name);
+            Assert.AreEqual("Unique Key", field.Description);
+            Assert.AreEqual(expectedPrimaryKey, field.PrimaryKey);
+        }
+
         private static string GetInitialConfigString()
         {
             return @"{" +
diff --git a/src/Cli/ConfigGenerator.cs b/src/Cli/ConfigGenerator.cs
@@ -1747,6 +1747,7 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
                 List<FieldMetadata> updatedFieldsList = ComposeFieldsFromOptions(options);
                 Dictionary<string, FieldMetadata> updatedFieldsDict = updatedFieldsList.ToDictionary(f => f.Name, f => f);
                 List<FieldMetadata> mergedFields = [];
+                bool primaryKeyOptionProvided = options.FieldsPrimaryKeyCollection?.Any() == true;
 
                 foreach (FieldMetadata field in existingFields)
                 {
@@ -1757,7 +1758,10 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
                             Name = updatedField.Name,
                             Alias = updatedField.Alias ?? field.Alias,
                             Description = updatedField.Description ?? field.Description,
-                            PrimaryKey = updatedField.PrimaryKey
+                            // If --fields.primary-key was not provided at all,
+                            // keep the existing primary-key flag. Otherwise,
+                            // use the value coming from updatedField.
+                            PrimaryKey = primaryKeyOptionProvided ? updatedField.PrimaryKey : field.PrimaryKey
                         });
                         updatedFieldsDict.Remove(field.Name); // Remove so only new fields remain
                     }
