n8n-atom-mcp 0.0.1

package/dist/mcp/tool-docs/workflow_management/n8n-workflow-versions.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.n8nWorkflowVersionsDoc = void 0;
+exports.n8nWorkflowVersionsDoc = {
+    name: 'n8n_workflow_versions',
+    category: 'workflow_management',
+    essentials: {
+        description: 'Manage workflow version history, rollback to previous versions, and cleanup old versions',
+        keyParameters: ['mode', 'workflowId', 'versionId'],
+        example: 'n8n_workflow_versions({mode: "list", workflowId: "abc123"})',
+        performance: 'Fast for list/get (~100ms), moderate for rollback (~200-500ms)',
+        tips: [
+            'Use mode="list" to see all saved versions before rollback',
+            'Rollback creates a backup version automatically',
+            'Use prune to clean up old versions and save storage',
+            'truncate requires explicit confirmTruncate: true'
+        ]
+    },
+    full: {
+        description: `Comprehensive workflow version management system. Supports six operations:
+
+**list** - Show version history for a workflow
+- Returns all saved versions with timestamps, snapshot sizes, and metadata
+- Use limit parameter to control how many versions to return
+
+**get** - Get details of a specific version
+- Returns the complete workflow snapshot from that version
+- Use to compare versions or extract old configurations
+
+**rollback** - Restore workflow to a previous version
+- Creates a backup of the current workflow before rollback
+- Optionally validates the workflow structure before applying
+- Returns the restored workflow and backup version ID
+
+**delete** - Delete specific version(s)
+- Delete a single version by versionId
+- Delete all versions for a workflow with deleteAll: true
+
+**prune** - Clean up old versions
+- Keeps only the N most recent versions (default: 10)
+- Useful for managing storage and keeping history manageable
+
+**truncate** - Delete ALL versions for ALL workflows
+- Dangerous operation requiring explicit confirmation
+- Use for complete version history cleanup`,
+        parameters: {
+            mode: {
+                type: 'string',
+                required: true,
+                description: 'Operation mode: "list", "get", "rollback", "delete", "prune", or "truncate"',
+                enum: ['list', 'get', 'rollback', 'delete', 'prune', 'truncate']
+            },
+            workflowId: {
+                type: 'string',
+                required: false,
+                description: 'Workflow ID (required for list, rollback, delete, prune modes)'
+            },
+            versionId: {
+                type: 'number',
+                required: false,
+                description: 'Version ID (required for get mode, optional for rollback to specific version, required for single delete)'
+            },
+            limit: {
+                type: 'number',
+                required: false,
+                default: 10,
+                description: 'Maximum versions to return in list mode'
+            },
+            validateBefore: {
+                type: 'boolean',
+                required: false,
+                default: true,
+                description: 'Validate workflow structure before rollback (rollback mode only)'
+            },
+            deleteAll: {
+                type: 'boolean',
+                required: false,
+                default: false,
+                description: 'Delete all versions for workflow (delete mode only)'
+            },
+            maxVersions: {
+                type: 'number',
+                required: false,
+                default: 10,
+                description: 'Keep N most recent versions (prune mode only)'
+            },
+            confirmTruncate: {
+                type: 'boolean',
+                required: false,
+                default: false,
+                description: 'REQUIRED: Must be true to truncate all versions (truncate mode only)'
+            }
+        },
+        returns: `Response varies by mode:
+
+**list mode:**
+- versions: Array of version objects with id, workflowId, snapshotSize, createdAt
+- totalCount: Total number of versions
+
+**get mode:**
+- version: Complete version object including workflow snapshot
+
+**rollback mode:**
+- success: Boolean indicating success
+- restoredVersion: The version that was restored
+- backupVersionId: ID of the backup created before rollback
+
+**delete mode:**
+- deletedCount: Number of versions deleted
+
+**prune mode:**
+- prunedCount: Number of old versions removed
+- remainingCount: Number of versions kept
+
+**truncate mode:**
+- deletedCount: Total versions deleted across all workflows`,
+        examples: [
+            '// List version history\nn8n_workflow_versions({mode: "list", workflowId: "abc123", limit: 5})',
+            '// Get specific version details\nn8n_workflow_versions({mode: "get", versionId: 42})',
+            '// Rollback to latest saved version\nn8n_workflow_versions({mode: "rollback", workflowId: "abc123"})',
+            '// Rollback to specific version\nn8n_workflow_versions({mode: "rollback", workflowId: "abc123", versionId: 42})',
+            '// Delete specific version\nn8n_workflow_versions({mode: "delete", workflowId: "abc123", versionId: 42})',
+            '// Delete all versions for workflow\nn8n_workflow_versions({mode: "delete", workflowId: "abc123", deleteAll: true})',
+            '// Prune to keep only 5 most recent\nn8n_workflow_versions({mode: "prune", workflowId: "abc123", maxVersions: 5})',
+            '// Truncate all versions (dangerous!)\nn8n_workflow_versions({mode: "truncate", confirmTruncate: true})'
+        ],
+        useCases: [
+            'Recover from accidental workflow changes',
+            'Compare workflow versions to understand changes',
+            'Maintain audit trail of workflow modifications',
+            'Clean up old versions to save database storage',
+            'Roll back failed workflow deployments'
+        ],
+        performance: `Performance varies by operation:
+- list: Fast (~100ms) - simple database query
+- get: Fast (~100ms) - single row retrieval
+- rollback: Moderate (~200-500ms) - includes backup creation and workflow update
+- delete: Fast (~50-100ms) - database delete operation
+- prune: Moderate (~100-300ms) - depends on number of versions to delete
+- truncate: Slow (1-5s) - deletes all records across all workflows`,
+        modeComparison: `| Mode | Required Params | Optional Params | Risk Level |
+|------|-----------------|-----------------|------------|
+| list | workflowId | limit | Low |
+| get | versionId | - | Low |
+| rollback | workflowId | versionId, validateBefore | Medium |
+| delete | workflowId | versionId, deleteAll | High |
+| prune | workflowId | maxVersions | Medium |
+| truncate | confirmTruncate=true | - | Critical |`,
+        bestPractices: [
+            'Always list versions before rollback to pick the right one',
+            'Enable validateBefore for rollback to catch structural issues',
+            'Use prune regularly to keep version history manageable',
+            'Never use truncate in production without explicit need',
+            'Document why you are rolling back for audit purposes'
+        ],
+        pitfalls: [
+            'Rollback overwrites current workflow - backup is created automatically',
+            'Deleted versions cannot be recovered',
+            'Truncate affects ALL workflows - use with extreme caution',
+            'Version IDs are sequential but may have gaps after deletes',
+            'Large workflows may have significant version storage overhead'
+        ],
+        relatedTools: [
+            'n8n_get_workflow - View current workflow state',
+            'n8n_update_partial_workflow - Make incremental changes',
+            'n8n_validate_workflow - Validate before deployment'
+        ]
+    }
+};
+//# sourceMappingURL=n8n-workflow-versions.js.map

package/dist/mcp/tool-docs/workflow_management/n8n-workflow-versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"n8n-workflow-versions.js","sourceRoot":"","sources":["../../../../src/mcp/tool-docs/workflow_management/n8n-workflow-versions.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAsB;IACvD,IAAI,EAAE,uBAAuB;IAC7B,QAAQ,EAAE,qBAAqB;IAC/B,UAAU,EAAE;QACV,WAAW,EAAE,0FAA0F;QACvG,aAAa,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC;QAClD,OAAO,EAAE,6DAA6D;QACtE,WAAW,EAAE,gEAAgE;QAC7E,IAAI,EAAE;YACJ,2DAA2D;YAC3D,iDAAiD;YACjD,qDAAqD;YACrD,kDAAkD;SACnD;KACF;IACD,IAAI,EAAE;QACJ,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;2CAyB0B;QACvC,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,6EAA6E;gBAC1F,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;aACjE;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,gEAAgE;aAC9E;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,2GAA2G;aACzH;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,yCAAyC;aACvD;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;gBACb,WAAW,EAAE,kEAAkE;aAChF;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,qDAAqD;aACnE;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,+CAA+C;aAC7D;YACD,eAAe,EAAE;gBACf,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,sEAAsE;aACpF;SACF;QACD,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;4DAsB+C;QACxD,QAAQ,EAAE;YACR,gGAAgG;YAChG,sFAAsF;YACtF,sGAAsG;YACtG,iHAAiH;YACjH,0GAA0G;YAC1G,qHAAqH;YACrH,mHAAmH;YACnH,yGAAyG;SAC1G;QACD,QAAQ,EAAE;YACR,0CAA0C;YAC1C,iDAAiD;YACjD,gDAAgD;YAChD,gDAAgD;YAChD,uCAAuC;SACxC;QACD,WAAW,EAAE;;;;;;mEAMkD;QAC/D,cAAc,EAAE;;;;;;;mDAO+B;QAC/C,aAAa,EAAE;YACb,4DAA4D;YAC5D,+DAA+D;YAC/D,wDAAwD;YACxD,wDAAwD;YACxD,sDAAsD;SACvD;QACD,QAAQ,EAAE;YACR,wEAAwE;YACxE,sCAAsC;YACtC,2DAA2D;YAC3D,4DAA4D;YAC5D,+DAA+D;SAChE;QACD,YAAY,EAAE;YACZ,gDAAgD;YAChD,wDAAwD;YACxD,oDAAoD;SACrD;KACF;CACF,CAAC"}

package/dist/mcp/tools-documentation.d.ts

@@ -0,0 +1,6 @@
+export declare function getToolDocumentation(toolName: string, depth?: 'essentials' | 'full'): string;
+export declare function getToolsOverview(depth?: 'essentials' | 'full'): string;
+export declare function searchToolDocumentation(keyword: string): string[];
+export declare function getToolsByCategory(category: string): string[];
+export declare function getAllCategories(): string[];
+//# sourceMappingURL=tools-documentation.d.ts.map

package/dist/mcp/tools-documentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools-documentation.d.ts","sourceRoot":"","sources":["../../src/mcp/tools-documentation.ts"],"names":[],"mappings":"AAEA,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,GAAE,YAAY,GAAG,MAAqB,GAAG,MAAM,CA+D1G;AAED,wBAAgB,gBAAgB,CAAC,KAAK,GAAE,YAAY,GAAG,MAAqB,GAAG,MAAM,CAsHpF;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAWjE;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAI7D;AAED,wBAAgB,gBAAgB,IAAI,MAAM,EAAE,CAM3C"}