@loopstack/accessing-tool-results-example-workflow 0.16.0 → 0.18.0

package/README.md

@@ -1 +1,167 @@
-# Loopstack Accessing Tool Results Example
+# @loopstack/accessing-tool-results-example-workflow
+
+> A module for the [Loopstack AI](https://loopstack.ai) automation framework.
+
+This module provides an example workflow demonstrating different methods for accessing tool results within and across workflow transitions.
+
+## Overview
+
+The Tool Results Example Workflow shows how to retrieve and use data returned by tools in subsequent workflow steps. Understanding these patterns is essential for building workflows that pass data between operations.
+
+By using this workflow as a reference, you'll learn how to:
+
+- Access tool results using call IDs
+- Access tool results using call indices
+- Retrieve data from previous transitions
+- Create custom helper functions for data extraction
+
+This example is useful for developers learning to build data-driven workflows that need to pass information between steps.
+
+## Installation
+
+### Prerequisites
+
+Create a new Loopstack project if you haven't already:
+
+```bash
+npx create-loopstack-app my-project
+cd my-project
+```
+
+Start Environment
+
+```bash
+cd my-project
+docker compose up -d
+```
+
+### Add the Module
+
+```bash
+loopstack add @loopstack/accessing-tool-results-example-workflow
+```
+
+This copies the source files into your `src` directory.
+
+> Using the `loopstack add` command is a great way to explore the code to learn new concepts or add own customizations.
+
+## Setup
+
+### 1. Import the Module
+
+Add `AccessingToolResultsExampleModule` to your `default.module.ts` (included in the skeleton app) or to your own module:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { LoopCoreModule } from '@loopstack/core';
+import { CoreUiModule } from '@loopstack/core-ui-module';
+import { AccessingToolResultsExampleModule } from './accessing-tool-results-example-workflow';
+import { DefaultWorkspace } from './default.workspace';
+
+@Module({
+  imports: [LoopCoreModule, CoreUiModule, AccessingToolResultsExampleModule],
+  providers: [DefaultWorkspace],
+})
+export class DefaultModule {}
+```
+
+### 2. Register in Your Workspace
+
+Add the workflow to your workspace class using the `@Workflow()` decorator:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { BlockConfig, Workflow } from '@loopstack/common';
+import { WorkspaceBase } from '@loopstack/core';
+import { WorkflowToolResultsWorkflow } from './accessing-tool-results-example-workflow';
+
+@Injectable()
+@BlockConfig({
+  config: {
+    title: 'My Workspace',
+    description: 'A workspace with the tool results example workflow',
+  },
+})
+export class MyWorkspace extends WorkspaceBase {
+  @Workflow() workflowToolResults: WorkflowToolResultsWorkflow;
+}
+```
+
+## How It Works
+
+### Accessing Tool Results
+
+#### 1. Using Call IDs
+
+Assign a unique `id` to a tool call, then reference it via `metadata.tools.<transition_id>.<call_id>.data`:
+
+```yaml
+- id: say_hello
+  tool: createValue
+  args:
+    input: 'Hello World.'
+
+- tool: createChatMessage
+  args:
+    content: '{{ metadata.tools.create_some_data.say_hello.data }}'
+```
+
+#### 2. Using Call Indices
+
+Access tool results by their position (zero-indexed) within the transition:
+
+```yaml
+- tool: createChatMessage
+  args:
+    content: '{{ metadata.tools.create_some_data.0.data }}'
+```
+
+#### 3. Across Transitions
+
+Tool results persist and can be accessed from subsequent transitions using the same patterns:
+
+```yaml
+# In a later transition
+- tool: createChatMessage
+  args:
+    content: '{{ metadata.tools.create_some_data.say_hello.data }}'
+```
+
+#### 4. Using Helper Functions
+
+Define custom helper functions in your workflow class for complex data extraction:
+
+```typescript
+@Helper()
+extractMessage(metadata: WorkflowMetadataInterface): string {
+  return metadata.tools.create_some_data.say_hello.data;
+}
+```
+
+Then use them in your YAML configuration:
+
+```yaml
+- tool: createChatMessage
+  args:
+    content: '{{ extractMessage metadata }}'
+```
+
+## Dependencies
+
+This workflow uses the following Loopstack modules:
+
+- `@loopstack/core` - Core framework functionality
+- `@loopstack/core-ui-module` - Provides `CreateChatMessage` tool
+- `@loopstack/create-value-tool` - Provides `CreateValue` tool
+
+## About
+
+Author: [Jakob Klippel](https://www.linkedin.com/in/jakob-klippel/)
+
+License: Apache-2.0
+
+### Additional Resources
+
+- [Loopstack Documentation](https://loopstack.ai/docs)
+- [Getting Started with Loopstack](https://loopstack.ai/docs/getting-started)
+- Find more Loopstack examples in the [Loopstack Registry](https://loopstack.ai/registry)

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './workflow-tool-results.workflow';
+export * from './tool-results-example.module';

package/dist/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./workflow-tool-results.workflow"), exports);
+__exportStar(require("./tool-results-example.module"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mEAAiD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mEAAiD;AACjD,gEAA8C"}

package/dist/tool-results-example.module.d.ts

@@ -0,0 +1,2 @@
+export declare class ToolResultsExampleModule {
+}

package/dist/tool-results-example.module.js

@@ -0,0 +1,26 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolResultsExampleModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@loopstack/core");
+const core_ui_module_1 = require("@loopstack/core-ui-module");
+const create_chat_message_tool_1 = require("@loopstack/create-chat-message-tool");
+const create_value_tool_1 = require("@loopstack/create-value-tool");
+const workflow_tool_results_workflow_1 = require("./workflow-tool-results.workflow");
+let ToolResultsExampleModule = class ToolResultsExampleModule {
+};
+exports.ToolResultsExampleModule = ToolResultsExampleModule;
+exports.ToolResultsExampleModule = ToolResultsExampleModule = __decorate([
+    (0, common_1.Module)({
+        imports: [core_1.LoopCoreModule, core_ui_module_1.CoreUiModule, create_value_tool_1.CreateValueToolModule, create_chat_message_tool_1.CreateChatMessageToolModule],
+        providers: [workflow_tool_results_workflow_1.WorkflowToolResultsWorkflow],
+        exports: [workflow_tool_results_workflow_1.WorkflowToolResultsWorkflow],
+    })
+], ToolResultsExampleModule);
+//# sourceMappingURL=tool-results-example.module.js.map

package/dist/tool-results-example.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-results-example.module.js","sourceRoot":"","sources":["../src/tool-results-example.module.ts"],"names":[],"mappings":";;;;;;;;;AAeA,2CAAwC;AACxC,0CAAiD;AACjD,8DAAyD;AACzD,kFAAkF;AAClF,oEAAqE;AACrE,qFAA+E;AAOxE,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;CAAG,CAAA;AAA3B,4DAAwB;mCAAxB,wBAAwB;IALpC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,qBAAc,EAAE,6BAAY,EAAE,yCAAqB,EAAE,sDAA2B,CAAC;QAC3F,SAAS,EAAE,CAAC,4DAA2B,CAAC;QACxC,OAAO,EAAE,CAAC,4DAA2B,CAAC;KACvC,CAAC;GACW,wBAAwB,CAAG"}

package/dist/workflow-tool-results.workflow.js

@@ -10,36 +10,37 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowToolResultsWorkflow = void 0;
+const common_1 = require("@nestjs/common");
+const common_2 = require("@loopstack/common");
 const core_1 = require("@loopstack/core");
-const common_1 = require("@loopstack/common");
-const common_2 = require("@nestjs/common");
-const core_ui_module_1 = require("@loopstack/core-ui-module");
+const create_chat_message_tool_1 = require("@loopstack/create-chat-message-tool");
 const create_value_tool_1 = require("@loopstack/create-value-tool");
 let WorkflowToolResultsWorkflow = class WorkflowToolResultsWorkflow extends core_1.WorkflowBase {
     createValue;
     createChatMessage;
     extractMessage(metadata) {
-        return metadata.tools.create_some_data.say_hello.data;
+        const tools = metadata.tools;
+        return tools.create_some_data.say_hello.data;
     }
 };
 exports.WorkflowToolResultsWorkflow = WorkflowToolResultsWorkflow;
 __decorate([
-    (0, common_1.Tool)(),
+    (0, common_2.Tool)(),
     __metadata("design:type", create_value_tool_1.CreateValue)
 ], WorkflowToolResultsWorkflow.prototype, "createValue", void 0);
 __decorate([
-    (0, common_1.Tool)(),
-    __metadata("design:type", core_ui_module_1.CreateChatMessage)
+    (0, common_2.Tool)(),
+    __metadata("design:type", create_chat_message_tool_1.CreateChatMessage)
 ], WorkflowToolResultsWorkflow.prototype, "createChatMessage", void 0);
 __decorate([
-    (0, common_1.Helper)(),
+    (0, common_2.Helper)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", String)
 ], WorkflowToolResultsWorkflow.prototype, "extractMessage", null);
 exports.WorkflowToolResultsWorkflow = WorkflowToolResultsWorkflow = __decorate([
-    (0, common_2.Injectable)(),
-    (0, common_1.BlockConfig)({
+    (0, common_1.Injectable)(),
+    (0, common_2.BlockConfig)({
         configFile: __dirname + '/workflow-tool-results.workflow.yaml',
     })
 ], WorkflowToolResultsWorkflow);

package/dist/workflow-tool-results.workflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-tool-results.workflow.js","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAA+C;AAC/C,8CAA8D;AAC9D,2CAA4C;AAE5C,8DAA8D;AAC9D,oEAA2D;AAMpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,mBAAY;IAC3C,WAAW,CAAc;IACzB,iBAAiB,CAAoB;IAGrD,cAAc,CAAC,QAAmC;QAChD,OAAO,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC;IACxD,CAAC;CACF,CAAA;AARY,kEAA2B;AACtB;IAAf,IAAA,aAAI,GAAE;8BAAsB,+BAAW;gEAAC;AACzB;IAAf,IAAA,aAAI,GAAE;8BAA4B,kCAAiB;sEAAC;AAGrD;IADC,IAAA,eAAM,GAAE;;;;iEAGR;sCAPU,2BAA2B;IAJvC,IAAA,mBAAU,GAAE;IACZ,IAAA,oBAAW,EAAC;QACX,UAAU,EAAE,SAAS,GAAG,sCAAsC;KAC/D,CAAC;GACW,2BAA2B,CAQvC"}
+{"version":3,"file":"workflow-tool-results.workflow.js","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,8CAA8D;AAC9D,0CAA+C;AAE/C,kFAAwE;AACxE,oEAA2D;AAcpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,mBAAY;IAC3C,WAAW,CAAc;IACzB,iBAAiB,CAAoB;IAGrD,cAAc,CAAC,QAAmC;QAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAyC,CAAC;QACjE,OAAO,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC;IAC/C,CAAC;CACF,CAAA;AATY,kEAA2B;AACtB;IAAf,IAAA,aAAI,GAAE;8BAAsB,+BAAW;gEAAC;AACzB;IAAf,IAAA,aAAI,GAAE;8BAA4B,4CAAiB;sEAAC;AAGrD;IADC,IAAA,eAAM,GAAE;;;;iEAIR;sCARU,2BAA2B;IAJvC,IAAA,mBAAU,GAAE;IACZ,IAAA,oBAAW,EAAC;QACX,UAAU,EAAE,SAAS,GAAG,sCAAsC;KAC/D,CAAC;GACW,2BAA2B,CASvC"}

package/dist/workflow-tool-results.workflow.yaml

@@ -1,11 +1,10 @@
-title: "Workflow Tool Result"
+title: 'Workflow Tool Result'
 
 transitions:
   - id: create_some_data
     from: start
     to: data_created
     call:
-
       # Create test data and return it in the tool result
       - id: say_hello
         tool: createValue
@@ -16,27 +15,26 @@ transitions:
       - tool: createChatMessage
         args:
           role: 'assistant'
-          content: "Data from specific call id: {{ metadata.tools.create_some_data.say_hello.data }}"
+          content: 'Data from specific call id: {{ metadata.tools.create_some_data.say_hello.data }}'
 
       # Access the data using the call index
       - tool: createChatMessage
         args:
           role: 'assistant'
-          content: "Data from first tool call: {{ metadata.tools.create_some_data.0.data }}"
+          content: 'Data from first tool call: {{ metadata.tools.create_some_data.0.data }}'
 
   - id: access_data
     from: data_created
     to: end
     call:
-
       # Access the data from a previous transition using transition and call id
       - tool: createChatMessage
         args:
           role: 'assistant'
-          content: "Data from previous transition: {{ metadata.tools.create_some_data.say_hello.data }}"
+          content: 'Data from previous transition: {{ metadata.tools.create_some_data.say_hello.data }}'
 
       # Access the data using a custom helper function of the workflow
       - tool: createChatMessage
         args:
           role: 'assistant'
-          content: "Data access using custom helper: {{ extractMessage metadata }}"
+          content: 'Data access using custom helper: {{ extractMessage metadata }}'

package/package.json

@@ -2,7 +2,7 @@
   "name": "@loopstack/accessing-tool-results-example-workflow",
   "displayName": "Loopstack Tool Results Example",
   "description": "A simple workflow showing different methods of how to access tool results in a subsequent workflow step.",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "author": {
     "name": "Jakob Klippel",
     "url": "https://www.linkedin.com/in/jakob-klippel/"
@@ -18,46 +18,31 @@
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./src/*": "./src/*"
+  },
   "scripts": {
     "build": "nest build",
-    "watch": "nest build --watch",
     "compile": "tsc --noEmit",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "test": "jest --passWithNoTests",
+    "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/common": "^0.16.0",
-    "@loopstack/core": "^0.16.0",
-    "@loopstack/core-ui-module": "^0.16.0",
-    "@loopstack/create-value-tool": "^0.16.0",
-    "@nestjs/common": "^11.0.12",
-    "zod": "^3.24.1"
-  },
-  "devDependencies": {
-    "@eslint/eslintrc": "^3.3.0",
-    "@eslint/js": "^9.22.0",
-    "@nestjs/cli": "^11.0.5",
-    "@nestjs/testing": "^11.0.12",
-    "@swc/cli": "^0.6.0",
-    "@swc/core": "^1.11.11",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.10",
-    "eslint": "^9.22.0",
-    "eslint-config-prettier": "^10.1.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "globals": "^16.0.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.5.3",
-    "ts-jest": "^29.2.6",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0"
+    "@loopstack/common": "^0.18.0",
+    "@loopstack/core": "^0.18.0",
+    "@loopstack/core-ui-module": "^0.18.0",
+    "@loopstack/create-chat-message-tool": "^0.18.0",
+    "@loopstack/create-value-tool": "^0.18.0",
+    "@nestjs/common": "^11.1.12",
+    "zod": "^4.3.5"
   },
+  "files": [
+    "dist",
+    "src"
+  ],
   "jest": {
     "moduleFileExtensions": [
       "js",
@@ -74,6 +59,8 @@
     ],
     "coverageDirectory": "../coverage",
     "testEnvironment": "node",
-    "maxWorkers": 1
+    "maxWorkers": 1,
+    "testTimeout": 10000,
+    "forceExit": true
   }
-}
+}

package/src/__tests__/workflow-tool-results.workflow.spec.ts

@@ -0,0 +1,118 @@
+import { TestingModule } from '@nestjs/testing';
+import { BlockExecutionContextDto, LoopCoreModule, WorkflowProcessorService } from '@loopstack/core';
+import { CoreUiModule } from '@loopstack/core-ui-module';
+import { CreateChatMessage, CreateChatMessageToolModule } from '@loopstack/create-chat-message-tool';
+import { CreateValue, CreateValueToolModule } from '@loopstack/create-value-tool';
+import { ToolMock, createWorkflowTest } from '@loopstack/testing';
+import { WorkflowToolResultsWorkflow } from '../workflow-tool-results.workflow';
+
+describe('WorkflowToolResultsWorkflow', () => {
+  let module: TestingModule;
+  let workflow: WorkflowToolResultsWorkflow;
+  let processor: WorkflowProcessorService;
+
+  let mockCreateValue: ToolMock;
+  let mockCreateChatMessage: ToolMock;
+
+  beforeEach(async () => {
+    module = await createWorkflowTest()
+      .forWorkflow(WorkflowToolResultsWorkflow)
+      .withImports(LoopCoreModule, CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule)
+      .withToolOverride(CreateValue)
+      .withToolOverride(CreateChatMessage)
+      .compile();
+
+    workflow = module.get(WorkflowToolResultsWorkflow);
+    processor = module.get(WorkflowProcessorService);
+
+    mockCreateValue = module.get(CreateValue);
+    mockCreateChatMessage = module.get(CreateChatMessage);
+  });
+
+  afterEach(async () => {
+    await module.close();
+  });
+
+  it('should be defined', () => {
+    expect(workflow).toBeDefined();
+  });
+
+  it('should have extractMessage helper', () => {
+    expect(workflow.helpers).toContain('extractMessage');
+  });
+
+  describe('tool result access', () => {
+    it('should access tool results by call id and index in same transition', async () => {
+      const context = new BlockExecutionContextDto({});
+      mockCreateValue.execute.mockResolvedValue({ data: 'Hello World.' });
+      mockCreateChatMessage.execute.mockResolvedValue({ data: undefined });
+
+      await processor.process(workflow, {}, context);
+
+      // Verify CreateValue was called
+      expect(mockCreateValue.execute).toHaveBeenCalledWith(
+        { input: 'Hello World.' },
+        expect.anything(),
+        expect.anything(),
+      );
+
+      // Verify CreateChatMessage received resolved template values
+      expect(mockCreateChatMessage.execute).toHaveBeenCalledWith(
+        {
+          role: 'assistant',
+          content: 'Data from specific call id: Hello World.',
+        },
+        expect.anything(),
+        expect.anything(),
+      );
+
+      expect(mockCreateChatMessage.execute).toHaveBeenCalledWith(
+        {
+          role: 'assistant',
+          content: 'Data from first tool call: Hello World.',
+        },
+        expect.anything(),
+        expect.anything(),
+      );
+    });
+
+    it('should access tool results from previous transition', async () => {
+      const context = new BlockExecutionContextDto({});
+      mockCreateValue.execute.mockResolvedValue({ data: 'Hello World.' });
+      mockCreateChatMessage.execute.mockResolvedValue({ data: undefined });
+
+      const result = await processor.process(workflow, {}, context);
+
+      // Should complete both transitions
+      const history = result.state.caretaker.getHistory();
+      expect(history.some((h) => h.metadata.transition?.transition === 'create_some_data')).toBe(true);
+      expect(history.some((h) => h.metadata.transition?.transition === 'access_data')).toBe(true);
+
+      expect(mockCreateChatMessage.execute).toHaveBeenCalledWith(
+        {
+          role: 'assistant',
+          content: 'Data from previous transition: Hello World.',
+        },
+        expect.anything(),
+        expect.anything(),
+      );
+    });
+
+    it('should access tool results using custom helper', async () => {
+      const context = new BlockExecutionContextDto({});
+      mockCreateValue.execute.mockResolvedValue({ data: 'Hello World.' });
+      mockCreateChatMessage.execute.mockResolvedValue({ data: undefined });
+
+      await processor.process(workflow, {}, context);
+
+      expect(mockCreateChatMessage.execute).toHaveBeenCalledWith(
+        {
+          role: 'assistant',
+          content: 'Data access using custom helper: Hello World.',
+        },
+        expect.anything(),
+        expect.anything(),
+      );
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './workflow-tool-results.workflow';
+export * from './tool-results-example.module';

package/src/tool-results-example.module.ts

@@ -0,0 +1,28 @@
+/*
+Copyright 2025 Jakob Klippel.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import { Module } from '@nestjs/common';
+import { LoopCoreModule } from '@loopstack/core';
+import { CoreUiModule } from '@loopstack/core-ui-module';
+import { CreateChatMessageToolModule } from '@loopstack/create-chat-message-tool';
+import { CreateValueToolModule } from '@loopstack/create-value-tool';
+import { WorkflowToolResultsWorkflow } from './workflow-tool-results.workflow';
+
+@Module({
+  imports: [LoopCoreModule, CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule],
+  providers: [WorkflowToolResultsWorkflow],
+  exports: [WorkflowToolResultsWorkflow],
+})
+export class ToolResultsExampleModule {}

package/src/workflow-tool-results.workflow.ts

@@ -0,0 +1,29 @@
+import { Injectable } from '@nestjs/common';
+import { BlockConfig, Helper, Tool } from '@loopstack/common';
+import { WorkflowBase } from '@loopstack/core';
+import { WorkflowMetadataInterface } from '@loopstack/core/dist/workflow-processor/interfaces/workflow-metadata.interface';
+import { CreateChatMessage } from '@loopstack/create-chat-message-tool';
+import { CreateValue } from '@loopstack/create-value-tool';
+
+interface WorkflowToolsMetadata {
+  create_some_data: {
+    say_hello: {
+      data: string;
+    };
+  };
+}
+
+@Injectable()
+@BlockConfig({
+  configFile: __dirname + '/workflow-tool-results.workflow.yaml',
+})
+export class WorkflowToolResultsWorkflow extends WorkflowBase {
+  @Tool() private createValue: CreateValue;
+  @Tool() private createChatMessage: CreateChatMessage;
+
+  @Helper()
+  extractMessage(metadata: WorkflowMetadataInterface): string {
+    const tools = metadata.tools as unknown as WorkflowToolsMetadata;
+    return tools.create_some_data.say_hello.data;
+  }
+}

package/src/workflow-tool-results.workflow.yaml

@@ -0,0 +1,40 @@
+title: 'Workflow Tool Result'
+
+transitions:
+  - id: create_some_data
+    from: start
+    to: data_created
+    call:
+      # Create test data and return it in the tool result
+      - id: say_hello
+        tool: createValue
+        args:
+          input: 'Hello World.'
+
+      # Access the data using the call id as identifier
+      - tool: createChatMessage
+        args:
+          role: 'assistant'
+          content: 'Data from specific call id: {{ metadata.tools.create_some_data.say_hello.data }}'
+
+      # Access the data using the call index
+      - tool: createChatMessage
+        args:
+          role: 'assistant'
+          content: 'Data from first tool call: {{ metadata.tools.create_some_data.0.data }}'
+
+  - id: access_data
+    from: data_created
+    to: end
+    call:
+      # Access the data from a previous transition using transition and call id
+      - tool: createChatMessage
+        args:
+          role: 'assistant'
+          content: 'Data from previous transition: {{ metadata.tools.create_some_data.say_hello.data }}'
+
+      # Access the data using a custom helper function of the workflow
+      - tool: createChatMessage
+        args:
+          role: 'assistant'
+          content: 'Data access using custom helper: {{ extractMessage metadata }}'

package/LICENSE

@@ -1,19 +0,0 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-Copyright 2025 Loopstack GmbH
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this skeleton application except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.