openkbs 0.0.30 → 0.0.31

package/MODIFY.md

@@ -15,7 +15,7 @@ A typical OpenKBS project has the following key directories:
 
 *   **`src/`**: Contains your custom source code.
     *   **`Events/`**: Houses backend event handlers.
-        *   `actions.js`: Often used for shared logic/tool definitions.
+        *   `actions.js`: Often used for shared logic/tool definitions (does not have own NPM dependencies).
         *   `onRequest.js`: Handles incoming user messages before LLM processing.
         *   `onRequest.json`: NPM dependencies for `onRequest.js`.
         *   `onResponse.js`: Handles LLM responses before sending to the user.
@@ -32,14 +32,24 @@ A typical OpenKBS project has the following key directories:
     *   `instructions.txt`: Instructions for the LLM.
     *   `icon.png`: Application icon.
 
-## Backend Dependencies and Secrets Management
+#### onRequest and onResponse Handlers
 
-To use external NPM packages in your backend event handlers, you must declare them in the corresponding `.json` file. 
+The core of the OpenKBS backend framework revolves around the `onRequest` and `onResponse` event handlers.  
+These handlers act as middleware, intercepting messages before and after they are processed by the LLM.
+
+* **`onRequest` Handler:** This handler is invoked every time a user sends a message to the chat. It provides an opportunity to pre-process the user's input, extract commands and perform actions based on the user's message.
+
+* **`onResponse` Handler:** This handler is invoked after the LLM generates a response. It allows post-processing of the LLM's output, execution of commands based on the LLM's intentions.
+
+
+## Backend Dependencies
+
+To use external NPM packages in your backend event handlers, you must declare them in the corresponding `.json` file.
 OpenKBS also provides a secure way to handle sensitive information using the `{{secrets.your_secret_name}}` syntax.
 
 **Example: Using axios with an API key**
 
-1.  **Declare dependency in `src/Events/onRequest.json` and `src/Events/onResponse.json` **:
+1. **Declare dependencies** in both `src/Events/onRequest.json` and `src/Events/onResponse.json` (as each handler have separate build):
     ```json
     {
       "dependencies": {
@@ -68,5 +78,6 @@ OpenKBS also provides a secure way to handle sensitive information using the `{{
         ];
     };
     ```
-
-Define `news_api_key` in your application's secrets manager on the OpenKBS platform. The platform will inject the actual value at runtime, keeping your credentials secure while enabling you to make API calls with authenticated services.
+## Secrets Management
+Define `news_api_key` in your application's secrets manager on the OpenKBS platform.
+The platform will inject the actual value at runtime, keeping your credentials secure while enabling you to make API calls with authenticated services.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openkbs",
-  "version": "0.0.30",
+  "version": "0.0.31",
   "description": "OpenKBS - Command Line Interface",
   "main": "src/index.js",
   "scripts": {

package/src/utils.js

@@ -332,10 +332,10 @@ async function modifyKB(kbToken, kbData, prompt, files, options) {
             console.error('Error getting files from directories:', error);
         }
     }
-    
+
     // Add MODIFY.md to files list if it exists
     if (hasModifyFile && !files.includes(modifyFilePath)) {
-        files.push(modifyFilePath);
+        files.unshift(modifyFilePath);
     }
 
     const fileContents = await Promise.all(files.map(async (filePath) => {