@atom8n/ai-workflow-builder 1.2.0

package/dist/tools/add-node.tool.d.ts

@@ -0,0 +1,54 @@
+import type { INodeTypeDescription } from 'n8n-workflow';
+import { z } from 'zod';
+import type { BuilderTool, BuilderToolBase } from '../utils/stream-processor';
+export declare const nodeCreationSchema: z.ZodObject<{
+    nodeType: z.ZodString;
+    nodeVersion: z.ZodNumber;
+    name: z.ZodString;
+    connectionParametersReasoning: z.ZodString;
+    connectionParameters: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    nodeType: string;
+    name: string;
+    nodeVersion: number;
+    connectionParametersReasoning: string;
+    connectionParameters: {} & {
+        [k: string]: unknown;
+    };
+}, {
+    nodeType: string;
+    name: string;
+    nodeVersion: number;
+    connectionParametersReasoning: string;
+    connectionParameters: {} & {
+        [k: string]: unknown;
+    };
+}>;
+export declare const nodeCreationE2ESchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    nodeType: z.ZodString;
+    nodeVersion: z.ZodNumber;
+    name: z.ZodString;
+    connectionParametersReasoning: z.ZodString;
+    connectionParameters: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    nodeType: string;
+    name: string;
+    nodeVersion: number;
+    connectionParametersReasoning: string;
+    connectionParameters: {} & {
+        [k: string]: unknown;
+    };
+    id?: string | undefined;
+}, {
+    nodeType: string;
+    name: string;
+    nodeVersion: number;
+    connectionParametersReasoning: string;
+    connectionParameters: {} & {
+        [k: string]: unknown;
+    };
+    id?: string | undefined;
+}>;
+export declare function getAddNodeToolBase(nodeTypes: INodeTypeDescription[]): BuilderToolBase;
+export declare function createAddNodeTool(nodeTypes: INodeTypeDescription[]): BuilderTool;

package/dist/tools/add-node.tool.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeCreationE2ESchema = exports.nodeCreationSchema = void 0;
+exports.getAddNodeToolBase = getAddNodeToolBase;
+exports.createAddNodeTool = createAddNodeTool;
+const tools_1 = require("@langchain/core/tools");
+const zod_1 = require("zod");
+const errors_1 = require("../errors");
+const node_creation_utils_1 = require("./utils/node-creation.utils");
+const node_positioning_utils_1 = require("./utils/node-positioning.utils");
+const node_helpers_1 = require("../utils/node-helpers");
+const progress_1 = require("./helpers/progress");
+const response_1 = require("./helpers/response");
+const state_1 = require("./helpers/state");
+const validation_1 = require("./helpers/validation");
+const baseSchema = {
+    nodeType: zod_1.z.string().describe('The type of node to add (e.g., n8n-nodes-base.httpRequest)'),
+    nodeVersion: zod_1.z.number().describe('The exact node version'),
+    name: zod_1.z
+        .string()
+        .describe('A descriptive name for the node that clearly indicates its purpose in the workflow'),
+    connectionParametersReasoning: zod_1.z
+        .string()
+        .describe('REQUIRED: Explain your reasoning about connection parameters. Consider: Does this node have dynamic inputs/outputs? Does it need mode/operation parameters? For example: "Vector Store has dynamic inputs based on mode, so I need to set mode:insert for document input" or "HTTP Request has static inputs, so no special parameters needed"'),
+    connectionParameters: zod_1.z
+        .object({})
+        .passthrough()
+        .describe('Parameters that affect node connections (e.g., mode: "insert" for Vector Store). Pass an empty object {} if no connection parameters are needed. Only connection-affecting parameters like mode, operation, resource, action, etc. are allowed.'),
+};
+exports.nodeCreationSchema = zod_1.z.object(baseSchema);
+exports.nodeCreationE2ESchema = zod_1.z.object({
+    ...baseSchema,
+    id: zod_1.z
+        .string()
+        .optional()
+        .describe('Optional: A specific ID to use for this node. If not provided, a unique ID will be generated automatically. This is primarily used for testing purposes to ensure deterministic node IDs.'),
+});
+function createNode(nodeType, typeVersion, customName, existingNodes, nodeTypes, connectionParameters, id) {
+    const baseName = customName ?? nodeType.defaults?.name ?? nodeType.displayName;
+    const uniqueName = (0, node_creation_utils_1.generateUniqueName)(baseName, existingNodes);
+    const position = (0, node_positioning_utils_1.calculateNodePosition)(existingNodes, (0, node_helpers_1.isSubNode)(nodeType), nodeTypes);
+    return (0, node_creation_utils_1.createNodeInstance)(nodeType, typeVersion, uniqueName, position, connectionParameters, id);
+}
+function buildResponseMessage(addedNode, nodeTypes) {
+    const nodeType = nodeTypes.find((nt) => nt.name === addedNode.type);
+    const nodeTypeInfo = nodeType && (0, node_helpers_1.isSubNode)(nodeType) ? ' (sub-node)' : '';
+    return `Successfully added "${addedNode.name}" (${addedNode.displayName ?? addedNode.type})${nodeTypeInfo} with ID ${addedNode.id}`;
+}
+function getCustomNodeTitle(input, nodeTypes) {
+    if ('nodeType' in input && typeof input['nodeType'] === 'string') {
+        const nodeType = nodeTypes.find((type) => type.name === input.nodeType);
+        if (nodeType) {
+            return `Adding ${nodeType.displayName} node`;
+        }
+    }
+    return 'Adding node';
+}
+function getAddNodeToolBase(nodeTypes) {
+    return {
+        toolName: 'add_nodes',
+        displayTitle: 'Adding nodes',
+        getCustomDisplayTitle: (input) => getCustomNodeTitle(input, nodeTypes),
+    };
+}
+function createAddNodeTool(nodeTypes) {
+    const builderToolBase = getAddNodeToolBase(nodeTypes);
+    const dynamicTool = (0, tools_1.tool)(async (input, config) => {
+        const reporter = (0, progress_1.createProgressReporter)(config, builderToolBase.toolName, builderToolBase.displayTitle, getCustomNodeTitle(input, nodeTypes));
+        try {
+            let id;
+            let validatedInput;
+            if (process.env.E2E_TESTS) {
+                const e2eInput = exports.nodeCreationE2ESchema.parse(input);
+                id = e2eInput.id;
+                validatedInput = e2eInput;
+            }
+            else {
+                validatedInput = exports.nodeCreationSchema.parse(input);
+            }
+            const { nodeType, nodeVersion, name, connectionParametersReasoning, connectionParameters } = validatedInput;
+            reporter.start(validatedInput);
+            const state = (0, state_1.getWorkflowState)();
+            const workflow = (0, state_1.getCurrentWorkflow)(state);
+            reporter.progress(`Adding ${name} (${connectionParametersReasoning})`);
+            const nodeTypeDesc = (0, validation_1.findNodeType)(nodeType, nodeVersion, nodeTypes);
+            if (!nodeTypeDesc) {
+                const nodeError = new errors_1.NodeTypeNotFoundError(nodeType);
+                const error = {
+                    message: nodeError.message,
+                    code: 'NODE_TYPE_NOT_FOUND',
+                    details: { nodeType },
+                };
+                reporter.error(error);
+                return (0, response_1.createErrorResponse)(config, error);
+            }
+            const newNode = createNode(nodeTypeDesc, nodeVersion, name, workflow.nodes, nodeTypes, connectionParameters, id);
+            const addedNodeInfo = {
+                id: newNode.id,
+                name: newNode.name,
+                type: newNode.type,
+                displayName: nodeTypeDesc.displayName,
+                position: newNode.position,
+                parameters: newNode.parameters,
+            };
+            const message = buildResponseMessage(addedNodeInfo, nodeTypes);
+            const output = {
+                addedNode: addedNodeInfo,
+                message,
+            };
+            reporter.complete(output);
+            const stateUpdates = (0, state_1.addNodeToWorkflow)(newNode);
+            return (0, response_1.createSuccessResponse)(config, message, stateUpdates);
+        }
+        catch (error) {
+            let toolError;
+            if (error instanceof zod_1.z.ZodError) {
+                const validationError = new errors_1.ValidationError('Invalid input parameters', {
+                    field: error.errors[0]?.path.join('.'),
+                    value: error.errors[0]?.message,
+                });
+                toolError = {
+                    message: validationError.message,
+                    code: 'VALIDATION_ERROR',
+                    details: error.errors,
+                };
+            }
+            else {
+                toolError = {
+                    message: error instanceof Error ? error.message : 'Unknown error occurred',
+                    code: 'EXECUTION_ERROR',
+                };
+            }
+            reporter.error(toolError);
+            return (0, response_1.createErrorResponse)(config, toolError);
+        }
+    }, {
+        name: builderToolBase.toolName,
+        description: `Add a node to the workflow canvas. Each node represents a specific action or operation (e.g., HTTP request, data transformation, database query). Always provide descriptive names that explain what the node does (e.g., "Get Customer Data", "Filter Active Users", "Send Email Notification"). The tool handles automatic positioning. Use this tool after searching for available node types to ensure they exist.
+
+To add multiple nodes, call this tool multiple times in parallel.
+
+CRITICAL: You MUST provide:
+1. connectionParametersReasoning - Explain why you're choosing specific connection parameters or using {}
+2. connectionParameters - The actual parameters (use {} for nodes without special needs)
+
+IMPORTANT: DO NOT rely on default values! Always explicitly set connection-affecting parameters when they exist.
+
+REASONING EXAMPLES:
+- "Vector Store has dynamic inputs that change based on mode parameter, setting mode:insert to accept document inputs"
+- "HTTP Request has static inputs/outputs, no connection parameters needed"
+- "Document Loader needs textSplittingMode:custom to accept text splitter connections"
+- "AI Agent has dynamic inputs, setting hasOutputParser:true to enable output parser connections"
+- "Set node has standard main connections only, using empty parameters"
+
+CONNECTION PARAMETERS (NEVER rely on defaults - always set explicitly):
+- AI Agent (@n8n/n8n-nodes-langchain.agent):
+  - For output parser support: { hasOutputParser: true }
+  - Without output parser: { hasOutputParser: false }
+- Vector Store (@n8n/n8n-nodes-langchain.vectorStoreInMemory):
+  - For document input: { mode: "insert" }
+  - For querying: { mode: "retrieve" }
+  - For AI Agent and tool use: { mode: "retrieve-as-tool" }
+- Document Loader (@n8n/n8n-nodes-langchain.documentDefaultDataLoader):
+  - For text splitter input: { textSplittingMode: "custom" }
+  - For built-in splitting: { textSplittingMode: "simple" }
+- Regular nodes (HTTP Request, Set, Code, etc.): {}
+
+Think through the connectionParametersReasoning FIRST, then set connectionParameters based on your reasoning. If a parameter affects connections, SET IT EXPLICITLY.`,
+        schema: exports.nodeCreationSchema,
+    });
+    return {
+        tool: dynamicTool,
+        ...builderToolBase,
+    };
+}
+//# sourceMappingURL=add-node.tool.js.map

package/dist/tools/add-node.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-node.tool.js","sourceRoot":"","sources":["../../src/tools/add-node.tool.ts"],"names":[],"mappings":";;;AAqGA,gDAMC;AAKD,8CAsJC;AAtQD,iDAA6C;AAE7C,6BAAwB;AAIxB,sCAAmE;AACnE,qEAAqF;AACrF,2EAAuE;AACvE,wDAAkD;AAClD,iDAA4D;AAC5D,iDAAgF;AAChF,2CAA0F;AAC1F,qDAAoD;AAIpD,MAAM,UAAU,GAAG;IAClB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4DAA4D,CAAC;IAC3F,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC1D,IAAI,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,CAAC,oFAAoF,CAAC;IAChG,6BAA6B,EAAE,OAAC;SAC9B,MAAM,EAAE;SACR,QAAQ,CACR,gVAAgV,CAChV;IACF,oBAAoB,EAAE,OAAC;SACrB,MAAM,CAAC,EAAE,CAAC;SACV,WAAW,EAAE;SACb,QAAQ,CACR,iPAAiP,CACjP;CACF,CAAC;AAKW,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAK1C,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,GAAG,UAAU;IACb,EAAE,EAAE,OAAC;SACH,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACR,2LAA2L,CAC3L;CACF,CAAC,CAAC;AAKH,SAAS,UAAU,CAClB,QAA8B,EAC9B,WAAmB,EACnB,UAAkB,EAClB,aAAsB,EACtB,SAAiC,EACjC,oBAAsC,EACtC,EAAW;IAGX,MAAM,QAAQ,GAAG,UAAU,IAAI,QAAQ,CAAC,QAAQ,EAAE,IAAI,IAAI,QAAQ,CAAC,WAAW,CAAC;IAC/E,MAAM,UAAU,GAAG,IAAA,wCAAkB,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAG/D,MAAM,QAAQ,GAAG,IAAA,8CAAqB,EAAC,aAAa,EAAE,IAAA,wBAAS,EAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;IAGtF,OAAO,IAAA,wCAAkB,EAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,CAAC,CAAC;AAClG,CAAC;AAKD,SAAS,oBAAoB,CAAC,SAAoB,EAAE,SAAiC;IACpF,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,YAAY,GAAG,QAAQ,IAAI,IAAA,wBAAS,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,OAAO,uBAAuB,SAAS,CAAC,IAAI,MAAM,SAAS,CAAC,WAAW,IAAI,SAAS,CAAC,IAAI,IAAI,YAAY,YAAY,SAAS,CAAC,EAAE,EAAE,CAAC;AACrI,CAAC;AAED,SAAS,kBAAkB,CAC1B,KAA8B,EAC9B,SAAiC;IAEjC,IAAI,UAAU,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;QAClE,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxE,IAAI,QAAQ,EAAE,CAAC;YACd,OAAO,UAAU,QAAQ,CAAC,WAAW,OAAO,CAAC;QAC9C,CAAC;IACF,CAAC;IAGD,OAAO,aAAa,CAAC;AACtB,CAAC;AAED,SAAgB,kBAAkB,CAAC,SAAiC;IACnE,OAAO;QACN,QAAQ,EAAE,WAAW;QACrB,YAAY,EAAE,cAAc;QAC5B,qBAAqB,EAAE,CAAC,KAA8B,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC;KAC/F,CAAC;AACH,CAAC;AAKD,SAAgB,iBAAiB,CAAC,SAAiC;IAClE,MAAM,eAAe,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,IAAA,YAAI,EACvB,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,IAAA,iCAAsB,EACtC,MAAM,EACN,eAAe,CAAC,QAAQ,EACxB,eAAe,CAAC,YAAY,EAC5B,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CACpC,CAAC;QAEF,IAAI,CAAC;YAEJ,IAAI,EAAsB,CAAC;YAC3B,IAAI,cAAkD,CAAC;YAEvD,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;gBAC3B,MAAM,QAAQ,GAAG,6BAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpD,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;gBACjB,cAAc,GAAG,QAAQ,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACP,cAAc,GAAG,0BAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,GACzF,cAAc,CAAC;YAGhB,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAG/B,MAAM,KAAK,GAAG,IAAA,wBAAgB,GAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAA,0BAAkB,EAAC,KAAK,CAAC,CAAC;YAG3C,QAAQ,CAAC,QAAQ,CAAC,UAAU,IAAI,KAAK,6BAA6B,GAAG,CAAC,CAAC;YAGvE,MAAM,YAAY,GAAG,IAAA,yBAAY,EAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;YACpE,IAAI,CAAC,YAAY,EAAE,CAAC;gBACnB,MAAM,SAAS,GAAG,IAAI,8BAAqB,CAAC,QAAQ,CAAC,CAAC;gBACtD,MAAM,KAAK,GAAG;oBACb,OAAO,EAAE,SAAS,CAAC,OAAO;oBAC1B,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EAAE,EAAE,QAAQ,EAAE;iBACrB,CAAC;gBACF,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACtB,OAAO,IAAA,8BAAmB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC3C,CAAC;YAGD,MAAM,OAAO,GAAG,UAAU,CACzB,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,QAAQ,CAAC,KAAK,EACd,SAAS,EACT,oBAAuC,EACvC,EAAE,CACF,CAAC;YAGF,MAAM,aAAa,GAAc;gBAChC,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,WAAW,EAAE,YAAY,CAAC,WAAW;gBACrC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;aAC9B,CAAC;YAGF,MAAM,OAAO,GAAG,oBAAoB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAG/D,MAAM,MAAM,GAAkB;gBAC7B,SAAS,EAAE,aAAa;gBACxB,OAAO;aACP,CAAC;YACF,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAG1B,MAAM,YAAY,GAAG,IAAA,yBAAiB,EAAC,OAAO,CAAC,CAAC;YAChD,OAAO,IAAA,gCAAqB,EAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAEhB,IAAI,SAAoB,CAAC;YAEzB,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;gBACjC,MAAM,eAAe,GAAG,IAAI,wBAAe,CAAC,0BAA0B,EAAE;oBACvE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;oBACtC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO;iBAC/B,CAAC,CAAC;gBACH,SAAS,GAAG;oBACX,OAAO,EAAE,eAAe,CAAC,OAAO;oBAChC,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,KAAK,CAAC,MAAM;iBACrB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,SAAS,GAAG;oBACX,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;oBAC1E,IAAI,EAAE,iBAAiB;iBACvB,CAAC;YACH,CAAC;YAED,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC1B,OAAO,IAAA,8BAAmB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC,EACD;QACC,IAAI,EAAE,eAAe,CAAC,QAAQ;QAC9B,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qKA8BqJ;QAClK,MAAM,EAAE,0BAAkB;KAC1B,CACD,CAAC;IAEF,OAAO;QACN,IAAI,EAAE,WAAW;QACjB,GAAG,eAAe;KAClB,CAAC;AACH,CAAC"}

package/dist/tools/best-practices/chatbot.d.ts

@@ -0,0 +1,7 @@
+import type { BestPracticesDocument } from '../../types/best-practices';
+export declare class ChatbotBestPractices implements BestPracticesDocument {
+    readonly technique: "chatbot";
+    readonly version = "1.0.0";
+    private readonly documentation;
+    getDocumentation(): string;
+}

package/dist/tools/best-practices/chatbot.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatbotBestPractices = void 0;
+const categorization_1 = require("../../types/categorization");
+class ChatbotBestPractices {
+    technique = categorization_1.WorkflowTechnique.CHATBOT;
+    version = '1.0.0';
+    documentation = `# Best Practices: Chatbot Workflows
+
+## Workflow Design
+
+Break chatbot logic into manageable steps and use error handling nodes (IF, Switch) with fallback mechanisms to manage unexpected inputs.
+
+Most chatbots run through external platforms like Slack, Telegram, or WhatsApp rather than through the n8n chat interface - if the user requests a service like this don't use the built in chat interface nodes. But, the n8n chat node is easier to get started with tests. If the user mentions chatting but does not mention a service then use the built in n8n chat node.
+
+CRITICAL: The user may ask to be able to chat to a workflow as well as trigger it via some other method, for example scheduling information gathering but also being able to chat with the agent - in scenarios like this the two separate workflows MUST be connected through shared memory, vector stores, data storage, or direct connections.
+
+Example pattern:
+- Schedule Trigger → News Gathering Agent → [memory node via ai_memory]
+- Chat Trigger → Chatbot Agent → [SAME memory node via ai_memory]
+- Result: Both agents share conversation/context history, enabling the chatbot to discuss gathered news
+
+For the chatbot always use the same chat node type as used for response. If Telegram has been requested trigger the chatbot via telegram AND
+respond via telegram - do not mix chatbot interfaces.
+
+## Context & Memory Management
+
+Always utilise memory in chatbot agent nodes - providing context gives you full conversation history and more control over context.
+Memory nodes enable the bot to handle follow-up questions by maintaining short-term conversation history.
+
+Include information with the user prompt such as timestamp, user ID, or session metadata. This enriches context without relying solely on memory and user prompt.
+
+If there are other agents involved in the workflow you should share memory between the chatbot and those other agents where it makes sense.
+Connect the same memory node to multiple agents to enable data sharing and context continuity.
+
+## Context Engineering & AI Agent Output
+
+It can be beneficial to respond to the user as a tool of the chatbot agent rather than using the agent output - this allows the agent to loop/carry out multiple responses if necessary.
+This will require adding a note to the system prompt for the agent to tell it to use the tool to respond to the user.
+
+## Message Attribution
+
+n8n chatbots often attach the attribution "n8n workflow" to messages by default - you must disable this setting which will
+often be called "Append n8n Attribution" for nodes that support it, add this setting and set it to false.
+
+## Recommended Nodes
+
+### Chat Trigger (@n8n/n8n-nodes-langchain.chatTrigger)
+
+Purpose: Entry point for user messages in n8n-hosted chat interfaces
+
+Pitfalls:
+
+- Most production chatbots use external platforms (Slack, Telegram) rather than n8n's chat interface
+
+### AI Agent (@n8n/n8n-nodes-langchain.agent)
+
+Purpose: Orchestrates logic, tool use, and LLM calls for intelligent responses.
+
+Unless user asks for a node by name, always use the AI Agent node over provider-specific nodes (like OpenAI, Google Gemini) or use-case-specific AI nodes (like Message a model) for chatbot workflows. The AI Agent node provides better orchestration, tool integration, and memory management capabilities essential for conversational interfaces.
+For example, for "create a chatbot using OpenAI", implement: AI Agent -- OpenAI Chat Model.
+
+### Chat Model Nodes
+
+- OpenAI Chat Model (@n8n/n8n-nodes-langchain.lmChatOpenAi)
+- Google Gemini Chat Model (@n8n/n8n-nodes-langchain.lmChatGoogleGemini)
+- xAI Grok Chat Model (@n8n/n8n-nodes-langchain.lmChatXAiGrok)
+- DeepSeek Chat Model (@n8n/n8n-nodes-langchain.lmChatDeepSeek)
+
+Purpose: Connect to LLMs for natural, context-aware responses
+
+### Simple Memory (@n8n/n8n-nodes-langchain.memoryBufferWindow)
+
+Purpose: Maintains short-term conversation history for context continuity
+
+### HTTP Request (n8n-nodes-base.httpRequest)
+
+Purpose: Fetches external data to enrich chatbot responses with real-time or organizational information
+
+### Database Nodes & Google Sheets
+
+- Data Table (n8n-nodes-base.dataTable)
+- Postgres (n8n-nodes-base.postgres)
+- MySQL (n8n-nodes-base.mySql)
+- MongoDB (n8n-nodes-base.mongoDb)
+- Google Sheets (n8n-nodes-base.googleSheets)
+
+Purpose: Store conversation logs, retrieve structured data, or maintain user preferences
+
+### IF / Switch
+
+- If (n8n-nodes-base.if)
+- Switch (n8n-nodes-base.switch)
+
+Purpose: Conditional logic and error handling for routing messages or managing conversation state
+
+### Integration Nodes
+
+- Slack (n8n-nodes-base.slack)
+- Telegram (n8n-nodes-base.telegram)
+- WhatsApp Business Cloud (n8n-nodes-base.whatsApp)
+- Discord (n8n-nodes-base.discord)
+
+Purpose: Multi-channel support for deploying chatbots on popular messaging platforms
+
+## Common Pitfalls to Avoid
+
+### Leaving Chatbot Disconnected
+
+When a workflow has multiple triggers (e.g., scheduled data collection + chatbot interaction), the chatbot MUST have access to the data
+generated by the workflow. Connect the chatbot through shared memory, vector stores, data storage, or direct data flow connections.
+`;
+    getDocumentation() {
+        return this.documentation;
+    }
+}
+exports.ChatbotBestPractices = ChatbotBestPractices;
+//# sourceMappingURL=chatbot.js.map

package/dist/tools/best-practices/chatbot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatbot.js","sourceRoot":"","sources":["../../../src/tools/best-practices/chatbot.ts"],"names":[],"mappings":";;;AACA,2DAA2D;AAE3D,MAAa,oBAAoB;IACvB,SAAS,GAAG,kCAAiB,CAAC,OAAO,CAAC;IACtC,OAAO,GAAG,OAAO,CAAC;IAEV,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwGjC,CAAC;IAED,gBAAgB;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;CACD;AAjHD,oDAiHC"}

package/dist/tools/best-practices/content-generation.d.ts

@@ -0,0 +1,7 @@
+import type { BestPracticesDocument } from '../../types/best-practices';
+export declare class ContentGenerationBestPractices implements BestPracticesDocument {
+    readonly technique: "content_generation";
+    readonly version = "1.0.0";
+    private readonly documentation;
+    getDocumentation(): string;
+}

package/dist/tools/best-practices/content-generation.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentGenerationBestPractices = void 0;
+const categorization_1 = require("../../types/categorization");
+class ContentGenerationBestPractices {
+    technique = categorization_1.WorkflowTechnique.CONTENT_GENERATION;
+    version = '1.0.0';
+    documentation = `# Best Practices: Content Generation Workflows
+
+## Workflow Design
+
+Break complex tasks into sequential steps (e.g., generate text, create image, compose video) for modularity and easier troubleshooting.
+
+## Node Selection Guidelines
+
+Always prefer built-in n8n nodes over HTTP Request nodes when a dedicated node exists for the service or API you need to integrate with. Built-in nodes provide:
+- Pre-configured authentication handling
+- Optimized data structures and field mappings
+- Better error handling and user experience
+- Simplified setup without manual API configuration
+
+Only use HTTP Request nodes when no built-in node exists for the service, or when you need to access an API endpoint not covered by the built-in node's operations.
+
+## Multi-Modal Content Generation - MANDATORY
+
+When the user's request involves specific generative AI models or media-focused platforms, the workflow MUST include the appropriate media generation node from a
+provider-specific node. The finished workflow MUST contain the relevant video, audio, or image generation capability.
+
+Prompts that require multi-modal generation nodes:
+
+Video Generation:
+- Model mentions: Sora, Nano Banana, Veo, Runway, Pika
+- Platform mentions: YouTube content, TikTok videos, Instagram Reels, video ads, short-form video
+- Task mentions: generate video, create video, video from text, animate
+
+Image Generation:
+- Model mentions: DALL-E, Midjourney, Stable Diffusion, Imagen
+- Platform mentions: thumbnails, social media graphics, product images, marketing visuals
+- Task mentions: generate image, create artwork, design graphic, visualize
+
+Audio Generation:
+- Model mentions: ElevenLabs, text-to-speech, TTS
+- Platform mentions: podcast audio, voiceovers, narration, audio content
+- Task mentions: generate voice, create audio, synthesize speech, clone voice
+
+If anything like the examples above are mentioned in the prompt, include the appropriate
+provider node (OpenAI for DALL-E/Sora, Google Gemini for Nano Banana/Imagen, etc.)
+with the media generation operation configured.
+
+## Content-Specific Guidance
+
+For text generation, validate and sanitize input/output to avoid malformed data. When generating images, prefer binary data over URLs for uploads to avoid media type errors.
+
+## Recommended Nodes
+
+### OpenAI (@n8n/n8n-nodes-langchain.openAi)
+
+Purpose: GPT-based text generation, DALL-E image generation, text-to-speech (TTS), and audio transcription, SORA for video generation
+
+### xAI Grok Chat Model (@n8n/n8n-nodes-langchain.lmChatXAiGrok)
+
+Purpose: Conversational AI and text generation
+
+### Google Gemini Chat Model (@n8n/n8n-nodes-langchain.lmChatGoogleGemini)
+
+Purpose: Image analysis and generation, video generation from text prompts using nano banana, multimodal content creation
+
+### ElevenLabs
+
+Purpose: Natural-sounding AI voice generation
+
+Note: Use HTTP Request node or a community node to integrate with ElevenLabs API
+
+### HTTP Request (n8n-nodes-base.httpRequest)
+
+Purpose: Integrating with other LLM and content generation APIs (e.g., Jasper, Writesonic, Anthropic, HuggingFace)
+
+### Edit Image (n8n-nodes-base.editImage)
+
+Purpose: Manipulating images - resize, crop, rotate, and format conversion
+
+Pitfalls:
+
+- Ensure input is valid binary image data
+- Check output format compatibility with downstream nodes
+
+### Markdown (n8n-nodes-base.markdown)
+
+Purpose: Formatting and converting text to HTML or Markdown reports
+
+### Facebook Graph API (n8n-nodes-base.facebookGraphApi)
+
+Purpose: Uploading videos and images to Instagram and Facebook
+
+Pitfalls:
+
+- Use binary data fields rather than URLs for media uploads to prevent "media type" errors
+- Verify page IDs and access tokens have correct permissions
+
+### Wait (n8n-nodes-base.wait)
+
+Purpose: Handling delays in video processing/uploading and respecting API rate limits
+
+## Common Pitfalls to Avoid
+
+Binary Data Handling: For media uploads, use binary fields rather than URLs to prevent "media type" errors, especially with Facebook and Instagram APIs. Download media to binary data first, then upload from binary rather than passing URLs.
+
+Async Processing: For long-running content generation tasks (especially video), implement proper wait/polling mechanisms. Don't assume instant completion - many AI services process requests asynchronously.
+`;
+    getDocumentation() {
+        return this.documentation;
+    }
+}
+exports.ContentGenerationBestPractices = ContentGenerationBestPractices;
+//# sourceMappingURL=content-generation.js.map

package/dist/tools/best-practices/content-generation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-generation.js","sourceRoot":"","sources":["../../../src/tools/best-practices/content-generation.ts"],"names":[],"mappings":";;;AACA,2DAA2D;AAE3D,MAAa,8BAA8B;IACjC,SAAS,GAAG,kCAAiB,CAAC,kBAAkB,CAAC;IACjD,OAAO,GAAG,OAAO,CAAC;IAEV,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqGjC,CAAC;IAED,gBAAgB;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;CACD;AA9GD,wEA8GC"}

package/dist/tools/best-practices/data-analysis.d.ts

@@ -0,0 +1,7 @@
+import type { BestPracticesDocument } from '../../types/best-practices';
+export declare class DataAnalysisBestPractices implements BestPracticesDocument {
+    readonly technique: "data_analysis";
+    readonly version = "1.0.0";
+    private readonly documentation;
+    getDocumentation(): string;
+}