@n8n/instance-ai 1.0.0

package/dist/tools/best-practices/get-best-practices.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-best-practices.tool.js","sourceRoot":"","sources":["../../../src/tools/best-practices/get-best-practices.tool.ts"],"names":[],"mappings":";;AAMA,gEAsEC;AA5ED,8CAAgD;AAChD,6BAAwB;AAExB,mCAAwC;AACxC,6CAAgF;AAEhF,SAAgB,0BAA0B;IACzC,OAAO,IAAA,kBAAU,EAAC;QACjB,EAAE,EAAE,oBAAoB;QACxB,WAAW,EACV,iJAAiJ;QAClJ,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;YACrB,SAAS,EAAE,OAAC;iBACV,MAAM,EAAE;iBACR,QAAQ,CACR,mIAAmI,CACnI;SACF,CAAC;QACF,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACpC,mBAAmB,EAAE,OAAC;iBACpB,KAAK,CACL,OAAC,CAAC,MAAM,CAAC;gBACR,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;gBACrB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;gBACvB,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE;aAC7B,CAAC,CACF;iBACA,QAAQ,EAAE;YACZ,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;SACnB,CAAC;QAEF,OAAO,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;YAEhC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;gBAC1B,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,iCAAoB,CAAC,CAAC,GAAG,CACnE,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;oBACzB,SAAS,EAAE,IAAI;oBACf,WAAW;oBACX,gBAAgB,EAAE,qBAAa,CAAC,IAA6B,CAAC,KAAK,SAAS;iBAC5E,CAAC,CACF,CAAC;gBAEF,OAAO;oBACN,SAAS,EAAE,MAAM;oBACjB,mBAAmB;oBACnB,OAAO,EAAE,SAAS,mBAAmB,CAAC,MAAM,gBAAgB,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,MAAM,+BAA+B;iBACvJ,CAAC;YACH,CAAC;YAGD,MAAM,QAAQ,GAAG,qBAAa,CAAC,SAAkC,CAAC,CAAC;YACnE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAEf,MAAM,WAAW,GAAG,iCAAoB,CAAC,SAAkC,CAAC,CAAC;gBAC7E,IAAI,WAAW,EAAE,CAAC;oBACjB,OAAO;wBACN,SAAS;wBACT,OAAO,EAAE,cAAc,SAAS,MAAM,WAAW,0HAA0H;qBAC3K,CAAC;gBACH,CAAC;gBAED,OAAO;oBACN,SAAS;oBACT,OAAO,EAAE,sBAAsB,SAAS,0DAA0D;iBAClG,CAAC;YACH,CAAC;YAED,OAAO;gBACN,SAAS;gBACT,aAAa,EAAE,QAAQ,EAAE;gBACzB,OAAO,EAAE,qCAAqC,SAAS,2BAA2B;aAClF,CAAC;QACH,CAAC;KACD,CAAC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1 @@
+export declare function getDocumentation(): string;

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentation = getDocumentation;
+function getDocumentation() {
+    return `# 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.
+`;
+}
+//# sourceMappingURL=chatbot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"chatbot.js","sourceRoot":"","sources":["../../../../src/tools/best-practices/guides/chatbot.ts"],"names":[],"mappings":";;AAAA,4CA0GC;AA1GD,SAAgB,gBAAgB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwGP,CAAC;AACF,CAAC"}

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

@@ -0,0 +1 @@
+export declare function getDocumentation(): string;

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

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentation = getDocumentation;
+function getDocumentation() {
+    return `# 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.
+`;
+}
+//# sourceMappingURL=content-generation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"content-generation.js","sourceRoot":"","sources":["../../../../src/tools/best-practices/guides/content-generation.ts"],"names":[],"mappings":";;AAAA,4CAuGC;AAvGD,SAAgB,gBAAgB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqGP,CAAC;AACF,CAAC"}

package/dist/tools/best-practices/guides/data-extraction.d.ts

@@ -0,0 +1 @@
+export declare function getDocumentation(): string;

package/dist/tools/best-practices/guides/data-extraction.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentation = getDocumentation;
+function getDocumentation() {
+    return `# Best Practices: Data Extraction Workflows
+
+## Node Selection by Data Type
+
+Choose the right node for your data source. Use Extract From File for CSV, Excel, PDF, and text files to convert binary data to JSON for further processing.
+
+Use Information Extractor or AI nodes for extracting structured data from unstructured text such as PDFs or emails using LLMs.
+
+For binary data, ensure you use nodes like Extract From File to handle files properly.
+
+### Referencing Binary Data from Other Nodes
+When you need to reference binary data from a previous node, use this syntax:
+- Expression: '{{ $('Node Name').item.binary.property_name }}' or {{ $binary.property_name }} if previous item
+- Example for Gmail attachments: '{{ $('Gmail Trigger').item.binary.attachment_0 }}' or {{ $binary.attachment_0 }} if previous item
+- Example for webhook data: '{{ $('Webhook').item.binary.data }}' or {{ $binary.data }} if previous item
+- Important: The property name depends on how the previous node names the binary data
+
+## Data Structure & Type Management
+
+Normalize data structure early in your workflow. Use transformation nodes like Split Out, Aggregate, or Set to ensure your data matches n8n's expected structure: an array of objects with a json key.
+Not transforming incoming data to n8n's expected format causes downstream node failures.
+
+When working with large amounts of information, n8n's display can be hard to view. Use the Edit Fields node to help organize and view data more clearly during development and debugging.
+
+## Large File Handling
+
+Process files in batches or use sub-workflows to avoid memory issues. For large binary files, consider enabling filesystem mode (N8N_DEFAULT_BINARY_DATA_MODE=filesystem) if self-hosted, to store binary data on disk instead of memory.
+
+Processing too many items or large files at once can crash your instance. Always batch or split processing for large datasets to manage memory effectively.
+
+## Binary Data Management
+
+Binary data can be lost if intermediate nodes (like Set or Code) do not have "Include Other Input Fields" enabled, especially in sub-workflows. Always verify binary data is preserved through your workflow pipeline.
+
+## AI-Powered Extraction
+
+Leverage AI for unstructured data using nodes like Information Extractor or Summarization Chain to extract structured data from unstructured sources such as PDFs, emails, or web pages.
+
+## Recommended Nodes
+
+### Loop Over Items (n8n-nodes-base.splitInBatches)
+
+Purpose: Looping over a set of items extracted from a data set, for example if pulling a lot of data
+from a Google Sheet or database then looping over the items is required. This node MUST be used
+if the user mentions a large amount of data, it is necessary to batch the data to process all of it.
+
+### Extract From File (n8n-nodes-base.extractFromFile)
+
+Purpose: Converts binary data from CSV, Excel, PDF, and text files to JSON for processing
+
+Pitfalls:
+
+- Ensure the correct binary field name is specified in the node configuration
+- Verify file format compatibility before extraction
+
+### HTML Extract (n8n-nodes-base.htmlExtract)
+
+Purpose: Scrapes data from web pages using CSS selectors
+
+### Split Out (n8n-nodes-base.splitOut)
+
+Purpose: Processes arrays of items individually for sequential operations.
+Example: If retrieving a JSON array using a HTTP request, this will return a single item,
+containing that array. If you wish to use a Loop Over Items (n8n-nodes-base.splitInBatches) node,
+then you will need to split out the array into items before looping over it. In a scenario like
+this a split out node MUST be used before looping over the items.
+
+### Edit Fields (Set) (n8n-nodes-base.set)
+
+Purpose: Data transformation and mapping to normalize structure
+
+Pitfalls:
+
+- Enable "Include Other Input Fields" to preserve binary data
+- Pay attention to data types - mixing types causes unexpected failures
+
+### Information Extractor (@n8n/n8n-nodes-langchain.informationExtractor)
+
+Purpose: AI-powered extraction of structured data from unstructured text
+
+Pitfalls:
+
+- Requires proper schema definition for extraction
+
+### Summarization Chain (@n8n/n8n-nodes-langchain.chainSummarization)
+
+Purpose: Summarizes large text blocks using AI for condensed information extraction
+
+Pitfalls:
+
+- Context window limits may truncate very long documents
+- Verify summary quality matches requirements
+
+### HTTP Request (n8n-nodes-base.httpRequest)
+
+Purpose: Fetches data from APIs or web pages for extraction
+
+### Code (n8n-nodes-base.code)
+
+Purpose: Custom logic for complex data transformations
+
+## Common Pitfalls to Avoid
+
+Data Type Confusion: People often mix up data types - n8n can be very lenient but it can lead to problems. Pay close attention to what type you are getting and ensure consistency throughout the workflow.
+
+Binary Data Loss: Binary data can be lost if intermediate nodes (Set, Code) do not have "Include Other Input Fields" enabled, especially in sub-workflows. Always verify binary data preservation.
+
+Large Data Display Issues: n8n displaying large amounts of information can be hard to view during development. Use the Edit Fields node to help organize and view data more clearly.
+`;
+}
+//# sourceMappingURL=data-extraction.js.map

package/dist/tools/best-practices/guides/data-extraction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-extraction.js","sourceRoot":"","sources":["../../../../src/tools/best-practices/guides/data-extraction.ts"],"names":[],"mappings":";;AAAA,4CA8GC;AA9GD,SAAgB,gBAAgB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4GP,CAAC;AACF,CAAC"}

package/dist/tools/best-practices/guides/data-persistence.d.ts

@@ -0,0 +1 @@
+export declare function getDocumentation(): string;

package/dist/tools/best-practices/guides/data-persistence.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentation = getDocumentation;
+function getDocumentation() {
+    return `# Best Practices: Data Persistence
+
+## Overview
+
+Data persistence involves storing, updating, or retrieving records from durable storage systems. This technique is essential when you need to maintain data beyond the lifetime of a single workflow execution, or when you need to access existing data that users have stored in their spreadsheets, tables, or databases as part of your workflow logic.
+
+## When to Use Data Persistence
+
+Use data persistence when you need to:
+- Store workflow results for later retrieval or audit trails
+- Maintain records that multiple workflows can access and update
+- Create a centralized data repository for your automation
+- Archive historical data for reporting or compliance
+- Build data that persists across workflow executions
+- Track changes or maintain state over time
+- Store raw form inputs
+
+## Choosing the Right Storage Node
+
+### Data Table (n8n-nodes-base.dataTable) - PREFERRED
+
+**Best for:** Quick setup, small to medium amounts of data
+
+Advantages:
+- No credentials or external configuration required
+- Built directly into n8n
+- Fast and reliable for small to medium datasets
+- Ideal for prototyping and internal workflows
+- No additional costs or external dependencies
+
+When to use:
+- Internal workflow data storage
+- Temporary or staging data
+- Admin/audit trails
+- Simple record keeping
+- Development and testing
+
+### Google Sheets (n8n-nodes-base.googleSheets)
+
+**Best for:** Collaboration, reporting, easy data sharing
+
+Advantages:
+- Familiar spreadsheet interface for non-technical users
+- Easy to share and collaborate on data
+- Built-in visualization and formula capabilities
+- Good for reporting and dashboards
+- Accessible from anywhere
+
+When to use:
+- Data needs to be viewed/edited by multiple people
+- Non-technical users need access to data
+- Integration with other Google Workspace tools
+- Simple data structures without complex relationships
+- Workflow needs access to existing spreadsheets in Google Sheets
+
+Pitfalls:
+- API rate limits can affect high-volume workflows
+- Not suitable for frequently changing data
+- Performance degrades with very large datasets (>10k rows)
+
+### Airtable (n8n-nodes-base.airtable)
+
+**Best for:** Structured data with relationships, rich field types
+
+Advantages:
+- Supports relationships between tables
+- Rich field types (attachments, select, links, etc.)
+- Better structure than spreadsheets
+
+When to use:
+- Data has relationships or references between records
+- Need structured database-like features
+- Managing projects, tasks, or inventory
+- Workflow needs access to existing data in Airtable
+
+Pitfalls:
+- Requires Airtable account and API key
+- Schema changes require careful planning
+
+## Storage Patterns
+
+### Immediate Storage Pattern
+
+Store data immediately after collection or generation:
+
+\`\`\`mermaid
+flowchart LR
+    Trigger --> Process_Data["Process Data"]
+    Process_Data --> Storage_Node["Storage Node"]
+    Storage_Node --> Continue_Workflow["Continue Workflow"]
+\`\`\`
+
+Best for: Raw data preservation, audit trails, form submissions
+
+### Batch Storage Pattern
+
+Collect multiple items and store them together:
+
+\`\`\`mermaid
+flowchart LR
+    Trigger --> Loop_Split["Loop/Split"]
+    Loop_Split --> Process["Process"]
+    Process --> Aggregate["Aggregate"]
+    Aggregate --> Storage_Node["Storage Node"]
+\`\`\`
+
+Best for: Processing lists, batch operations, scheduled aggregations
+
+### Update Pattern
+
+Retrieve, modify, and update existing records:
+
+\`\`\`mermaid
+flowchart LR
+    Trigger --> Retrieve["Retrieve from Storage"]
+    Retrieve --> Modify["Modify"]
+    Modify --> Update_Storage["Update Storage Node"]
+\`\`\`
+
+Best for: Maintaining state, updating records, tracking changes
+
+### Lookup Pattern
+
+Query storage to retrieve specific records:
+
+\`\`\`mermaid
+flowchart LR
+    Trigger --> Query_Storage["Query Storage Node"]
+    Query_Storage --> Use_Data["Use Retrieved Data"]
+    Use_Data --> Continue_Workflow["Continue Workflow"]
+\`\`\`
+
+Best for: Enrichment, validation, conditional logic based on stored data
+
+## Key Considerations
+
+### Data Structure
+
+- **Plan your schema ahead:** Define what fields you need before creating storage
+- **Use consistent field names:** Match field names across your workflow for easy mapping
+- **Consider data types:** Ensure your storage supports the data types you need
+- **Think about relationships:** If data is related, consider Airtable or use multiple tables
+
+### Performance
+
+- **Batch operations when possible:** Multiple small writes are slower than batch operations
+- **Use appropriate operations:** Use "append" for new records, "update" for modifications
+- **Consider API limits:** Google Sheets has rate limits; plan accordingly for high-volume workflows
+
+### Data Integrity
+
+- **Store raw data first:** Keep unmodified input before transformations
+- **Handle errors gracefully:** Use error handling to prevent data loss on failures
+- **Validate before storing:** Ensure data quality before persistence
+- **Avoid duplicates:** Use unique identifiers or upsert operations when appropriate
+
+## Referencing Documents, Sheets, or Tables
+
+When configuring storage nodes, use ResourceLocator mode "list". This will allow users to select from existing documents, sheets, or tables rather than passing IDs dynamically.
+Use modes "id", "url" or "name" only when user specifically mentions it in their prompt.
+
+## Important Distinctions
+
+### Storage vs. Transformation
+
+- **Set/Merge nodes are NOT storage:** They transform data in memory only
+- **Storage happens explicitly:** Data won't persist unless you explicitly write it to storage
+
+### Temporary vs. Persistent Storage
+
+- **NOT covered by this technique:** Redis, caching, session storage, in-memory operations
+- **This technique covers:** Durable storage that persists beyond workflow execution
+- **Focus on permanence:** Use these nodes when you need data to survive restarts and be queryable later
+
+## Common Pitfalls to Avoid
+
+### Not Handling Duplicates
+
+Without proper unique identifiers or upsert logic, you may create duplicate records. Use unique IDs or check for existing records before inserting.
+
+### Ignoring Storage Limits
+
+Each storage system has limits (row counts, API rates, file sizes). Design your workflow to work within these constraints or implement pagination/batching.
+
+### Not Handling Empty Query Results
+
+Data Tables and other storage nodes return 0 items when:
+- The table is freshly created and has no rows yet
+- A filter/lookup query matches nothing
+
+This silently breaks the downstream chain — all nodes after the empty result are skipped. Always set \`alwaysOutputData: true\` on data-fetching nodes (operation: 'get') when downstream nodes depend on their output.
+`;
+}
+//# sourceMappingURL=data-persistence.js.map

package/dist/tools/best-practices/guides/data-persistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-persistence.js","sourceRoot":"","sources":["../../../../src/tools/best-practices/guides/data-persistence.ts"],"names":[],"mappings":";;AAAA,4CAiMC;AAjMD,SAAgB,gBAAgB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+LP,CAAC;AACF,CAAC"}

package/dist/tools/best-practices/guides/data-transformation.d.ts

@@ -0,0 +1 @@
+export declare function getDocumentation(): string;