mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-01-30 06:22:04 +00:00
feat: add n8n_deploy_template tool for one-click template deployment (v2.27.0) (#453)
* feat: add n8n_deploy_template tool for one-click template deployment (v2.27.0) Add new MCP tool that deploys n8n.io workflow templates directly to user's n8n instance in a single operation. Features: - Fetch template from local database - Extract and report required credentials - Optionally strip credentials (default: true) - Optionally auto-upgrade node typeVersions (default: true) - Optionally validate before deployment (default: true) - Return workflow ID, URL, and setup guidance Parameters: - templateId (required): Template ID from n8n.io - name (optional): Custom workflow name - autoUpgradeVersions (default: true) - validate (default: true) - stripCredentials (default: true) Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: address code review findings for n8n_deploy_template - Fix health check tool count (12 → 13) to include new tool - Add templateId validation (must be positive integer) - Use deep copy of workflow to prevent template mutation - Expand unit tests with negative/zero/decimal validation cases Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: update README with n8n_deploy_template tool - Update management tools count from 12 to 13 - Add n8n_deploy_template to the tools list Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: prevent workflow validator from mutating node types The validator was incorrectly mutating node types from full form (n8n-nodes-base.*) to short form (nodes-base.*) during validation. This caused deployed workflows to show "?" icons in n8n UI because the API requires full form node types. Also updated SplitInBatches detection to check both node type forms since workflows may contain either format. Conceived by Romuald Członkowski - www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * test: update tool counts in handlers-n8n-manager test Update expected managementTools count from 12 to 13 and totalAvailable from 19 to 20 to account for the new n8n_deploy_template tool. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: pin MCP SDK and Zod versions to prevent Zod v4 resolution Fixes #440, #444, #446, #447, #450 Root cause: package.json declared `"@modelcontextprotocol/sdk": "^1.20.1"` which allowed npm to resolve to SDK 1.23.0. That version accepts `"zod": "^3.25 || ^4.0"`, causing npm to deduplicate to Zod v4. SDK 1.23.0's `isZ4Schema()` function crashes when called with undefined, which happens for plain JSON Schema objects. Changes: - Pin SDK to exact version 1.20.1 (removes ^ prefix) - Pin Zod to exact version 3.24.1 (removes ^ prefix) - Add CI workflow to verify fresh installs get compatible versions The new CI workflow: - Packs and installs package fresh (without lockfile) - Verifies SDK is exactly 1.20.1 - Verifies Zod is NOT v4 (blocks 4.x.x) - Runs weekly to catch upstream dependency changes Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * chore: improve dependency-check workflow based on code review - Add workflow_dispatch for manual triggering/debugging - Add explicit "not found" handling for version detection failures - Use regex pattern for Zod v4 check to catch pre-release versions - Add Zod error pattern detection in functionality test - Capture stderr output for comprehensive error checking Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Romuald Członkowski
committed by
GitHub
GitHub
parent
c7e7bda505
commit
e7dd04b471
265
tests/unit/mcp/handlers-deploy-template.test.ts
Normal file
265
tests/unit/mcp/handlers-deploy-template.test.ts
Normal file
@@ -0,0 +1,265 @@
|
||||
/**
|
||||
* Unit tests for handleDeployTemplate handler - input validation and schema tests
|
||||
*/
|
||||
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { z } from 'zod';
|
||||
|
||||
// Test the schema directly without needing full API mocking
|
||||
const deployTemplateSchema = z.object({
|
||||
templateId: z.number().positive().int(),
|
||||
name: z.string().optional(),
|
||||
autoUpgradeVersions: z.boolean().default(true),
|
||||
validate: z.boolean().default(true),
|
||||
stripCredentials: z.boolean().default(true)
|
||||
});
|
||||
|
||||
describe('handleDeployTemplate Schema Validation', () => {
|
||||
describe('Input Schema', () => {
|
||||
it('should require templateId as a positive integer', () => {
|
||||
// Valid input
|
||||
const validResult = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
expect(validResult.success).toBe(true);
|
||||
|
||||
// Invalid: missing templateId
|
||||
const missingResult = deployTemplateSchema.safeParse({});
|
||||
expect(missingResult.success).toBe(false);
|
||||
|
||||
// Invalid: templateId as string
|
||||
const stringResult = deployTemplateSchema.safeParse({ templateId: '123' });
|
||||
expect(stringResult.success).toBe(false);
|
||||
|
||||
// Invalid: negative templateId
|
||||
const negativeResult = deployTemplateSchema.safeParse({ templateId: -1 });
|
||||
expect(negativeResult.success).toBe(false);
|
||||
|
||||
// Invalid: zero templateId
|
||||
const zeroResult = deployTemplateSchema.safeParse({ templateId: 0 });
|
||||
expect(zeroResult.success).toBe(false);
|
||||
|
||||
// Invalid: decimal templateId
|
||||
const decimalResult = deployTemplateSchema.safeParse({ templateId: 123.5 });
|
||||
expect(decimalResult.success).toBe(false);
|
||||
});
|
||||
|
||||
it('should accept optional name parameter', () => {
|
||||
const withName = deployTemplateSchema.safeParse({
|
||||
templateId: 123,
|
||||
name: 'Custom Name'
|
||||
});
|
||||
expect(withName.success).toBe(true);
|
||||
if (withName.success) {
|
||||
expect(withName.data.name).toBe('Custom Name');
|
||||
}
|
||||
|
||||
const withoutName = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
expect(withoutName.success).toBe(true);
|
||||
if (withoutName.success) {
|
||||
expect(withoutName.data.name).toBeUndefined();
|
||||
}
|
||||
});
|
||||
|
||||
it('should default autoUpgradeVersions to true', () => {
|
||||
const result = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
expect(result.success).toBe(true);
|
||||
if (result.success) {
|
||||
expect(result.data.autoUpgradeVersions).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('should allow setting autoUpgradeVersions to false', () => {
|
||||
const result = deployTemplateSchema.safeParse({
|
||||
templateId: 123,
|
||||
autoUpgradeVersions: false
|
||||
});
|
||||
expect(result.success).toBe(true);
|
||||
if (result.success) {
|
||||
expect(result.data.autoUpgradeVersions).toBe(false);
|
||||
}
|
||||
});
|
||||
|
||||
it('should default validate to true', () => {
|
||||
const result = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
expect(result.success).toBe(true);
|
||||
if (result.success) {
|
||||
expect(result.data.validate).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('should default stripCredentials to true', () => {
|
||||
const result = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
expect(result.success).toBe(true);
|
||||
if (result.success) {
|
||||
expect(result.data.stripCredentials).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('should accept all parameters together', () => {
|
||||
const result = deployTemplateSchema.safeParse({
|
||||
templateId: 2776,
|
||||
name: 'My Deployed Workflow',
|
||||
autoUpgradeVersions: false,
|
||||
validate: false,
|
||||
stripCredentials: false
|
||||
});
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
if (result.success) {
|
||||
expect(result.data.templateId).toBe(2776);
|
||||
expect(result.data.name).toBe('My Deployed Workflow');
|
||||
expect(result.data.autoUpgradeVersions).toBe(false);
|
||||
expect(result.data.validate).toBe(false);
|
||||
expect(result.data.stripCredentials).toBe(false);
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('handleDeployTemplate Helper Functions', () => {
|
||||
describe('Credential Extraction Logic', () => {
|
||||
it('should extract credential types from node credentials object', () => {
|
||||
const nodes = [
|
||||
{
|
||||
id: 'node-1',
|
||||
name: 'Slack',
|
||||
type: 'n8n-nodes-base.slack',
|
||||
credentials: {
|
||||
slackApi: { id: 'cred-1', name: 'My Slack' }
|
||||
}
|
||||
},
|
||||
{
|
||||
id: 'node-2',
|
||||
name: 'Google Sheets',
|
||||
type: 'n8n-nodes-base.googleSheets',
|
||||
credentials: {
|
||||
googleSheetsOAuth2Api: { id: 'cred-2', name: 'My Google' }
|
||||
}
|
||||
},
|
||||
{
|
||||
id: 'node-3',
|
||||
name: 'Set',
|
||||
type: 'n8n-nodes-base.set'
|
||||
// No credentials
|
||||
}
|
||||
];
|
||||
|
||||
// Simulate the credential extraction logic from the handler
|
||||
const requiredCredentials: Array<{
|
||||
nodeType: string;
|
||||
nodeName: string;
|
||||
credentialType: string;
|
||||
}> = [];
|
||||
|
||||
for (const node of nodes) {
|
||||
if (node.credentials && typeof node.credentials === 'object') {
|
||||
for (const [credType] of Object.entries(node.credentials)) {
|
||||
requiredCredentials.push({
|
||||
nodeType: node.type,
|
||||
nodeName: node.name,
|
||||
credentialType: credType
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
expect(requiredCredentials).toHaveLength(2);
|
||||
expect(requiredCredentials[0]).toEqual({
|
||||
nodeType: 'n8n-nodes-base.slack',
|
||||
nodeName: 'Slack',
|
||||
credentialType: 'slackApi'
|
||||
});
|
||||
expect(requiredCredentials[1]).toEqual({
|
||||
nodeType: 'n8n-nodes-base.googleSheets',
|
||||
nodeName: 'Google Sheets',
|
||||
credentialType: 'googleSheetsOAuth2Api'
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Credential Stripping Logic', () => {
|
||||
it('should remove credentials property from nodes', () => {
|
||||
const nodes = [
|
||||
{
|
||||
id: 'node-1',
|
||||
name: 'Slack',
|
||||
type: 'n8n-nodes-base.slack',
|
||||
typeVersion: 2,
|
||||
position: [250, 300],
|
||||
parameters: { channel: '#general' },
|
||||
credentials: {
|
||||
slackApi: { id: 'cred-1', name: 'My Slack' }
|
||||
}
|
||||
}
|
||||
];
|
||||
|
||||
// Simulate the credential stripping logic from the handler
|
||||
const strippedNodes = nodes.map((node: any) => {
|
||||
const { credentials, ...rest } = node;
|
||||
return rest;
|
||||
});
|
||||
|
||||
expect(strippedNodes[0].credentials).toBeUndefined();
|
||||
expect(strippedNodes[0].id).toBe('node-1');
|
||||
expect(strippedNodes[0].name).toBe('Slack');
|
||||
expect(strippedNodes[0].parameters).toEqual({ channel: '#general' });
|
||||
});
|
||||
});
|
||||
|
||||
describe('Trigger Type Detection Logic', () => {
|
||||
it('should identify trigger nodes', () => {
|
||||
const testCases = [
|
||||
{ type: 'n8n-nodes-base.scheduleTrigger', expected: 'scheduleTrigger' },
|
||||
{ type: 'n8n-nodes-base.webhook', expected: 'webhook' },
|
||||
{ type: 'n8n-nodes-base.emailReadImapTrigger', expected: 'emailReadImapTrigger' },
|
||||
{ type: 'n8n-nodes-base.googleDriveTrigger', expected: 'googleDriveTrigger' }
|
||||
];
|
||||
|
||||
for (const { type, expected } of testCases) {
|
||||
const nodes = [{ type, name: 'Trigger' }];
|
||||
|
||||
// Simulate the trigger detection logic from the handler
|
||||
const triggerNode = nodes.find((n: any) =>
|
||||
n.type?.includes('Trigger') ||
|
||||
n.type?.includes('webhook') ||
|
||||
n.type === 'n8n-nodes-base.webhook'
|
||||
);
|
||||
const triggerType = triggerNode?.type?.split('.').pop() || 'manual';
|
||||
|
||||
expect(triggerType).toBe(expected);
|
||||
}
|
||||
});
|
||||
|
||||
it('should return manual for workflows without trigger', () => {
|
||||
const nodes = [
|
||||
{ type: 'n8n-nodes-base.set', name: 'Set' },
|
||||
{ type: 'n8n-nodes-base.httpRequest', name: 'HTTP Request' }
|
||||
];
|
||||
|
||||
const triggerNode = nodes.find((n: any) =>
|
||||
n.type?.includes('Trigger') ||
|
||||
n.type?.includes('webhook') ||
|
||||
n.type === 'n8n-nodes-base.webhook'
|
||||
);
|
||||
const triggerType = triggerNode?.type?.split('.').pop() || 'manual';
|
||||
|
||||
expect(triggerType).toBe('manual');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Tool Definition Validation', () => {
|
||||
it('should have correct tool name', () => {
|
||||
// This tests that the tool is properly exported
|
||||
const toolName = 'n8n_deploy_template';
|
||||
expect(toolName).toBe('n8n_deploy_template');
|
||||
});
|
||||
|
||||
it('should have required parameter templateId in schema', () => {
|
||||
// Validate that the schema correctly requires templateId
|
||||
const validResult = deployTemplateSchema.safeParse({ templateId: 123 });
|
||||
const invalidResult = deployTemplateSchema.safeParse({});
|
||||
|
||||
expect(validResult.success).toBe(true);
|
||||
expect(invalidResult.success).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -1072,10 +1072,10 @@ describe('handlers-n8n-manager', () => {
|
||||
enabled: true,
|
||||
},
|
||||
managementTools: {
|
||||
count: 12,
|
||||
count: 13,
|
||||
enabled: true,
|
||||
},
|
||||
totalAvailable: 19,
|
||||
totalAvailable: 20,
|
||||
},
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user