@stackflo-labs/n8n-nodes-retainr 0.1.1 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 stackflo-labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+# @stackflo-labs/n8n-nodes-retainr
+
+[n8n](https://n8n.io/) community node for [retainr.dev](https://retainr.dev) — the AI agent memory persistence API.
+
+Give your n8n AI agents **long-term memory** that persists across workflow runs. Store facts, preferences, and context, then retrieve them with semantic search — so your agents remember what matters.
+
+## Features
+
+| Operation | Description |
+|-----------|-------------|
+| **Store** | Save a memory with scope, tags, metadata, TTL, and deduplication |
+| **Search** | Semantic similarity search across stored memories |
+| **Get Context** | Retrieve pre-formatted memory context ready for LLM system prompts |
+| **List** | Browse memories with filters (scope, user, session, tags) |
+| **Delete** | Remove memories by filter criteria |
+| **Get Workspace Info** | View plan usage, API keys, and workspace details |
+
+## Installation
+
+### n8n Cloud & Desktop
+
+1. Go to **Settings > Community Nodes**
+2. Search for `@stackflo-labs/n8n-nodes-retainr`
+3. Click **Install**
+
+### Self-hosted n8n
+
+```bash
+cd ~/.n8n
+npm install @stackflo-labs/n8n-nodes-retainr
+```
+
+Then restart n8n.
+
+## Setup
+
+1. Sign up at [retainr.dev](https://retainr.dev) and get your API key
+2. In n8n, go to **Credentials > New > Retainr API**
+3. Paste your API key (`rec_live_...`)
+4. The default Base URL (`https://api.retainr.dev`) works out of the box
+
+## Usage Examples
+
+### Store a memory after a conversation
+
+1. Add the **Retainr** node after your AI Agent
+2. Set **Resource** to `Memory`, **Operation** to `Store`
+3. Map the conversation summary to the **Content** field
+4. Set **Scope** to `User` and provide the **User ID**
+
+### Inject memory context into an LLM prompt
+
+1. Add a **Retainr** node before your AI Agent
+2. Set **Operation** to `Get Context`
+3. Use the incoming message as the **Query**
+4. Pass the `context` output into your LLM's system prompt
+
+### Deduplicate similar memories
+
+Use the **Dedup Threshold** field (e.g., `0.95`) when storing. If a sufficiently similar memory already exists, it will be updated instead of duplicated.
+
+## Memory Scopes
+
+| Scope | Use case |
+|-------|----------|
+| `session` | Single workflow run — requires `session_id` |
+| `user` | Persists across runs for one user — requires `user_id` |
+| `agent` | Shared across users for one agent — requires `agent_id` |
+| `global` | Shared across the entire workspace |
+
+## AI Agent Tool
+
+This node has `usableAsTool` enabled — you can use it directly as a tool inside n8n's **AI Agent** node, letting the agent decide when to store or recall memories autonomously.
+
+## API Documentation
+
+Full API reference: [retainr.dev/docs/api](https://retainr.dev/docs/api)
+
+## License
+
+[MIT](LICENSE)

package/dist/credentials/RetainrApi.credentials.d.ts

@@ -1,7 +1,9 @@
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
 export declare class RetainrApi implements ICredentialType {
     name: string;
     displayName: string;
     documentationUrl: string;
     properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
 }

package/dist/credentials/RetainrApi.credentials.js

@@ -14,16 +14,31 @@ class RetainrApi {
                 typeOptions: { password: true },
                 default: '',
                 placeholder: 'rec_live_...',
-                description: 'Your retainr.dev API key. Get one at https://retainr.dev/dashboard',
+                description: 'Your retainr.dev API key. Create one at https://retainr.dev/dashboard.',
             },
             {
                 displayName: 'Base URL',
                 name: 'baseUrl',
                 type: 'string',
                 default: 'https://api.retainr.dev',
-                description: 'Leave as default unless using a self-hosted instance',
+                description: 'API base URL. Only change this if you run a self-hosted instance.',
             },
         ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiKey}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl}}',
+                url: '/v1/workspace',
+                method: 'GET',
+            },
+        };
     }
 }
 exports.RetainrApi = RetainrApi;

package/dist/nodes/Retainr/Retainr.node.d.ts

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Retainr implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}