@simfinity/constellation-client 1.0.8 → 1.0.9

package/dist/index.cjs

@@ -31,6 +31,39 @@ var WebClient = class {
     this.sessionId = null;
     this.config = config;
   }
+  /**
+   * Retrieve the list of available tools:
+   * Tools, or functions, can be exposed to & added to the model's context, allowing it
+   * to use them during the session as part of its response creation process. In order to add
+   * a tool to the session context, it must be listed (by name) at session creation time
+   * (see startSession(...) function)
+   *
+   * @remarks
+   * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+   *
+   * @exception
+   * This method throws new Error(...) if unable to execute successfully for any reason.
+   */
+  async fetchAvailableTools() {
+    const response = await fetch(`${this.config.sessionEndpoint}/available_tools`, {
+      method: "GET",
+      headers: {
+        "Authorization": `Bearer ${this.config.key}`,
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+      }
+    });
+    if (!response.ok) {
+      throw new Error(`Could not fetch the list of available tools
+[${response.status}:${response.statusText}]`);
+    }
+    try {
+      const result = await response.json();
+      return result != null ? result : [];
+    } catch (error) {
+      throw `Failed to read session create response: ${error}`;
+    }
+  }
   /**
    * Start a persistent chat room on the server, allowing for re-connection,
    * when the streaming connection is lost. Once a session was started it must
@@ -41,15 +74,18 @@ var WebClient = class {
    *
    * @param audioEnabled whether this session can receive & produce audio as well as text
    * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+   * @param tools a list of tool names to be included in this session. These must be matching the
+   *              names returned by 'fetchAvailableTools()'.
    *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession(audioEnabled, voiceName) {
+  async startSession(audioEnabled, voiceName, tools = []) {
     const prepareBody = {
       llmProvider: this.config.llm,
       audioEnabled,
-      voiceName
+      voiceName,
+      includeTools: tools
     };
     const response = await fetch(`${this.config.sessionEndpoint}/prepare_session`, {
       method: "POST",

package/dist/index.d.cts

@@ -70,6 +70,16 @@ interface EventHandlers {
     onTranscriptResponse?: (transcript: string) => void;
     onTechnicalError?: (error: string) => void;
 }
+/**
+ * Description of an available tool that can be added to a session context.
+ * Tools included in the session context can be used by the AI model during the session.
+ * Tools (or functions) can be many things, for example a calendar manager, allowing
+ * the model to manage the user's schedule.
+ */
+interface ToolDescription {
+    name: string;
+    description: string;
+}
 /**
  * This class is a code wrapper to integrate the Simfinity constellation server.
  * The constellation server is a proxy managing streaming sessions with third party LLMs.
@@ -83,6 +93,20 @@ declare class WebClient {
     private ws;
     private sessionId;
     constructor(config: WebClientConfig);
+    /**
+     * Retrieve the list of available tools:
+     * Tools, or functions, can be exposed to & added to the model's context, allowing it
+     * to use them during the session as part of its response creation process. In order to add
+     * a tool to the session context, it must be listed (by name) at session creation time
+     * (see startSession(...) function)
+     *
+     * @remarks
+     * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+     *
+     * @exception
+     * This method throws new Error(...) if unable to execute successfully for any reason.
+     */
+    fetchAvailableTools(): Promise<ToolDescription[]>;
     /**
      * Start a persistent chat room on the server, allowing for re-connection,
      * when the streaming connection is lost. Once a session was started it must
@@ -93,11 +117,13 @@ declare class WebClient {
      *
      * @param audioEnabled whether this session can receive & produce audio as well as text
      * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+     * @param tools a list of tool names to be included in this session. These must be matching the
+     *              names returned by 'fetchAvailableTools()'.
      *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(audioEnabled: boolean, voiceName?: string): Promise<void>;
+    startSession(audioEnabled: boolean, voiceName?: string, tools?: string[]): Promise<void>;
     /**
      * Close an opened, persistent chat room, effectively killing the streaming as well if still opened.
      * If there is no active session, this method does nothing.
@@ -206,4 +232,4 @@ declare class WebClient {
     private send;
 }
 
-export { type EventHandlers, type LlmType, type SessionConfig, WebClient, type WebClientConfig };
+export { type EventHandlers, type LlmType, type SessionConfig, type ToolDescription, WebClient, type WebClientConfig };

package/dist/index.d.ts

@@ -70,6 +70,16 @@ interface EventHandlers {
     onTranscriptResponse?: (transcript: string) => void;
     onTechnicalError?: (error: string) => void;
 }
+/**
+ * Description of an available tool that can be added to a session context.
+ * Tools included in the session context can be used by the AI model during the session.
+ * Tools (or functions) can be many things, for example a calendar manager, allowing
+ * the model to manage the user's schedule.
+ */
+interface ToolDescription {
+    name: string;
+    description: string;
+}
 /**
  * This class is a code wrapper to integrate the Simfinity constellation server.
  * The constellation server is a proxy managing streaming sessions with third party LLMs.
@@ -83,6 +93,20 @@ declare class WebClient {
     private ws;
     private sessionId;
     constructor(config: WebClientConfig);
+    /**
+     * Retrieve the list of available tools:
+     * Tools, or functions, can be exposed to & added to the model's context, allowing it
+     * to use them during the session as part of its response creation process. In order to add
+     * a tool to the session context, it must be listed (by name) at session creation time
+     * (see startSession(...) function)
+     *
+     * @remarks
+     * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+     *
+     * @exception
+     * This method throws new Error(...) if unable to execute successfully for any reason.
+     */
+    fetchAvailableTools(): Promise<ToolDescription[]>;
     /**
      * Start a persistent chat room on the server, allowing for re-connection,
      * when the streaming connection is lost. Once a session was started it must
@@ -93,11 +117,13 @@ declare class WebClient {
      *
      * @param audioEnabled whether this session can receive & produce audio as well as text
      * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+     * @param tools a list of tool names to be included in this session. These must be matching the
+     *              names returned by 'fetchAvailableTools()'.
      *
      * @exception
      * This method throws new Error(...) if unable to execute successfully for any reason.
      */
-    startSession(audioEnabled: boolean, voiceName?: string): Promise<void>;
+    startSession(audioEnabled: boolean, voiceName?: string, tools?: string[]): Promise<void>;
     /**
      * Close an opened, persistent chat room, effectively killing the streaming as well if still opened.
      * If there is no active session, this method does nothing.
@@ -206,4 +232,4 @@ declare class WebClient {
     private send;
 }
 
-export { type EventHandlers, type LlmType, type SessionConfig, WebClient, type WebClientConfig };
+export { type EventHandlers, type LlmType, type SessionConfig, type ToolDescription, WebClient, type WebClientConfig };

package/dist/index.js

@@ -5,6 +5,39 @@ var WebClient = class {
     this.sessionId = null;
     this.config = config;
   }
+  /**
+   * Retrieve the list of available tools:
+   * Tools, or functions, can be exposed to & added to the model's context, allowing it
+   * to use them during the session as part of its response creation process. In order to add
+   * a tool to the session context, it must be listed (by name) at session creation time
+   * (see startSession(...) function)
+   *
+   * @remarks
+   * Tools are remote functions exposed by MCP servers and integrated by the constellation server
+   *
+   * @exception
+   * This method throws new Error(...) if unable to execute successfully for any reason.
+   */
+  async fetchAvailableTools() {
+    const response = await fetch(`${this.config.sessionEndpoint}/available_tools`, {
+      method: "GET",
+      headers: {
+        "Authorization": `Bearer ${this.config.key}`,
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+      }
+    });
+    if (!response.ok) {
+      throw new Error(`Could not fetch the list of available tools
+[${response.status}:${response.statusText}]`);
+    }
+    try {
+      const result = await response.json();
+      return result != null ? result : [];
+    } catch (error) {
+      throw `Failed to read session create response: ${error}`;
+    }
+  }
   /**
    * Start a persistent chat room on the server, allowing for re-connection,
    * when the streaming connection is lost. Once a session was started it must
@@ -15,15 +48,18 @@ var WebClient = class {
    *
    * @param audioEnabled whether this session can receive & produce audio as well as text
    * @param voiceName LLM specific voice name e.g. with OpenAI this could be 'alloy'
+   * @param tools a list of tool names to be included in this session. These must be matching the
+   *              names returned by 'fetchAvailableTools()'.
    *
    * @exception
    * This method throws new Error(...) if unable to execute successfully for any reason.
    */
-  async startSession(audioEnabled, voiceName) {
+  async startSession(audioEnabled, voiceName, tools = []) {
     const prepareBody = {
       llmProvider: this.config.llm,
       audioEnabled,
-      voiceName
+      voiceName,
+      includeTools: tools
     };
     const response = await fetch(`${this.config.sessionEndpoint}/prepare_session`, {
       method: "POST",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simfinity/constellation-client",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "type": "module",
   "exports": {
     ".": {