@loopstack/create-chat-message-tool

A module for the Loopstack AI automation framework.

This module provides a tool for creating chat messages within workflows, enabling conversational interfaces and message-based interactions.

Overview

The Create Chat Message Tool enables workflows to generate chat messages programmatically. It supports creating single or multiple messages in one operation, making it ideal for building conversational workflows, chatbots, and interactive assistants.

By using this tool, you'll be able to:

• Create single or multiple chat messages in one operation
• Define message roles (user, assistant, system, etc.)
• Build conversational workflows with proper message formatting
• Display workflow responses in a chat-like interface
• Integrate seamlessly with AI-powered chat workflows

This tool is essential for workflows that need to communicate with users through a conversational interface or build AI-powered assistants.

Installation

Prerequisites

Create a new Loopstack project if you haven't already:

npx create-loopstack-app my-project
cd my-project

Start Environment

cd my-project
docker compose up -d

Install the Module

As Node Dependency via Npm:

npm install --save @loopstack/create-chat-message-tool

OR: Copy Sources via Loopstack CLI

loopstack add @loopstack/create-chat-message-tool

Setup

1. Import the Module

Add CreateChatMessageModule to your default.module.ts (included in the skeleton app) or to your own module:

import { Module } from '@nestjs/common';
import { LoopCoreModule } from '@loopstack/core';
import { CoreUiModule } from '@loopstack/core-ui-module';
import { DefaultWorkspace } from './default.workspace';
import { CreateChatMessageModule } from './create-chat-message-tool';

@Module({
  imports: [LoopCoreModule, CoreUiModule, CreateChatMessageModule],
  providers: [DefaultWorkspace],
})
export class DefaultModule {}

2. Use in Your Workflow

Inject the tool in your workflow class using the @Tool() decorator:

import { Injectable } from '@nestjs/common';
import { BlockConfig, Tool, WithState } from '@loopstack/common';
import { WorkflowBase } from '@loopstack/core';
import { CreateChatMessage } from './create-chat-message-tool';
import { z } from 'zod';

@Injectable()
@BlockConfig({
  configFile: __dirname + '/my.workflow.yaml',
})
export class MyWorkflow extends WorkflowBase {
  
  // Tools
  @Tool() createChatMessage: CreateChatMessage;
  
}

And use it in your YAML workflow configuration:

# src/my.workflow.yaml
transitions:
  - id: send_welcome
    from: start
    to: ready
    call:
      # Create a single message
      - tool: createChatMessage
        args:
          role: assistant
          content: |
            Hello! I'm your assistant. How can I help you today?

  - id: send_conversation
    from: ready
    to: complete
    call:
      # Create multiple messages at once
      - tool: createChatMessage
        args:
          - role: user
            content: What's the weather like?
          - role: assistant
            content: I'll check the weather for you right away.

About

Author: Jakob Klippel

License: Apache-2.0

Additional Resources:

• Loopstack Documentation
• Getting Started with Loopstack
• For more examples how to use this tool look for @loopstack/create-chat-message-tool in the Loopstack Registry