openkbs 0.0.37 → 0.0.38

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "openkbs",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "description": "OpenKBS - Command Line Interface",
   "main": "src/index.js",
   "scripts": {
     "build": "pkg .",
-    "deploy": "npm run build && npm run deploy:linux && npm run deploy:macos && npm run deploy:win",
+    "deploy": "npm run build && npm run deploy:linux && npm run deploy:macos && npm run deploy:win && npm run deploy:templates",
     "deploy:linux": "aws s3 cp build/openkbs-linux-x64 s3://openkbs-downloads/cli/linux/openkbs && aws s3 cp build/openkbs-linux-arm64 s3://openkbs-downloads/cli/linux/openkbs-arm64",
     "deploy:macos": "aws s3 cp build/openkbs-macos-arm64 s3://openkbs-downloads/cli/macos/openkbs && aws s3 cp build/openkbs-macos-x64 s3://openkbs-downloads/cli/macos/openkbs-x64",
     "deploy:win": "aws s3 cp build/openkbs-win-x64.exe s3://openkbs-downloads/cli/windows/openkbs.exe && aws s3 cp build/openkbs-win-arm64.exe s3://openkbs-downloads/cli/windows/openkbs-arm64.exe",

package/src/actions.js

@@ -542,6 +542,7 @@ async function updateKnowledgeAction() {
     try {
         const knowledgeDir = path.join(process.cwd(), '.openkbs', 'knowledge');
         const metadataPath = path.join(knowledgeDir, 'metadata.json');
+        const claudeMdPath = path.join(process.cwd(), 'CLAUDE.md');
         
         // Check if .openkbs/knowledge directory exists
         if (!fs.existsSync(knowledgeDir)) {
@@ -593,7 +594,10 @@ async function updateKnowledgeAction() {
         // Download updated knowledge files from S3
         await downloadKnowledgeFromS3(knowledgeDir);
         
-        console.green('Knowledge base updated successfully!');
+        // Download CLAUDE.md file from S3
+        await downloadClaudeMdFromS3(claudeMdPath, s3Client, bucket);
+        
+        console.green('Knowledge base and CLAUDE.md updated successfully!');
         
     } catch (error) {
         console.red('Error updating knowledge base:', error.message);
@@ -651,6 +655,31 @@ async function downloadKnowledgeFromS3(targetDir) {
     }
 }
 
+async function downloadClaudeMdFromS3(claudeMdPath, s3Client, bucket) {
+    const claudeMdKey = 'templates/CLAUDE.md';
+    
+    try {
+        // Download CLAUDE.md file from S3
+        const response = await s3Client.send(new GetObjectCommand({
+            Bucket: bucket,
+            Key: claudeMdKey
+        }));
+        
+        const fileContent = await response.Body.transformToByteArray();
+        await fs.writeFile(claudeMdPath, fileContent);
+        
+        // console.log('Downloaded: CLAUDE.md');
+        
+    } catch (error) {
+        if (error.name === 'NoSuchKey') {
+            console.yellow('CLAUDE.md not found in remote repository, skipping...');
+        } else {
+            console.red('Error downloading CLAUDE.md from S3:', error.message);
+            throw error;
+        }
+    }
+}
+
 module.exports = {
     signAction,
     loginAction,

package/templates/.openkbs/knowledge/examples/ai-copywriter-agent/scripts/run_job.js

@@ -0,0 +1,26 @@
+// This boilerplate code is a starting point for development.
+
+const OpenKBSAgentClient = require('./utils/agent_client');
+
+async function main() {
+    const client = new OpenKBSAgentClient();
+    
+    const message = `Today's Date: ${new Date().toLocaleDateString()}
+
+PROCESS_PRODUCT:
+    Product Name: iPhone 14 Pro Max
+    Product Code: MQ9X3RX/A
+    ID: 97649
+    
+    find at least 2 images and 2 videos
+`;
+
+    try {
+        const result = await client.runJob(message);
+        console.log('Job completed:', result);
+    } catch (error) {
+        console.error('Job failed:', error.message);
+    }
+}
+
+main();

package/templates/.openkbs/knowledge/examples/ai-copywriter-agent/scripts/utils/agent_client.js

@@ -0,0 +1,169 @@
+const https = require('https');
+const fs = require('fs');
+const readline = require('readline');
+const path = require('path');
+
+class OpenKBSAgentClient {
+    constructor() {
+        this.settings = this.findSettings();
+        this.secretsPath = this.findSecretsPath();
+        this.apiKey = null;
+    }
+
+    findSettings() {
+        let currentDir = __dirname;
+        
+        while (currentDir !== path.parse(currentDir).root) {
+            const settingsPath = path.join(currentDir, 'app', 'settings.json');
+            if (fs.existsSync(settingsPath)) {
+                return JSON.parse(fs.readFileSync(settingsPath, 'utf8'));
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        
+        throw new Error('Could not find app/settings.json in parent directories');
+    }
+
+    findSecretsPath() {
+        let currentDir = __dirname;
+        
+        while (currentDir !== path.parse(currentDir).root) {
+            const settingsPath = path.join(currentDir, 'app', 'settings.json');
+            if (fs.existsSync(settingsPath)) {
+                const secretsPath = path.join(currentDir, '.openkbs', 'secrets.json');
+                return secretsPath;
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        
+        throw new Error('Could not find agent directory with app/settings.json');
+    }
+
+    async getApiKey() {
+        if (this.apiKey) return this.apiKey;
+        
+        if (fs.existsSync(this.secretsPath)) {
+            const secrets = JSON.parse(fs.readFileSync(this.secretsPath, 'utf8'));
+            this.apiKey = secrets.apiKey;
+            return this.apiKey;
+        }
+        
+        this.apiKey = await this.promptForApiKey();
+        this.saveApiKey(this.apiKey);
+        return this.apiKey;
+    }
+
+    async promptForApiKey() {
+        return new Promise((resolve) => {
+            const rl = readline.createInterface({
+                input: process.stdin,
+                output: process.stdout
+            });
+
+            console.log(`Please generate an API key from: https://${this.settings.kbId}.apps.openkbs.com/?tab=access&createAPIKey=api-${+new Date()}`);
+
+            rl.question('Enter your API key: ', (key) => {
+                rl.close();
+                resolve(key);
+            });
+
+            rl._writeToOutput = (str) => rl.output.write(rl.line ? "*" : str);
+        });
+    }
+
+    saveApiKey(key) {
+        const secretsDir = path.dirname(this.secretsPath);
+        if (!fs.existsSync(secretsDir)) {
+            fs.mkdirSync(secretsDir, { recursive: true });
+        }
+        fs.writeFileSync(this.secretsPath, JSON.stringify({ apiKey: key }, null, 2));
+    }
+
+    async runJob(message, options = {}) {
+        const apiKey = await this.getApiKey();
+        
+        if (!this.settings.kbId) {
+            throw new Error('First use: "openkbs push" to create the agent');
+        }
+
+        const chatTitle = options.chatTitle || `Task ${new Date().getTime()}`;
+        const chatId = await this.startJob(chatTitle, message, { kbId: this.settings.kbId, apiKey });
+        
+        console.log(`Job ${chatId} created.\nWorking ...`);
+        
+        if (options.poll !== false) {
+            return this.pollForMessages(chatId, { kbId: this.settings.kbId, apiKey });
+        }
+        
+        return chatId;
+    }
+
+    async startJob(chatTitle, data, app) {
+        const response = await this.makeRequest('https://chat.openkbs.com/', { 
+            ...app, 
+            chatTitle, 
+            message: data 
+        });
+        
+        try {
+            return JSON.parse(response)[0].createdChatId;
+        } catch (error) {
+            if (fs.existsSync(this.secretsPath)) {
+                fs.unlinkSync(this.secretsPath);
+            }
+            throw new Error('Authentication failed.');
+        }
+    }
+
+    makeRequest(url, payload) {
+        return new Promise((resolve, reject) => {
+            const { hostname, pathname } = new URL(url);
+            const req = https.request({
+                hostname, 
+                path: pathname, 
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' }
+            }, res => {
+                let data = '';
+                res.on('data', chunk => data += chunk);
+                res.on('end', () => resolve(data));
+            }).on('error', reject);
+
+            req.write(JSON.stringify(payload));
+            req.end();
+        });
+    }
+
+    async pollForMessages(chatId, app) {
+        const payload = { 
+            ...app, 
+            action: 'getChatMessages', 
+            chatId, 
+            decryptContent: true 
+        };
+        
+        return new Promise((resolve) => {
+            const interval = setInterval(() => {
+                this.makeRequest('https://chat.openkbs.com/', payload)
+                    .then(jsonString => {
+                        const messages = JSON.parse(jsonString)[0].data.messages;
+                        for (const message of messages) {
+                            if (message.role === 'system' && 
+                                /{"type"\s*:\s*"(JOB_COMPLETED|JOB_FAILED)".*?}/s.test(message.content)) {
+                                
+                                const result = JSON.parse(message.content)?.data?.find(item => 
+                                    item.type === 'JOB_COMPLETED' || item.type === 'JOB_FAILED'
+                                );
+                                clearInterval(interval);
+                                resolve(result);
+                                return;
+                            }
+                        }
+                    })
+                    .catch(console.error);
+            }, 1000);
+        });
+    }
+}
+
+module.exports = OpenKBSAgentClient;

package/templates/.openkbs/knowledge/examples/ai-copywriter-agent/src/Events/handler.js

@@ -13,12 +13,12 @@ export const backendHandler = async (event) => {
         return acc;
     }, []);
 
+    // For Coding Agents: avoid unnecessary LLM reactions after job is finished
     const isJobFinished = /"JOB_COMPLETED"|"JOB_FAILED"/.test(lastMessage.content);
 
     const meta = {
         _meta_actions:
             (
-                // disable post-response interactions if limit is exceeded or final job response
                 event?.payload?.messages?.length > maxSelfInvokeMessagesCount ||
                 isJobFinished && lastMessage.role === 'system'
             )

package/templates/CLAUDE.md

@@ -1,19 +1,109 @@
 # Claude Code Instructions
 
-## MANDATORY FIRST STEPS
-**CRITICAL**: Before taking ANY action, implementing ANY feature, or answering ANY question about this project:
+# MANDATORY FIRST STEPS
+**CRITICAL**: Before taking ANY action, implementing ANY feature, planing the implementation or answering ANY question about this project, you must perform the following steps:
 
-1. **FIRST**: Update the knowledge base:
-   ```bash
-   openkbs update knowledge
-   ```
+**FIRST**: Update the knowledge base:
+```bash
+openkbs update knowledge
+```
 
-2. **IMMEDIATELY AFTER**: Read the knowledge base README:
-   ```bash
-   # THIS MUST BE YOUR SECOND ACTION - READ THIS FILE FOR MORE INSTRUCTIONS
-   .openkbs/knowledge/README.md
-   ```
+**SECOND**: Read every file in the examples folder using the Read tool:
+- First discover all files in the `.openkbs/knowledge/examples/` directory and ALL subdirectories.
+- Then, use the Read tool to examine the content of EACH file individually (skip only icon.png files).
+- You must read ALL files directly
 
-**DO NOT PROCEED WITHOUT COMPLETING BOTH STEPS IN ORDER**
+**THIRD**: Read existing agent code using the Read tool:
+- First discover all files in the `./app/`, `./src/`, and `./scripts/` folders.
+- Then, use the Read tool to examine each file individually
 
-`.openkbs/knowledge/README.md` contains comprehensive instructions on how to implement openkbs agents
+# OpenKBS Agent Development Guidelines
+
+## **Critical** Rules (**IMPORTANT**)
+- Never skip reading examples
+- Study the complete working examples to understand OpenKBS patterns
+- Never guess framework methods, settings or variables — always reference the examples.
+
+## Development Guidelines
+- To add npm dependency to backend handlers, add it to onRequest.json and onResponse.json
+- In src/Events and src/Frontend always use Imports (not Require)
+- To add npm dependency to the frontend, add it to contentRender.json
+- Valid values for the _meta_actions key are [] or ["REQUEST_CHAT_MODEL"]
+- Add and use npm dependencies only if necessary, some of those shown in the examples are purely demonstrative
+- If developing new agent, generate it's own ./scripts/run_job.js
+- Before using third-party services in onRequest and onResponse handlers, ask the user for permission
+
+## Architecture Overview
+OpenKBS agents have **two execution environments**:
+
+### 1. Cloud Environment (`./src/`)
+- **Event handlers** (`onRequest.js`, `onResponse.js`) run on OpenKBS cloud platform
+- **Purpose**: Process user messages, execute AI actions, return responses
+- **Deployment**: Code is deployed via `openkbs push`
+
+### 2. Local Environment (`./scripts/`)
+- **User-run scripts** execute locally on user's machine
+- **Purpose**: Call cloud agents via API, orchestrate multi-agent workflows, integrate with external systems
+- **Execution**: Run directly with `node scripts/script-name.js`
+
+### Backend
+The OpenKBS backend framework is for developing AI agents with custom tools, using Node.js.
+It integrates with openkbs chat service via `onRequest` and `onResponse` handlers for custom actions and service integration.
+
+#### Backend Handlers
+The OpenKBS framework's core uses `onRequest` and `onResponse` handlers as middleware for message tool call parsing and execution.
+All these event handlers are executed on-demand (upon API request) by the OpenKBS cloud platform, where user production agents are deployed.
+- **`onResponse` Handler:** Activated after the LLM generates a message, enabling command extraction, and action execution.
+- **`onRequest` Handler:** Triggered on user message to allow the user to execute action
+
+#### NPM Dependencies for onRequest.js or onResponse.js Backend Handlers
+1. If a file imports an NPM dependency and is then imported by onRequest.js or onResponse.js, this dependency must be defined in the handler's corresponding json file
+   Example: If actions.js imports mysql2 and onResponse.js imports actions.js, then mysql2 must be in onResponse.json:
+   {
+   "dependencies": {
+   "mysql2": "^3.14.2"
+   }
+   }
+
+Similarly, we need to create onRequest.json for onRequest.js as each handler have separate Node.js build with separate dependencies
+
+#### Managing Secrets
+To securely manage sensitive information like API keys or database passwords within your backend event handlers (onRequest, onResponse, etc.), use the {{secrets.your_secret_name}} syntax.
+
+#### User-Run Scripts
+**User-run scripts** are located in `./scripts/` folder and communicate with cloud agents via API calls.
+
+**Key Components:**
+- `scripts/run_job.js` - Main job runner for calling the cloud agent
+- `scripts/utils/agent_client.js` - Shared utility using `OpenKBSAgentClient` class
+- Custom workflow scripts for multi-agent orchestration
+
+**Architecture:**
+- Scripts use `OpenKBSAgentClient` to communicate with deployed cloud agents
+- **Path Resolution**: Automatically finds `app/settings.json` and `.openkbs/secrets.json` by walking up directories
+- **Usage**: `const client = new OpenKBSAgentClient(); await client.runJob(message);`
+- **Multi-agent support**: Each agent (base or related) finds its own settings and secrets in its directory structure
+
+#### NPM Dependencies for User-Run Scripts
+Add needed NPM dependencies to `package.json`.
+
+### Frontend Overview
+The OpenKBS frontend framework, built with React and MUI, offers a flexible platform for custom chat interfaces. Developers can customize chat appearance and behavior via the `contentRender` module.
+
+#### contentRender
+The `contentRender.js` file is central to frontend customization, exporting key functions for interface adjustments.
+- **`onRenderChatMessage(params)`:** function called every time a chat message is rendered.
+
+#### OpenKBS commands
+`openkbs push` - deploy the agent to openkbs cloud
+`openkbs create my-agent` - creates a directory structure for a new agent
+
+### Creating Related Agents
+To create related agents that work alongside the main agent:
+
+1. **Create in related-agents/ folder**: `cd related-agents && openkbs create agent-name`
+2. **Each related agent gets**: Own `app/settings.json`, `src/` folder, and `.openkbs/secrets.json`
+3. **Script usage**: Related agents use same `OpenKBSAgentClient` - it automatically finds their settings and secrets
+4. **Multi-agent workflows**: Scripts can orchestrate multiple agents by creating separate client instances
+
+Related agents are independent but can share the base agent's script utilities.

package/templates/related-agents/README.md

@@ -0,0 +1,6 @@
+# Related Agents
+
+To add a related agent, use:
+```
+openkbs create "my-agent"
+```

package/templates/scripts/run_job.js

@@ -0,0 +1,26 @@
+// This boilerplate code is a starting point for development.
+
+const OpenKBSAgentClient = require('./utils/agent_client');
+
+async function main() {
+    const client = new OpenKBSAgentClient();
+    
+    const message = `Today's Date: ${new Date().toLocaleDateString()}
+
+PROCESS_PRODUCT:
+    Product Name: iPhone 14 Pro Max
+    Product Code: MQ9X3RX/A
+    ID: 97649
+    
+    find at least 2 images and 2 videos
+`;
+
+    try {
+        const result = await client.runJob(message);
+        console.log('Job completed:', result);
+    } catch (error) {
+        console.error('Job failed:', error.message);
+    }
+}
+
+main();

package/templates/scripts/utils/agent_client.js

@@ -0,0 +1,169 @@
+const https = require('https');
+const fs = require('fs');
+const readline = require('readline');
+const path = require('path');
+
+class OpenKBSAgentClient {
+    constructor() {
+        this.settings = this.findSettings();
+        this.secretsPath = this.findSecretsPath();
+        this.apiKey = null;
+    }
+
+    findSettings() {
+        let currentDir = __dirname;
+        
+        while (currentDir !== path.parse(currentDir).root) {
+            const settingsPath = path.join(currentDir, 'app', 'settings.json');
+            if (fs.existsSync(settingsPath)) {
+                return JSON.parse(fs.readFileSync(settingsPath, 'utf8'));
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        
+        throw new Error('Could not find app/settings.json in parent directories');
+    }
+
+    findSecretsPath() {
+        let currentDir = __dirname;
+        
+        while (currentDir !== path.parse(currentDir).root) {
+            const settingsPath = path.join(currentDir, 'app', 'settings.json');
+            if (fs.existsSync(settingsPath)) {
+                const secretsPath = path.join(currentDir, '.openkbs', 'secrets.json');
+                return secretsPath;
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        
+        throw new Error('Could not find agent directory with app/settings.json');
+    }
+
+    async getApiKey() {
+        if (this.apiKey) return this.apiKey;
+        
+        if (fs.existsSync(this.secretsPath)) {
+            const secrets = JSON.parse(fs.readFileSync(this.secretsPath, 'utf8'));
+            this.apiKey = secrets.apiKey;
+            return this.apiKey;
+        }
+        
+        this.apiKey = await this.promptForApiKey();
+        this.saveApiKey(this.apiKey);
+        return this.apiKey;
+    }
+
+    async promptForApiKey() {
+        return new Promise((resolve) => {
+            const rl = readline.createInterface({
+                input: process.stdin,
+                output: process.stdout
+            });
+
+            console.log(`Please generate an API key from: https://${this.settings.kbId}.apps.openkbs.com/?tab=access&createAPIKey=api-${+new Date()}`);
+
+            rl.question('Enter your API key: ', (key) => {
+                rl.close();
+                resolve(key);
+            });
+
+            rl._writeToOutput = (str) => rl.output.write(rl.line ? "*" : str);
+        });
+    }
+
+    saveApiKey(key) {
+        const secretsDir = path.dirname(this.secretsPath);
+        if (!fs.existsSync(secretsDir)) {
+            fs.mkdirSync(secretsDir, { recursive: true });
+        }
+        fs.writeFileSync(this.secretsPath, JSON.stringify({ apiKey: key }, null, 2));
+    }
+
+    async runJob(message, options = {}) {
+        const apiKey = await this.getApiKey();
+        
+        if (!this.settings.kbId) {
+            throw new Error('First use: "openkbs push" to create the agent');
+        }
+
+        const chatTitle = options.chatTitle || `Task ${new Date().getTime()}`;
+        const chatId = await this.startJob(chatTitle, message, { kbId: this.settings.kbId, apiKey });
+        
+        console.log(`Job ${chatId} created.\nWorking ...`);
+        
+        if (options.poll !== false) {
+            return this.pollForMessages(chatId, { kbId: this.settings.kbId, apiKey });
+        }
+        
+        return chatId;
+    }
+
+    async startJob(chatTitle, data, app) {
+        const response = await this.makeRequest('https://chat.openkbs.com/', { 
+            ...app, 
+            chatTitle, 
+            message: data 
+        });
+        
+        try {
+            return JSON.parse(response)[0].createdChatId;
+        } catch (error) {
+            if (fs.existsSync(this.secretsPath)) {
+                fs.unlinkSync(this.secretsPath);
+            }
+            throw new Error('Authentication failed.');
+        }
+    }
+
+    makeRequest(url, payload) {
+        return new Promise((resolve, reject) => {
+            const { hostname, pathname } = new URL(url);
+            const req = https.request({
+                hostname, 
+                path: pathname, 
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' }
+            }, res => {
+                let data = '';
+                res.on('data', chunk => data += chunk);
+                res.on('end', () => resolve(data));
+            }).on('error', reject);
+
+            req.write(JSON.stringify(payload));
+            req.end();
+        });
+    }
+
+    async pollForMessages(chatId, app) {
+        const payload = { 
+            ...app, 
+            action: 'getChatMessages', 
+            chatId, 
+            decryptContent: true 
+        };
+        
+        return new Promise((resolve) => {
+            const interval = setInterval(() => {
+                this.makeRequest('https://chat.openkbs.com/', payload)
+                    .then(jsonString => {
+                        const messages = JSON.parse(jsonString)[0].data.messages;
+                        for (const message of messages) {
+                            if (message.role === 'system' && 
+                                /{"type"\s*:\s*"(JOB_COMPLETED|JOB_FAILED)".*?}/s.test(message.content)) {
+                                
+                                const result = JSON.parse(message.content)?.data?.find(item => 
+                                    item.type === 'JOB_COMPLETED' || item.type === 'JOB_FAILED'
+                                );
+                                clearInterval(interval);
+                                resolve(result);
+                                return;
+                            }
+                        }
+                    })
+                    .catch(console.error);
+            }, 1000);
+        });
+    }
+}
+
+module.exports = OpenKBSAgentClient;

package/templates/src/Events/handler.js

@@ -13,11 +13,17 @@ export const backendHandler = async (event) => {
         return acc;
     }, []);
 
+    // Avoid unnecessary LLM reactions if job is finished
+    const isJobFinished = /"JOB_COMPLETED"|"JOB_FAILED"/.test(lastMessage.content);
+
     const meta = {
         _meta_actions:
-            event?.payload?.messages?.length > maxSelfInvokeMessagesCount
-                ? [] // Ends the chat
-                : ["REQUEST_CHAT_MODEL"] // Triggers the LLM to react after the response
+            (
+                event?.payload?.messages?.length > maxSelfInvokeMessagesCount ||
+                isJobFinished && lastMessage.role === 'system'
+            )
+                ? []
+                : ["REQUEST_CHAT_MODEL"]
     }
 
     if (matchingActions.length > 0) {

package/templates/.openkbs/knowledge/README.md

@@ -1,57 +0,0 @@
-# OpenKBS Agent Development Guidelines
-
-## MANDATORY FIRST STEP
-**READ EVERY SINGLE FILE IN THE EXAMPLES FOLDER**
-
-Read the content of ALL files in `.openkbs/knowledge/examples/` directory and ALL subdirectories (without the icon.png)
-
-## Development Flow
-
-1. **Read ALL example files first** to get familiar with OpenKBS framework for building AI agents
-2. **Read existing agent code:**
-   - `./app/` folder (settings, instructions, etc.)
-   - `./src/` folder (all Events and Frontend files)
-   - `./run_job.js` any files starting with "run"
-3. **Implement requested features using knowledge from examples**
-
-
-## **Critical** Rules (**IMPORTANT**)
-- Never skip reading examples
-- Study the complete working examples to understand OpenKBS patterns
-- Never guess framework methods, settings or variables — always reference the examples.
-- Think hard before the implementation
-
-## Development Guidelines
-- If develop new agent from scratch, implement the run_job.js script as start point to backend-to-backend integrations
-- To add npm dependency to backend handlers, add it to onRequest.json and onResponse.json
-- To add npm dependency to the frontend, add it to contentRender.json
-- Valid values for the _meta_actions key are [] or ["REQUEST_CHAT_MODEL"].
-- Add and use npm dependencies only if necessary, some of those shown in the examples are purely demonstrative
-
-### Backend
-The OpenKBS backend framework is for developing AI agents with custom tools, using Node.js. It integrates with chat services via `onRequest` and `onResponse` handlers for custom actions and service integration.
-
-#### Backend Handlers
-The framework's core uses `onRequest` and `onResponse` handlers as middleware for message tool call parsing and execution.
-- **`onResponse` Handler:** Activated after the LLM generates a message, enabling command extraction, and action execution.
-- **`onRequest` Handler:** Triggered on user message to allow the user to execute action
-
-#### NPM Dependencies for onRequest.js or onResponse.js Backend Handlers
-1. If a file imports an NPM dependency and is then imported by onRequest.js or onResponse.js, this dependency must be defined in the handler's corresponding json file
-Example: If actions.js imports mysql2 and onResponse.js imports actions.js, then mysql2 must be in onResponse.json:
-{
-   "dependencies": {
-      "mysql2": "^3.14.2"
-   }
-}
-
-Similarly, we need to create onRequest.json for onRequest.js as each handler have separate Node.js build with separate dependencies
-
-
-### Frontend Overview
-The OpenKBS frontend framework, built with React and MUI, offers a flexible platform for custom chat interfaces. Developers can customize chat appearance and behavior via the `contentRender` module.
-
-#### contentRender
-The `contentRender.js` file is central to frontend customization, exporting key functions for interface adjustments.
-- **`onRenderChatMessage(params)`:** function called every time a chat message is rendered.
-

package/templates/.openkbs/knowledge/examples/ai-copywriter-agent/run_job.js

@@ -1,124 +0,0 @@
-// Start new agent job via API call to openkbs cloud service
-
-const https = require('https');
-const fs = require('fs');
-const readline = require('readline');
-const path = require('path');
-
-const settings = JSON.parse(fs.readFileSync('app/settings.json', 'utf8'));
-const secretsPath = path.join('.openkbs', 'secrets.json');
-let apiKey;
-
-const message = `Today's Date: ${new Date().toLocaleDateString()}
-
-PROCESS_PRODUCT:
-    Product Name: iPhone 14 Pro Max
-    Product Code: MQ9X3RX/A
-    ID: 97649
-    
-    find at least 2 images and 2 videos
-`;
-
-if (!settings.kbId) {
-    console.log('First use: "openkbs push" To create the agent')
-    return;
-}
-
-function getApiKey() {
-    if (fs.existsSync(secretsPath)) {
-        const secrets = JSON.parse(fs.readFileSync(secretsPath, 'utf8'));
-        return secrets.apiKey;
-    }
-    return null;
-}
-
-function promptForApiKey() {
-    return new Promise((resolve) => {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout
-        });
-
-        console.log(`Please generate an API key from: https://${settings.kbId}.apps.openkbs.com/?tab=access&createAPIKey=api-${+new Date()}`);
-
-        rl.question('Enter your API key: ', (key) => {
-            rl.close();
-            resolve(key);
-        });
-
-        rl._writeToOutput = (str) => rl.output.write(rl.line ? "*" : str);
-    });
-}
-
-function saveApiKey(key) {
-    if (!fs.existsSync('.openkbs')) {
-        fs.mkdirSync('.openkbs');
-    }
-    fs.writeFileSync(secretsPath, JSON.stringify({ apiKey: key }, null, 2));
-}
-
-async function main() {
-    apiKey = getApiKey();
-
-    if (!apiKey) {
-        apiKey = await promptForApiKey();
-        console.log('\n')
-        saveApiKey(apiKey);
-    }
-
-    const app = { kbId: settings.kbId, apiKey };
-
-    const chatTitle = "Task " + new Date().getTime();
-    startJob(chatTitle, message, app).then(chatId => {
-        console.log(`Job ${chatId} created.\nWorking ...`);
-        pollForMessages(chatId, app);
-    }).catch(console.error);
-}
-
-function startJob(chatTitle, data, app) {
-    return makeRequest('https://chat.openkbs.com/', { ...app, chatTitle, message: data })
-        .then(res => {
-            try {
-                return JSON.parse(res)[0].createdChatId;
-            } catch (error) {
-                fs.unlinkSync(secretsPath);
-                throw 'Authentication failed.';
-            }
-        });
-}
-
-function makeRequest(url, payload) {
-    return new Promise((resolve, reject) => {
-        const { hostname, pathname } = new URL(url);
-        const req = https.request({
-            hostname, path: pathname, method: 'POST',
-            headers: { 'Content-Type': 'application/json' }
-        }, res => {
-            let data = '';
-            res.on('data', chunk => data += chunk);
-            res.on('end', () => resolve(data));
-        }).on('error', reject);
-
-        req.write(JSON.stringify(payload));
-        req.end();
-    });
-}
-
-function pollForMessages(chatId, app) {
-    const payload = { ...app, action: 'getChatMessages', chatId, decryptContent: true };
-    const interval = setInterval(() => {
-        makeRequest('https://chat.openkbs.com/', payload).then(jsonString => {
-            const messages = JSON.parse(jsonString)[0].data.messages;
-            for (const message of messages) {
-                if (message.role === 'system' && /{"type"\s*:\s*"(JOB_COMPLETED|JOB_FAILED)".*?}/s.test(message.content)) {
-                    // return the final response found in the data results array generated by the backendHandler
-                    console.log(JSON.parse(message.content)?.data?.find(item => item.type === 'JOB_COMPLETED' || item.type === 'JOB_FAILED'));
-                    clearInterval(interval);
-                    return;
-                }
-            }
-        }).catch(console.error);
-    }, 1000);
-}
-
-main();