Implement pieces of planned Commands API in support of AI App Generator card

packages/ai-bot/README.md

@@ -42,7 +42,7 @@ It will be able to see any cards shared in the chat and can respond using GPT4 i
 You can deliberately trigger a specific patch by sending a message that starts `debug:patch:` and has the JSON patch you want returned. For example:
 
 ```
-debug:patch:{"card_id":"http://localhost:4200/experiments/Author/1", "description": "message", "attributes": {"firstName": "David"}}
+debug:patch:{"attributes": {"cardId":"http://localhost:4200/experiments/Author/1", "patch": { "attributes": {"firstName": "David"}}}}
 ```
 
 This will return a patch with the ID of the last card you uploaded. This does not hit GPT4 and is useful for testing the integration of the two components without waiting for streaming responses.

packages/ai-bot/helpers.ts

@@ -246,6 +246,7 @@ export function getTools(
   history: DiscreteMatrixEvent[],
   aiBotUserId: string,
 ): Tool[] {
+  // TODO: there should be no default tools defined in the ai-bot, tools must be determined by the host
   let searchTool = getSearchTool();
   let tools = [searchTool];
   // Just get the users messages
@@ -426,7 +427,6 @@ export function getModifyPrompt(
     mostRecentlyAttachedCard,
     attachedCards,
   );
-
   if (skillCards.length) {
     systemMessage += SKILL_INSTRUCTIONS_MESSAGE;
     systemMessage += skillCardsToMessage(skillCards);

packages/ai-bot/lib/debug.ts

@@ -33,16 +33,21 @@ export async function handleDebugCommands(
     let patchMessage = eventBody.split('debug:patch:')[1];
     // If there's a card attached, we need to split it off to parse the json
     patchMessage = patchMessage.split('(Card')[0];
-    let command: {
-      card_id?: string;
+    let toolArguments: {
+      attributes?: {
+        cardId?: string;
+        patch?: any;
+      };
       description?: string;
-      attributes?: any;
     } = {};
     try {
-      command = JSON.parse(patchMessage);
-      if (!command.card_id || !command.description || !command.attributes) {
+      toolArguments = JSON.parse(patchMessage);
+      if (
+        !toolArguments.attributes?.cardId ||
+        !toolArguments.attributes?.patch
+      ) {
         throw new Error(
-          'Invalid debug patch: card_id, description, or attributes is missing.',
+          'Invalid debug patch: attributes.cardId, or attributes.patch is missing.',
         );
       }
     } catch (error) {
@@ -54,7 +59,17 @@ export async function handleDebugCommands(
         undefined,
       );
     }
-    return await sendOption(client, roomId, command, undefined);
+    return await sendOption(
+      client,
+      roomId,
+      {
+        id: 'patchCard-debug',
+        name: 'patchCard',
+        type: 'function',
+        arguments: toolArguments,
+      },
+      undefined,
+    );
   }
   return;
 }

packages/ai-bot/main.ts

@@ -44,16 +44,17 @@ class Assistant {
   getResponse(history: DiscreteMatrixEvent[]) {
     let tools = getTools(history, this.id);
     let messages = getModifyPrompt(history, this.id, tools);
+
     if (tools.length === 0) {
       return this.openai.beta.chat.completions.stream({
         model: 'openai/gpt-4o',
-        messages: messages,
+        messages,
       });
     } else {
       return this.openai.beta.chat.completions.stream({
         model: 'openai/gpt-4o',
-        messages: messages,
-        tools: tools,
+        messages,
+        tools,
         tool_choice: 'auto',
       });
     }

packages/ai-bot/tests/chat-titling-test.ts

@@ -378,9 +378,13 @@ module('shouldSetRoomTitle', () => {
             toolCall: {
               name: 'patchCard',
               arguments: {
-                card_id: 'http://localhost:4201/experiments/Friend/1',
                 attributes: {
-                  firstName: 'Dave',
+                  cardId: 'http://localhost:4201/experiments/Friend/1',
+                  patch: {
+                    attributes: {
+                      firstName: 'Dave',
+                    },
+                  },
                 },
               },
             },
@@ -443,9 +447,13 @@ module('shouldSetRoomTitle', () => {
             toolCall: {
               name: 'patchCard',
               arguments: {
-                card_id: 'http://localhost:4201/drafts/Friend/1',
                 attributes: {
-                  firstName: 'Dave',
+                  cardId: 'http://localhost:4201/drafts/Friend/1',
+                  patch: {
+                    attributes: {
+                      firstName: 'Dave',
+                    },
+                  },
                 },
               },
             },

packages/ai-bot/tests/prompt-construction-test.ts

@@ -15,7 +15,7 @@ import type {
   Tool,
   CardMessageContent,
 } from 'https://cardstack.com/base/matrix-event';
-import { EventStatus } from 'matrix-js-sdk';
+import { EventStatus, IRoomEvent } from 'matrix-js-sdk';
 import type { SingleCardDocument } from '@cardstack/runtime-common';
 import { CardDef } from 'https://cardstack.com/base/card-api';
 
@@ -769,7 +769,9 @@ module('getModifyPrompt', () => {
               openCardIds: ['http://localhost:4201/experiments/Friend/1'],
               tools: [
                 getPatchTool('http://localhost:4201/experiments/Friend/1', {
-                  firstName: { type: 'string' },
+                  attributes: {
+                    firstName: { type: 'string' },
+                  },
                 }),
               ],
               submode: 'interact',
@@ -891,13 +893,13 @@ module('getModifyPrompt', () => {
         parameters: {
           type: 'object',
           properties: {
-            description: {
-              type: 'string',
-            },
             card_id: {
               type: 'string',
               const: 'http://localhost:4201/experiments/Friend/1',
             },
+            description: {
+              type: 'string',
+            },
             attributes: {
               type: 'object',
               properties: {
@@ -928,7 +930,12 @@ module('getModifyPrompt', () => {
               openCardIds: ['http://localhost:4201/experiments/Friend/1'],
               tools: [
                 getPatchTool('http://localhost:4201/experiments/Friend/1', {
-                  firstName: { type: 'string' },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      firstName: { type: 'string' },
+                    },
+                  },
                 }),
               ],
               submode: 'interact',
@@ -960,15 +967,30 @@ module('getModifyPrompt', () => {
             description: {
               type: 'string',
             },
-            card_id: {
-              type: 'string',
-              const: 'http://localhost:4201/experiments/Friend/1',
-            },
-            firstName: {
-              type: 'string',
+            attributes: {
+              type: 'object',
+              properties: {
+                cardId: {
+                  type: 'string',
+                  const: 'http://localhost:4201/experiments/Friend/1',
+                },
+                patch: {
+                  type: 'object',
+                  properties: {
+                    attributes: {
+                      type: 'object',
+                      properties: {
+                        firstName: {
+                          type: 'string',
+                        },
+                      },
+                    },
+                  },
+                },
+              },
             },
           },
-          required: ['card_id', 'attributes', 'description'],
+          required: ['attributes', 'description'],
         },
       },
     });
@@ -989,7 +1011,9 @@ module('getModifyPrompt', () => {
               openCardIds: ['http://localhost:4201/experiments/Friend/1'],
               tools: [
                 getPatchTool('http://localhost:4201/experiments/Friend/1', {
-                  firstName: { type: 'string' },
+                  attributes: {
+                    firstName: { type: 'string' },
+                  },
                 }),
               ],
               submode: 'interact',
@@ -1018,7 +1042,12 @@ module('getModifyPrompt', () => {
               openCardIds: ['http://localhost:4201/experiments/Meeting/2'],
               tools: [
                 getPatchTool('http://localhost:4201/experiments/Meeting/2', {
-                  location: { type: 'string' },
+                  attributes: {
+                    type: 'object',
+                    properties: {
+                      location: { type: 'string' },
+                    },
+                  },
                 }),
               ],
               submode: 'interact',
@@ -1048,18 +1077,33 @@ module('getModifyPrompt', () => {
           parameters: {
             type: 'object',
             properties: {
-              card_id: {
-                type: 'string',
-                const: 'http://localhost:4201/experiments/Meeting/2',
-              },
               description: {
                 type: 'string',
               },
-              location: {
-                type: 'string',
+              attributes: {
+                type: 'object',
+                properties: {
+                  cardId: {
+                    type: 'string',
+                    const: 'http://localhost:4201/experiments/Meeting/2',
+                  },
+                  patch: {
+                    type: 'object',
+                    properties: {
+                      attributes: {
+                        type: 'object',
+                        properties: {
+                          location: {
+                            type: 'string',
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
               },
             },
-            required: ['card_id', 'attributes', 'description'],
+            required: ['attributes', 'description'],
           },
         },
       });
@@ -1867,11 +1911,13 @@ module('getModifyPrompt', () => {
               id: 'tool-call-id-1',
               name: 'searchCard',
               arguments: {
-                description: "Search for card instances of type 'Author'",
-                filter: {
-                  type: {
-                    module: 'http://localhost:4201/drafts/author',
-                    name: 'Author',
+                attributes: {
+                  description: "Search for card instances of type 'Author'",
+                  filter: {
+                    type: {
+                      module: 'http://localhost:4201/drafts/author',
+                      name: 'Author',
+                    },
                   },
                 },
               },

packages/ai-bot/tests/responding-test.ts

@@ -184,9 +184,15 @@ module('Responding', (hooks) => {
 
   test('Sends tool call event and replaces thinking message when tool call happens with no content', async () => {
     const patchArgs = {
-      card_id: 'card/1',
       description: 'A new thing',
-      attributes: { some: 'thing' },
+      attributes: {
+        cardId: 'card/1',
+        patch: {
+          attributes: {
+            some: 'thing',
+          },
+        },
+      },
     };
 
     await responder.initialize();
@@ -225,10 +231,14 @@ module('Responding', (hooks) => {
           id: 'some-tool-call-id',
           name: 'patchCard',
           arguments: {
-            card_id: 'card/1',
             description: 'A new thing',
             attributes: {
-              some: 'thing',
+              cardId: 'card/1',
+              patch: {
+                attributes: {
+                  some: 'thing',
+                },
+              },
             },
           },
         },
@@ -252,9 +262,15 @@ module('Responding', (hooks) => {
 
   test('Sends tool call event separately when content is sent before tool call', async () => {
     const patchArgs = {
-      card_id: 'card/1',
       description: 'A new thing',
-      attributes: { some: 'thing' },
+      attributes: {
+        cardId: 'card/1',
+        patch: {
+          attributes: {
+            some: 'thing',
+          },
+        },
+      },
     };
     await responder.initialize();
 
@@ -293,10 +309,14 @@ module('Responding', (hooks) => {
           id: 'some-tool-call-id',
           name: 'patchCard',
           arguments: {
-            card_id: 'card/1',
             description: 'A new thing',
             attributes: {
-              some: 'thing',
+              cardId: 'card/1',
+              patch: {
+                attributes: {
+                  some: 'thing',
+                },
+              },
             },
           },
         },

packages/base/card-api.gts

@@ -44,6 +44,7 @@ import {
   type Actions,
   type RealmInfo,
   CodeRef,
+  CommandContext,
 } from '@cardstack/runtime-common';
 import type { ComponentLike } from '@glint/template';
 import { initSharedState } from './shared-state';
@@ -130,6 +131,7 @@ interface NotLoadedValue {
 
 export interface CardContext {
   actions?: Actions;
+  commandContext?: CommandContext;
   cardComponentModifier?: typeof Modifier<{
     Args: {
       Named: {