feat(chat): update schema assistant prompt to handle empty and short prompts better VSCODE-648

src/participant/participant.ts

@@ -1187,17 +1187,6 @@ export default class ParticipantController {
       });
     }
 
-    if (
-      Prompts.isPromptEmpty(request) &&
-      this._doesLastMessageAskForNamespace(context.history)
-    ) {
-      return this.handleEmptyNamespaceMessage({
-        command: '/schema',
-        context,
-        stream,
-      });
-    }
-
     const namespace = await this._getNamespaceFromChat({
       request,
       context,
@@ -1221,6 +1210,19 @@ export default class ParticipantController {
       });
     }
 
+    if (Prompts.isPromptEmpty(request)) {
+      if (this._doesLastMessageAskForNamespace(context.history)) {
+        return this.handleEmptyNamespaceMessage({
+          command: '/schema',
+          context,
+          stream,
+        });
+      }
+
+      stream.markdown(Prompts.schema.emptyRequestResponse);
+      return emptyRequestChatResult(context.history);
+    }
+
     if (token.isCancellationRequested) {
       return this._handleCancelledRequest({
         context,
@@ -1314,19 +1316,6 @@ export default class ParticipantController {
       });
     }
 
-    if (Prompts.isPromptEmpty(request)) {
-      if (this._doesLastMessageAskForNamespace(context.history)) {
-        return this.handleEmptyNamespaceMessage({
-          command: '/query',
-          context,
-          stream,
-        });
-      }
-
-      stream.markdown(Prompts.query.emptyRequestResponse);
-      return emptyRequestChatResult(context.history);
-    }
-
     // We "prompt chain" to handle the query requests.
     // First we ask the model to parse for the database and collection name.
     // If they exist, we can then use them in our final completion.
@@ -1361,6 +1350,19 @@ export default class ParticipantController {
       });
     }
 
+    if (Prompts.isPromptEmpty(request)) {
+      if (this._doesLastMessageAskForNamespace(context.history)) {
+        return this.handleEmptyNamespaceMessage({
+          command: '/query',
+          context,
+          stream,
+        });
+      }
+
+      stream.markdown(Prompts.query.emptyRequestResponse);
+      return emptyRequestChatResult(context.history);
+    }
+
     let schema: string | undefined;
     let sampleDocuments: Document[] | undefined;
     try {

src/participant/prompts/schema.ts

@@ -1,5 +1,6 @@
 import type { UserPromptResponse } from './promptBase';
 import { PromptBase, type PromptArgsBase } from './promptBase';
+import * as vscode from 'vscode';
 
 export const DOCUMENTS_TO_SAMPLE_FOR_SCHEMA_PROMPT = 100;
 
@@ -21,9 +22,10 @@ export class SchemaPrompt extends PromptBase<SchemaPromptArgs> {
     return `You are a senior engineer who describes the schema of documents in a MongoDB database.
 The schema is generated from a sample of documents in the user's collection.
 You must follow these rules.
-Rule 1: Try to be as concise as possible.
-Rule 2: Pay attention to the JSON schema.
-Rule 3: Mention the amount of documents sampled in your response.
+Rule 1: Your answer should always describe the schema of documents in the collection.
+Rule 2: Try to be as concise as possible.
+Rule 3: Pay attention to the JSON schema.
+Rule 4: Mention the amount of documents sampled in your response.
 Amount of documents sampled: ${amountOfDocumentsSampled}.`;
   }
 
@@ -44,4 +46,10 @@ ${schema}`,
       hasSampleDocs: false,
     });
   }
+
+  get emptyRequestResponse(): string {
+    return vscode.l10n.t(
+      'Please specify a question when using this command. Usage: @MongoDB /schema what is the schema for the sample_mflix.users collection?'
+    );
+  }
 }

src/test/suite/participant/participant.test.ts

@@ -661,6 +661,30 @@ suite('Participant Controller Test Suite', function () {
             });
           });
 
+          test('returns a special response with an empty prompt', async function () {
+            // Put the namespace in metadata as otherwise the user is meant to
+            // be prompted for a namespace with an empty prompt
+            sinon.replace(
+              testParticipantController._chatMetadataStore,
+              'getChatMetadata',
+              () => ({
+                databaseName: 'dbOne',
+                collectionName: 'collectionOne',
+              })
+            );
+
+            await invokeChatHandler({
+              prompt: '',
+              command: 'query',
+              references: [],
+            });
+
+            expect(chatStreamStub.markdown.calledOnce).is.true;
+            expect(chatStreamStub.markdown.getCall(0).firstArg).equals(
+              Prompts.query.emptyRequestResponse
+            );
+          });
+
           test('generates a query', async function () {
             const chatRequestMock = {
               prompt: 'find all docs by a name example',
@@ -1335,47 +1359,6 @@ suite('Participant Controller Test Suite', function () {
               'Which database would you like to use? Select one by either clicking on an item in the list or typing the name manually in the chat.\n\n'
             );
           });
-
-          test('with history, and a blank prompt, it sets a message so it does not cause model error (VSCODE-626)', async function () {
-            const chatRequestMock = {
-              prompt: '',
-              command: 'schema',
-              references: [],
-            };
-            chatContextStub = {
-              history: [
-                createChatRequestTurn(
-                  '/query',
-                  'how do I make a find request vs favorite_fruits.pineapple?'
-                ),
-                createChatResponseTurn('/query', {
-                  response: [
-                    {
-                      value: { value: 'some code' } as vscode.MarkdownString,
-                    },
-                  ],
-                  result: {
-                    metadata: {
-                      intent: 'query',
-                      chatId: 'abc',
-                    },
-                  },
-                }),
-              ],
-            };
-            await invokeChatHandler(chatRequestMock);
-
-            expect(sendRequestStub.calledOnce).to.be.true;
-
-            const messages = sendRequestStub.firstCall
-              .args[0] as vscode.LanguageModelChatMessage[];
-            expect(getMessageContent(messages[0])).to.include(
-              'Parse all user messages to find a database name and a collection name.'
-            );
-            expect(getMessageContent(messages[3])).to.include(
-              'see previous messages'
-            );
-          });
         });
 
         suite(
@@ -1387,6 +1370,30 @@ suite('Participant Controller Test Suite', function () {
               });
             });
 
+            test('returns a special response with an empty prompt', async function () {
+              // Put the namespace in metadata as otherwise the user is meant to
+              // be prompted for a namespace with an empty prompt
+              sinon.replace(
+                testParticipantController._chatMetadataStore,
+                'getChatMetadata',
+                () => ({
+                  databaseName: 'dbOne',
+                  collectionName: 'collectionOne',
+                })
+              );
+
+              await invokeChatHandler({
+                prompt: '',
+                command: 'schema',
+                references: [],
+              });
+
+              expect(chatStreamStub.markdown.calledOnce).is.true;
+              expect(chatStreamStub.markdown.getCall(0).firstArg).equals(
+                Prompts.schema.emptyRequestResponse
+              );
+            });
+
             test('shows a button to view the json output', async function () {
               const chatRequestMock = {
                 prompt: 'what is my schema',