Improve schema designer tool post-open steering (#21478)

* Improve schema designer tool post-open steering

* Remove unused showSchemaToolSuccessMessage constant

* Use placeholders for schema designer tool identifiers in localized message

Author: caohai

extensions/mssql/l10n/bundle.l10n.json

@@ -2646,7 +2646,14 @@
         "comment": ["{0} is the connection ID"]
     },
     "Unknown Connection": "Unknown Connection",
-    "Schema visualization opened.": "Schema visualization opened.",
+    "Schema designer opened. For schema mutations, continue with {0} operations ({1}/{2})./{0} is the command identifier 'mssql_schema_designer' and must not be translated{1} is the operation name 'get_overview' and must not be translated{2} is the operation name 'apply_edits' and must not be translated": {
+        "message": "Schema designer opened. For schema mutations, continue with {0} operations ({1}/{2}).",
+        "comment": [
+            "{0} is the command identifier 'mssql_schema_designer' and must not be translated",
+            "{1} is the operation name 'get_overview' and must not be translated",
+            "{2} is the operation name 'apply_edits' and must not be translated"
+        ]
+    },
     "Execute '{0}' operation on the schema designer?/{0} is the operation name": {
         "message": "Execute '{0}' operation on the schema designer?",
         "comment": ["{0} is the operation name"]

extensions/mssql/src/constants/locConstants.ts

@@ -2021,7 +2021,16 @@ export class MssqlChatAgent {
         });
     };
     public static unknownConnection = l10n.t("Unknown Connection");
-    public static showSchemaToolSuccessMessage = l10n.t("Schema visualization opened.");
+    public static schemaDesignerToolShowSuccessMessage = l10n.t({
+        message:
+            "Schema designer opened. For schema mutations, continue with {0} operations ({1}/{2}).",
+        args: ["mssql_schema_designer", "get_overview", "apply_edits"],
+        comment: [
+            "{0} is the command identifier 'mssql_schema_designer' and must not be translated",
+            "{1} is the operation name 'get_overview' and must not be translated",
+            "{2} is the operation name 'apply_edits' and must not be translated",
+        ],
+    });
     public static schemaDesignerToolConfirmationTitle = l10n.t("Schema Designer");
     public static schemaDesignerToolConfirmationMessage = (operation: string) => {
         return l10n.t({

extensions/mssql/src/copilot/tools/schemaDesignerTool.ts

@@ -295,8 +295,15 @@ export class SchemaDesignerTool extends ToolBase<SchemaDesignerToolParams> {
                     withTarget(
                         {
                             success: true,
-                            message: loc.showSchemaToolSuccessMessage,
+                            message: loc.schemaDesignerToolShowSuccessMessage,
                             version,
+                            recommendedTool: this.toolName,
+                            recommendedNextCall: {
+                                operation: "get_overview",
+                                options: { includeColumns: "namesAndTypes" },
+                            },
+                            schemaMutationPath:
+                                "use apply_edits for schema mutations in active designer",
                         },
                         designer,
                     ),

extensions/mssql/test/unit/schemaDesignerTool.test.ts

@@ -255,8 +255,16 @@ suite("SchemaDesignerTool Tests", () => {
             const parsedResult = JSON.parse(result);
 
             expect(parsedResult.success).to.be.true;
-            expect(parsedResult.message).to.equal(loc.showSchemaToolSuccessMessage);
+            expect(parsedResult.message).to.equal(loc.schemaDesignerToolShowSuccessMessage);
             expect(parsedResult.version).to.equal(computeSchemaVersion(mockSchema));
+            expect(parsedResult.recommendedTool).to.equal("mssql_schema_designer");
+            expect(parsedResult.recommendedNextCall).to.deep.equal({
+                operation: "get_overview",
+                options: { includeColumns: "namesAndTypes" },
+            });
+            expect(parsedResult.schemaMutationPath).to.equal(
+                "use apply_edits for schema mutations in active designer",
+            );
             expect(parsedResult.server).to.equal(sampleServer);
             expect(parsedResult.database).to.equal(sampleDatabase);
             expect(showSchemaStub).to.have.been.calledOnceWith(sampleConnectionId, sampleDatabase);

localization/xliff/vscode-mssql.xlf

@@ -5180,6 +5180,12 @@
     <trans-unit id="++CODE++bcfd627eae48fe0460c71c47de6ce52a35780136e70593d6f17da5f3ba3ec894">
       <source xml:lang="en">Schema designer is not initialized.</source>
     </trans-unit>
+    <trans-unit id="++CODE++bb752783460568a627729df83424ba6dc42ba33b3a2ba1a4573572d03d801b77">
+      <source xml:lang="en">Schema designer opened. For schema mutations, continue with {0} operations ({1}/{2}).</source>
+      <note>{0} is the command identifier &apos;mssql_schema_designer&apos; and must not be translated
+{1} is the operation name &apos;get_overview&apos; and must not be translated
+{2} is the operation name &apos;apply_edits&apos; and must not be translated</note>
+    </trans-unit>
     <trans-unit id="++CODE++fcc1609bd956a758207d72b215d69f60b29e8624fe879bf9ff721384783cc455">
       <source xml:lang="en">Schema designer state changed. Fetch the latest schema and retry the operation.</source>
     </trans-unit>
@@ -5192,9 +5198,6 @@
     <trans-unit id="++CODE++c55acbc843338cecc106d5428a6c2c6cd65129c6b5c440b6477f06206d844ded">
       <source xml:lang="en">Schema is required</source>
     </trans-unit>
-    <trans-unit id="++CODE++625f64194868ec34a2b8b5b02385d3999fc9cdddbb2e823e10a1d965574d8e6c">
-      <source xml:lang="en">Schema visualization opened.</source>
-    </trans-unit>
     <trans-unit id="++CODE++26336e4216dbda9c374906c54ade398c597b59facd87fba0be1758fc497bde2a">
       <source xml:lang="en">Schema/Object Type</source>
     </trans-unit>