@aquiles-ai/ishikawa-toolkit 1.3.0 → 1.4.0

package/README.md

@@ -20,7 +20,7 @@ npm i @aquiles-ai/ishikawa-toolkit
 Create a file `calculator.ts`:
 
 ```typescript
-export default function calculator(a: number, b: number, operation: string) {
+export default function calculator({a, b, operation}: {a: number; b: number; operation: string}) {
     switch(operation) {
         case 'add': return a + b;
         case 'subtract': return a - b;
@@ -82,14 +82,136 @@ console.log(tool.metadata.description);
 // Output: "Performs basic mathematical operations"
 
 // Execute the tool
-const result = await tool.execute(10, 5, 'add');
+const result = await tool.execute({a: 10, b: 5, operation:'add'});
 console.log(result); // Output: 15
 
 // Or use shortcut
-const result2 = await manager.execute('calculator', 20, 4, 'divide');
+const result2 = await manager.executeTool('calculator', {a: 20, b: 4, operation: 'divide'});
 console.log(result2); // Output: 5
 
 // List all registered tools
 const tools = await manager.list();
 console.log(tools); // Output: ['calculator', ...]
 ```
+## Using with Local LLMs
+
+Ishikawa-toolkit works seamlessly with local LLM servers like vLLM. Here's how to set up function calling with a local model:
+
+### 1. Start vLLM Server
+
+Start your vLLM server with tool calling enabled:
+```bash
+vllm serve openai/gpt-oss-20b \
+    --served-model-name gpt-oss-20b \
+    --host 0.0.0.0 \
+    --port 8000 \
+    --async-scheduling \
+    --enable-auto-tool-choice \
+    --tool-call-parser openai \
+    --api-key dummyapikey
+```
+
+### 2. Implement the Agent Loop
+
+Here's a complete example using the `calculator` tool from the Quick Start section:
+
+```typescript
+import OpenAI from "openai";
+import { ToolManager } from "@aquiles-ai/ishikawa-toolkit";
+
+const client = new OpenAI({ 
+    baseURL: "http://localhost:8000/v1", 
+    apiKey: "dummyapikey"
+});
+
+const tools = new ToolManager();
+const namesTools = await tools.listTools();
+
+const allToolsMetadata = await Promise.all(
+    namesTools.map(async (toolName) => {
+        try {
+            return await tools.getMetadataTool(toolName);
+        } catch (error) {
+            console.error(`X Error cargando ${toolName}:`, error);
+            return null;
+        }
+    })
+);
+
+const toolsMetadata = allToolsMetadata.filter(m => m !== null).map(m => ({
+    type: m.type,
+    name: m.name,
+    description: m.description,
+    parameters: m.parameters
+}));
+
+let input = [
+    { 
+        role: "user", 
+        content: "Can you validate the basic operations using the tool (The tool you need to use is the 'calculator', always use it)?" 
+    },
+];
+
+let response = await client.responses.create({
+    model: "gpt-oss-20b",
+    tools: toolsMetadata,
+    input,
+});
+
+// console.log("Response 1:", response);
+
+for (const item of response.output) {
+    if (item.type == "function_call") {
+        const cleanName = item.name.split('<|')[0].trim();
+        
+        if (namesTools.includes(cleanName)) {
+            console.log("Running the tool: " + cleanName);
+            
+            let parsedArgs = {};
+            try {
+                parsedArgs = typeof item.arguments === "string" 
+                    ? JSON.parse(item.arguments) 
+                    : item.arguments ?? {};
+            } catch (e) {
+                console.error("X Error parsing function arguments:", e);
+            }
+
+            try {
+                const result = await tools.executeTool(cleanName, parsedArgs);
+                console.log(`Result: ${result}`);
+
+                input.push({
+                    ...item,
+                    name: cleanName
+                });
+                
+                input.push({
+                    type: "function_call_output",
+                    call_id: item.call_id,
+                    output: String(result), 
+                });
+            } catch (err) {
+                console.error("X Tool execution error:", err);
+                input.push(item);
+                input.push({
+                    type: "function_call_output",
+                    call_id: item.call_id,
+                    output: JSON.stringify({ error: String(err) }),
+                });
+            }
+        }
+    }
+}
+
+const response2 = await client.responses.create({
+    model: "gpt-oss-20b",
+    instructions: "Answer based on the results obtained from the tool. What inputs did you provide and what output did you obtain?",
+    tools: toolsMetadata,
+    input: input,
+});
+
+console.log("Final output:");
+console.log(response2.output_text);
+```
+
+For more models and parser options, see the [vLLM documentation](https://docs.vllm.ai/en/latest/features/tool_calling/).

package/dist/modules/compiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../../src/modules/compiler.ts"],"names":[],"mappings":"AAEA,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,iBAclD"}
+{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../../src/modules/compiler.ts"],"names":[],"mappings":"AAKA,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,iBAkBlD"}

package/dist/modules/compiler.js

@@ -1,9 +1,13 @@
 import { build } from 'esbuild';
+import { mkdir } from 'fs/promises';
+import { join } from 'path';
 export async function ToolCompiler(toolPath) {
     try {
+        const distPath = join(toolPath, 'dist');
+        await mkdir(distPath, { recursive: true });
         await build({
             entryPoints: [toolPath + '/index.ts'],
-            outfile: toolPath + '/index.js',
+            outfile: join(toolPath, 'dist', 'index.js'),
             platform: 'node',
             format: 'esm',
             target: 'node18',

package/dist/modules/compiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"compiler.js","sourceRoot":"","sources":["../../src/modules/compiler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAgB;IAC/C,IAAI,CAAC;QACD,MAAM,KAAK,CAAC;YACR,WAAW,EAAE,CAAC,QAAQ,GAAG,WAAW,CAAC;YACrC,OAAO,EAAE,QAAQ,GAAG,WAAW;YAC/B,QAAQ,EAAE,MAAM;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IAChB,CAAC;AACL,CAAC"}
+{"version":3,"file":"compiler.js","sourceRoot":"","sources":["../../src/modules/compiler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAG5B,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAgB;IAC/C,IAAI,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3C,MAAM,KAAK,CAAC;YACR,WAAW,EAAE,CAAC,QAAQ,GAAG,WAAW,CAAC;YACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC;YAC3C,QAAQ,EAAE,MAAM;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IAChB,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aquiles-ai/ishikawa-toolkit",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Extensible framework for creating and managing LLM function calling",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",