use JSON string in chat messages

Author: ajshedivy

src/chat/chat.ts

@@ -88,9 +88,7 @@ export function activateChat(context: vscode.ExtensionContext) {
                 `Provide the developer with SQL statements or relevant information based on the user's prompt and referenced table structures. Always include practical code examples where applicable. Ensure all suggestions are directly applicable to the structures and data provided and avoid making suggestions outside the scope of the available information.`
               ),
               vscode.LanguageModelChatMessage.User(
-                `Here are the table references ${refsToMarkdown(
-                  refs
-                )}`
+                `Here are the table references ${JSON.stringify(refs)}`
               ),
               vscode.LanguageModelChatMessage.User(request.prompt)
             );

src/chat/context.ts

@@ -114,6 +114,25 @@ export async function findPossibleTables(stream: vscode.ChatResponseStream, sche
   return tables;
 }
 
+
+/**
+ * Converts a given set of table references to a Markdown string.
+ * 
+ * Experimental feature for @db2i chat participant
+ *
+ * @param refs - An object containing table references, where each key is a table name
+ * and the value is an array of column definitions for that table.
+ * 
+ * @returns A string formatted in Markdown representing the table references.
+ * 
+ * The function generates a Markdown representation of the table references. If the number
+ * of tables is greater than 5, a condensed format is used, otherwise a detailed format is used.
+ * 
+ * The condensed format includes columns: Column, Type, and Text.
+ * The detailed format includes columns: Column, Type, Nullable, Identity, Text, and Constraint.
+ * 
+ * Tables with names starting with 'SYS' are skipped.
+ */
 export function refsToMarkdown(refs: TableRefs) {
   const condensedResult = Object.keys(refs).length > 5;