feat: add caller type to tool

mlc-ai · Oct 22, 2024 · eabd24a · eabd24a
1 parent 528c6cb
commit eabd24a
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 18 deletions.
diff --git a/src/action.ts b/src/action.ts
@@ -1,4 +1,4 @@
-import { Scope } from "./scope";
+import { CallerType, Scope, ToolType } from "./enum";
 import { State } from "./state";
 import { Tool } from "./tool";
 
@@ -127,8 +127,9 @@ export const actions: Record<string, Tool> = {
         },
       },
     },
-    type: "action",
-    scopes: [Scope.Overleaf],
+    type: ToolType.Action,
+    scope: [Scope.Overleaf],
+    caller: CallerType.ContentScript,
     implementation: replaceSelectedText,
   },
   appendTextToDocument: {
@@ -150,8 +151,9 @@ export const actions: Record<string, Tool> = {
         },
       },
     },
-    type: "action",
-    scopes: [Scope.Overleaf],
+    type: ToolType.Action,
+    scope: [Scope.Overleaf],
+    caller: CallerType.ContentScript,
     implementation: appendTextToDocument,
   },
   createCalendarEvent: {
@@ -178,7 +180,9 @@ export const actions: Record<string, Tool> = {
         },
       },
     },
-    type: "action",
+    type: ToolType.Action,
+    scope: [Scope.Overleaf],
+    caller: CallerType.Any,
     implementation: createCalendarEvent,
   },
 };
diff --git a/src/enum.ts b/src/enum.ts
@@ -0,0 +1,17 @@
+/* Which domain should a tool be availale */
+export enum Scope {
+  Any = "Any",
+  Overleaf = "Overleaf",
+  GoogleDoc = "Google Doc",
+}
+
+export enum ToolType {
+  Action = "action",
+  Retriever = "retriever",
+}
+
+/* Who should call this function */
+export enum CallerType {
+  Any = "any",
+  ContentScript = "content script",
+}
diff --git a/src/index.ts b/src/index.ts
@@ -2,6 +2,6 @@ export { retrievers } from "./retriever";
 export { actions } from "./action";
 export { tool, toolName, ToolName } from "./tool";
 export { State } from "./state";
-export { Scope } from "./scope";
+export { Scope, ToolType, CallerType } from "./enum";
 export * as retriever from "./retriever";
 export * as action from "./action";
diff --git a/src/retriever.ts b/src/retriever.ts
@@ -1,4 +1,4 @@
-import { Scope } from "./scope";
+import { CallerType, Scope, ToolType } from "./enum";
 import { State } from "./state";
 import { Tool } from "./tool";
 
@@ -64,7 +64,9 @@ export const retrievers: Record<string, Tool> = {
         parameters: { type: "object", properties: {}, required: [] },
       },
     },
-    type: "retriever",
+    type: ToolType.Retriever,
+    scope: Scope.Any,
+    caller: CallerType.Any,
     implementation: getSelectedText,
   },
   getCalendarEvents: {
@@ -85,7 +87,9 @@ export const retrievers: Record<string, Tool> = {
         },
       },
     },
-    type: "retriever",
+    type: ToolType.Retriever,
+    scope: Scope.Any,
+    caller: CallerType.Any,
     implementation: getCalendarEvents,
   },
 };
diff --git a/src/scope.ts b/src/scope.ts
diff --git a/src/tool.ts b/src/tool.ts
@@ -1,6 +1,6 @@
 import { actions } from "./action";
 import { retrievers } from "./retriever";
-import { Scope } from "./scope";
+import { CallerType, Scope, ToolType } from "./enum";
 import { State } from "./state";
 
 export const tool: Record<string, Tool> = {
@@ -29,7 +29,8 @@ export interface Tool {
       };
     };
   };
-  type: "retriever" | "action";
-  scopes?: Scope[];
+  type: ToolType;
+  scope: Scope.Any | Scope[];
+  caller: CallerType;
   implementation: (state: State, parameters: any) => void;
 }