feat: comprehensive parameter validation for MCP tools

- Add validateToolParams method with clear error messages
- Fix failing tests to expect new parameter validation errors
- Create comprehensive parameter validation test suite (52 tests)
- Add parameter validation for all n8n management tools
- Test numeric parameter conversion and edge cases
- Ensure consistent error format across all tools
- Verify MCP error response handling

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-08-01 09:33:57 +02:00
parent 12818443df
commit 6cdb52f56f
3 changed files with 637 additions and 9 deletions

View File

@@ -221,89 +221,154 @@ export class N8NDocumentationMCPServer {
}); });
} }
/**
* Validate required parameters for tool execution
*/
private validateToolParams(toolName: string, args: any, requiredParams: string[]): void {
const missing: string[] = [];
for (const param of requiredParams) {
if (!(param in args) || args[param] === undefined || args[param] === null) {
missing.push(param);
}
}
if (missing.length > 0) {
throw new Error(`Missing required parameters for ${toolName}: ${missing.join(', ')}. Please provide the required parameters to use this tool.`);
}
}
async executeTool(name: string, args: any): Promise<any> { async executeTool(name: string, args: any): Promise<any> {
// Ensure args is an object
args = args || {};
switch (name) { switch (name) {
case 'tools_documentation': case 'tools_documentation':
// No required parameters
return this.getToolsDocumentation(args.topic, args.depth); return this.getToolsDocumentation(args.topic, args.depth);
case 'list_nodes': case 'list_nodes':
// No required parameters
return this.listNodes(args); return this.listNodes(args);
case 'get_node_info': case 'get_node_info':
this.validateToolParams(name, args, ['nodeType']);
return this.getNodeInfo(args.nodeType); return this.getNodeInfo(args.nodeType);
case 'search_nodes': case 'search_nodes':
return this.searchNodes(args.query, args.limit, { mode: args.mode }); this.validateToolParams(name, args, ['query']);
// Convert limit to number if provided, otherwise use default
const limit = args.limit !== undefined ? Number(args.limit) || 20 : 20;
return this.searchNodes(args.query, limit, { mode: args.mode });
case 'list_ai_tools': case 'list_ai_tools':
// No required parameters
return this.listAITools(); return this.listAITools();
case 'get_node_documentation': case 'get_node_documentation':
this.validateToolParams(name, args, ['nodeType']);
return this.getNodeDocumentation(args.nodeType); return this.getNodeDocumentation(args.nodeType);
case 'get_database_statistics': case 'get_database_statistics':
// No required parameters
return this.getDatabaseStatistics(); return this.getDatabaseStatistics();
case 'get_node_essentials': case 'get_node_essentials':
this.validateToolParams(name, args, ['nodeType']);
return this.getNodeEssentials(args.nodeType); return this.getNodeEssentials(args.nodeType);
case 'search_node_properties': case 'search_node_properties':
return this.searchNodeProperties(args.nodeType, args.query, args.maxResults); this.validateToolParams(name, args, ['nodeType', 'query']);
const maxResults = args.maxResults !== undefined ? Number(args.maxResults) || 20 : 20;
return this.searchNodeProperties(args.nodeType, args.query, maxResults);
case 'get_node_for_task': case 'get_node_for_task':
this.validateToolParams(name, args, ['task']);
return this.getNodeForTask(args.task); return this.getNodeForTask(args.task);
case 'list_tasks': case 'list_tasks':
// No required parameters
return this.listTasks(args.category); return this.listTasks(args.category);
case 'validate_node_operation': case 'validate_node_operation':
this.validateToolParams(name, args, ['nodeType', 'config']);
return this.validateNodeConfig(args.nodeType, args.config, 'operation', args.profile); return this.validateNodeConfig(args.nodeType, args.config, 'operation', args.profile);
case 'validate_node_minimal': case 'validate_node_minimal':
this.validateToolParams(name, args, ['nodeType', 'config']);
return this.validateNodeMinimal(args.nodeType, args.config); return this.validateNodeMinimal(args.nodeType, args.config);
case 'get_property_dependencies': case 'get_property_dependencies':
this.validateToolParams(name, args, ['nodeType']);
return this.getPropertyDependencies(args.nodeType, args.config); return this.getPropertyDependencies(args.nodeType, args.config);
case 'get_node_as_tool_info': case 'get_node_as_tool_info':
this.validateToolParams(name, args, ['nodeType']);
return this.getNodeAsToolInfo(args.nodeType); return this.getNodeAsToolInfo(args.nodeType);
case 'list_node_templates': case 'list_node_templates':
return this.listNodeTemplates(args.nodeTypes, args.limit); this.validateToolParams(name, args, ['nodeTypes']);
const templateLimit = args.limit !== undefined ? Number(args.limit) || 10 : 10;
return this.listNodeTemplates(args.nodeTypes, templateLimit);
case 'get_template': case 'get_template':
return this.getTemplate(args.templateId); this.validateToolParams(name, args, ['templateId']);
const templateId = Number(args.templateId);
return this.getTemplate(templateId);
case 'search_templates': case 'search_templates':
return this.searchTemplates(args.query, args.limit); this.validateToolParams(name, args, ['query']);
const searchLimit = args.limit !== undefined ? Number(args.limit) || 20 : 20;
return this.searchTemplates(args.query, searchLimit);
case 'get_templates_for_task': case 'get_templates_for_task':
this.validateToolParams(name, args, ['task']);
return this.getTemplatesForTask(args.task); return this.getTemplatesForTask(args.task);
case 'validate_workflow': case 'validate_workflow':
this.validateToolParams(name, args, ['workflow']);
return this.validateWorkflow(args.workflow, args.options); return this.validateWorkflow(args.workflow, args.options);
case 'validate_workflow_connections': case 'validate_workflow_connections':
this.validateToolParams(name, args, ['workflow']);
return this.validateWorkflowConnections(args.workflow); return this.validateWorkflowConnections(args.workflow);
case 'validate_workflow_expressions': case 'validate_workflow_expressions':
this.validateToolParams(name, args, ['workflow']);
return this.validateWorkflowExpressions(args.workflow); return this.validateWorkflowExpressions(args.workflow);
// n8n Management Tools (if API is configured) // n8n Management Tools (if API is configured)
case 'n8n_create_workflow': case 'n8n_create_workflow':
this.validateToolParams(name, args, ['name', 'nodes', 'connections']);
return n8nHandlers.handleCreateWorkflow(args); return n8nHandlers.handleCreateWorkflow(args);
case 'n8n_get_workflow': case 'n8n_get_workflow':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleGetWorkflow(args); return n8nHandlers.handleGetWorkflow(args);
case 'n8n_get_workflow_details': case 'n8n_get_workflow_details':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleGetWorkflowDetails(args); return n8nHandlers.handleGetWorkflowDetails(args);
case 'n8n_get_workflow_structure': case 'n8n_get_workflow_structure':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleGetWorkflowStructure(args); return n8nHandlers.handleGetWorkflowStructure(args);
case 'n8n_get_workflow_minimal': case 'n8n_get_workflow_minimal':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleGetWorkflowMinimal(args); return n8nHandlers.handleGetWorkflowMinimal(args);
case 'n8n_update_full_workflow': case 'n8n_update_full_workflow':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleUpdateWorkflow(args); return n8nHandlers.handleUpdateWorkflow(args);
case 'n8n_update_partial_workflow': case 'n8n_update_partial_workflow':
this.validateToolParams(name, args, ['id', 'operations']);
return handleUpdatePartialWorkflow(args); return handleUpdatePartialWorkflow(args);
case 'n8n_delete_workflow': case 'n8n_delete_workflow':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleDeleteWorkflow(args); return n8nHandlers.handleDeleteWorkflow(args);
case 'n8n_list_workflows': case 'n8n_list_workflows':
// No required parameters
return n8nHandlers.handleListWorkflows(args); return n8nHandlers.handleListWorkflows(args);
case 'n8n_validate_workflow': case 'n8n_validate_workflow':
this.validateToolParams(name, args, ['id']);
await this.ensureInitialized(); await this.ensureInitialized();
if (!this.repository) throw new Error('Repository not initialized'); if (!this.repository) throw new Error('Repository not initialized');
return n8nHandlers.handleValidateWorkflow(args, this.repository); return n8nHandlers.handleValidateWorkflow(args, this.repository);
case 'n8n_trigger_webhook_workflow': case 'n8n_trigger_webhook_workflow':
this.validateToolParams(name, args, ['webhookUrl']);
return n8nHandlers.handleTriggerWebhookWorkflow(args); return n8nHandlers.handleTriggerWebhookWorkflow(args);
case 'n8n_get_execution': case 'n8n_get_execution':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleGetExecution(args); return n8nHandlers.handleGetExecution(args);
case 'n8n_list_executions': case 'n8n_list_executions':
// No required parameters
return n8nHandlers.handleListExecutions(args); return n8nHandlers.handleListExecutions(args);
case 'n8n_delete_execution': case 'n8n_delete_execution':
this.validateToolParams(name, args, ['id']);
return n8nHandlers.handleDeleteExecution(args); return n8nHandlers.handleDeleteExecution(args);
case 'n8n_health_check': case 'n8n_health_check':
// No required parameters
return n8nHandlers.handleHealthCheck(); return n8nHandlers.handleHealthCheck();
case 'n8n_list_available_tools': case 'n8n_list_available_tools':
// No required parameters
return n8nHandlers.handleListAvailableTools(); return n8nHandlers.handleListAvailableTools();
case 'n8n_diagnostic': case 'n8n_diagnostic':
// No required parameters
return n8nHandlers.handleDiagnostic({ params: { arguments: args } }); return n8nHandlers.handleDiagnostic({ params: { arguments: args } });
default: default:

View File

@@ -63,8 +63,8 @@ describe('MCP Error Handling', () => {
expect.fail('Should have thrown an error'); expect.fail('Should have thrown an error');
} catch (error: any) { } catch (error: any) {
expect(error).toBeDefined(); expect(error).toBeDefined();
// The error occurs when trying to call startsWith on undefined nodeType // The error now properly validates required parameters
expect(error.message).toContain("Cannot read properties of undefined"); expect(error.message).toContain("Missing required parameters");
} }
}); });
@@ -500,8 +500,8 @@ describe('MCP Error Handling', () => {
expect.fail('Should have thrown an error'); expect.fail('Should have thrown an error');
} catch (error: any) { } catch (error: any) {
expect(error).toBeDefined(); expect(error).toBeDefined();
// The error occurs when trying to access properties of undefined query // The error now properly validates required parameters
expect(error.message).toContain("Cannot read properties of undefined"); expect(error.message).toContain("Missing required parameters");
} }
}); });

View File

@@ -0,0 +1,563 @@
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { N8NDocumentationMCPServer } from '../../../src/mcp/server';
// Mock the database and dependencies
vi.mock('../../../src/database/database-adapter');
vi.mock('../../../src/database/node-repository');
vi.mock('../../../src/templates/template-service');
vi.mock('../../../src/utils/logger');
class TestableN8NMCPServer extends N8NDocumentationMCPServer {
// Expose the private validateToolParams method for testing
public testValidateToolParams(toolName: string, args: any, requiredParams: string[]): void {
return (this as any).validateToolParams(toolName, args, requiredParams);
}
// Expose the private executeTool method for testing
public async testExecuteTool(name: string, args: any): Promise<any> {
return (this as any).executeTool(name, args);
}
}
describe('Parameter Validation', () => {
let server: TestableN8NMCPServer;
beforeEach(() => {
// Set environment variable to use in-memory database
process.env.NODE_DB_PATH = ':memory:';
server = new TestableN8NMCPServer();
});
afterEach(() => {
delete process.env.NODE_DB_PATH;
});
describe('validateToolParams', () => {
describe('Basic Parameter Validation', () => {
it('should pass validation when all required parameters are provided', () => {
const args = { nodeType: 'nodes-base.httpRequest', config: {} };
expect(() => {
server.testValidateToolParams('test_tool', args, ['nodeType', 'config']);
}).not.toThrow();
});
it('should throw error when required parameter is missing', () => {
const args = { config: {} };
expect(() => {
server.testValidateToolParams('test_tool', args, ['nodeType', 'config']);
}).toThrow('Missing required parameters for test_tool: nodeType');
});
it('should throw error when multiple required parameters are missing', () => {
const args = {};
expect(() => {
server.testValidateToolParams('test_tool', args, ['nodeType', 'config', 'query']);
}).toThrow('Missing required parameters for test_tool: nodeType, config, query');
});
it('should throw error when required parameter is undefined', () => {
const args = { nodeType: undefined, config: {} };
expect(() => {
server.testValidateToolParams('test_tool', args, ['nodeType', 'config']);
}).toThrow('Missing required parameters for test_tool: nodeType');
});
it('should throw error when required parameter is null', () => {
const args = { nodeType: null, config: {} };
expect(() => {
server.testValidateToolParams('test_tool', args, ['nodeType', 'config']);
}).toThrow('Missing required parameters for test_tool: nodeType');
});
it('should pass when required parameter is empty string', () => {
const args = { query: '', limit: 10 };
expect(() => {
server.testValidateToolParams('test_tool', args, ['query']);
}).not.toThrow();
});
it('should pass when required parameter is zero', () => {
const args = { limit: 0, query: 'test' };
expect(() => {
server.testValidateToolParams('test_tool', args, ['limit']);
}).not.toThrow();
});
it('should pass when required parameter is false', () => {
const args = { includeData: false, id: '123' };
expect(() => {
server.testValidateToolParams('test_tool', args, ['includeData']);
}).not.toThrow();
});
});
describe('Edge Cases', () => {
it('should handle empty args object', () => {
expect(() => {
server.testValidateToolParams('test_tool', {}, ['param1']);
}).toThrow('Missing required parameters for test_tool: param1');
});
it('should handle null args', () => {
expect(() => {
server.testValidateToolParams('test_tool', null, ['param1']);
}).toThrow();
});
it('should handle undefined args', () => {
expect(() => {
server.testValidateToolParams('test_tool', undefined, ['param1']);
}).toThrow();
});
it('should pass when no required parameters are specified', () => {
const args = { optionalParam: 'value' };
expect(() => {
server.testValidateToolParams('test_tool', args, []);
}).not.toThrow();
});
it('should handle special characters in parameter names', () => {
const args = { 'param-with-dash': 'value', 'param_with_underscore': 'value' };
expect(() => {
server.testValidateToolParams('test_tool', args, ['param-with-dash', 'param_with_underscore']);
}).not.toThrow();
});
});
});
describe('Tool-Specific Parameter Validation', () => {
// Mock the actual tool methods to avoid database calls
beforeEach(() => {
// Mock all the tool methods that would be called
vi.spyOn(server as any, 'getNodeInfo').mockResolvedValue({ mockResult: true });
vi.spyOn(server as any, 'searchNodes').mockResolvedValue({ results: [] });
vi.spyOn(server as any, 'getNodeDocumentation').mockResolvedValue({ docs: 'test' });
vi.spyOn(server as any, 'getNodeEssentials').mockResolvedValue({ essentials: true });
vi.spyOn(server as any, 'searchNodeProperties').mockResolvedValue({ properties: [] });
vi.spyOn(server as any, 'getNodeForTask').mockResolvedValue({ node: 'test' });
vi.spyOn(server as any, 'validateNodeConfig').mockResolvedValue({ valid: true });
vi.spyOn(server as any, 'validateNodeMinimal').mockResolvedValue({ missing: [] });
vi.spyOn(server as any, 'getPropertyDependencies').mockResolvedValue({ dependencies: {} });
vi.spyOn(server as any, 'getNodeAsToolInfo').mockResolvedValue({ toolInfo: true });
vi.spyOn(server as any, 'listNodeTemplates').mockResolvedValue({ templates: [] });
vi.spyOn(server as any, 'getTemplate').mockResolvedValue({ template: {} });
vi.spyOn(server as any, 'searchTemplates').mockResolvedValue({ templates: [] });
vi.spyOn(server as any, 'getTemplatesForTask').mockResolvedValue({ templates: [] });
vi.spyOn(server as any, 'validateWorkflow').mockResolvedValue({ valid: true });
vi.spyOn(server as any, 'validateWorkflowConnections').mockResolvedValue({ valid: true });
vi.spyOn(server as any, 'validateWorkflowExpressions').mockResolvedValue({ valid: true });
});
describe('get_node_info', () => {
it('should require nodeType parameter', async () => {
await expect(server.testExecuteTool('get_node_info', {}))
.rejects.toThrow('Missing required parameters for get_node_info: nodeType');
});
it('should succeed with valid nodeType', async () => {
const result = await server.testExecuteTool('get_node_info', {
nodeType: 'nodes-base.httpRequest'
});
expect(result).toEqual({ mockResult: true });
});
});
describe('search_nodes', () => {
it('should require query parameter', async () => {
await expect(server.testExecuteTool('search_nodes', {}))
.rejects.toThrow('Missing required parameters for search_nodes: query');
});
it('should succeed with valid query', async () => {
const result = await server.testExecuteTool('search_nodes', {
query: 'http'
});
expect(result).toEqual({ results: [] });
});
it('should handle optional limit parameter', async () => {
const result = await server.testExecuteTool('search_nodes', {
query: 'http',
limit: 10
});
expect(result).toEqual({ results: [] });
});
it('should convert limit to number and use default on invalid value', async () => {
const result = await server.testExecuteTool('search_nodes', {
query: 'http',
limit: 'invalid'
});
expect(result).toEqual({ results: [] });
});
});
describe('validate_node_operation', () => {
it('should require nodeType and config parameters', async () => {
await expect(server.testExecuteTool('validate_node_operation', {}))
.rejects.toThrow('Missing required parameters for validate_node_operation: nodeType, config');
});
it('should require nodeType parameter when config is provided', async () => {
await expect(server.testExecuteTool('validate_node_operation', { config: {} }))
.rejects.toThrow('Missing required parameters for validate_node_operation: nodeType');
});
it('should require config parameter when nodeType is provided', async () => {
await expect(server.testExecuteTool('validate_node_operation', { nodeType: 'nodes-base.httpRequest' }))
.rejects.toThrow('Missing required parameters for validate_node_operation: config');
});
it('should succeed with valid parameters', async () => {
const result = await server.testExecuteTool('validate_node_operation', {
nodeType: 'nodes-base.httpRequest',
config: { method: 'GET', url: 'https://api.example.com' }
});
expect(result).toEqual({ valid: true });
});
});
describe('search_node_properties', () => {
it('should require nodeType and query parameters', async () => {
await expect(server.testExecuteTool('search_node_properties', {}))
.rejects.toThrow('Missing required parameters for search_node_properties: nodeType, query');
});
it('should succeed with valid parameters', async () => {
const result = await server.testExecuteTool('search_node_properties', {
nodeType: 'nodes-base.httpRequest',
query: 'auth'
});
expect(result).toEqual({ properties: [] });
});
it('should handle optional maxResults parameter', async () => {
const result = await server.testExecuteTool('search_node_properties', {
nodeType: 'nodes-base.httpRequest',
query: 'auth',
maxResults: 5
});
expect(result).toEqual({ properties: [] });
});
});
describe('list_node_templates', () => {
it('should require nodeTypes parameter', async () => {
await expect(server.testExecuteTool('list_node_templates', {}))
.rejects.toThrow('Missing required parameters for list_node_templates: nodeTypes');
});
it('should succeed with valid nodeTypes array', async () => {
const result = await server.testExecuteTool('list_node_templates', {
nodeTypes: ['nodes-base.httpRequest', 'nodes-base.slack']
});
expect(result).toEqual({ templates: [] });
});
});
describe('get_template', () => {
it('should require templateId parameter', async () => {
await expect(server.testExecuteTool('get_template', {}))
.rejects.toThrow('Missing required parameters for get_template: templateId');
});
it('should succeed with valid templateId', async () => {
const result = await server.testExecuteTool('get_template', {
templateId: 123
});
expect(result).toEqual({ template: {} });
});
});
});
describe('Numeric Parameter Conversion', () => {
beforeEach(() => {
vi.spyOn(server as any, 'searchNodes').mockResolvedValue({ results: [] });
vi.spyOn(server as any, 'searchNodeProperties').mockResolvedValue({ properties: [] });
vi.spyOn(server as any, 'listNodeTemplates').mockResolvedValue({ templates: [] });
vi.spyOn(server as any, 'getTemplate').mockResolvedValue({ template: {} });
});
describe('limit parameter conversion', () => {
it('should convert string numbers to numbers', async () => {
const mockSearchNodes = vi.spyOn(server as any, 'searchNodes');
await server.testExecuteTool('search_nodes', {
query: 'test',
limit: '15'
});
expect(mockSearchNodes).toHaveBeenCalledWith('test', 15, { mode: undefined });
});
it('should use default when limit is invalid string', async () => {
const mockSearchNodes = vi.spyOn(server as any, 'searchNodes');
await server.testExecuteTool('search_nodes', {
query: 'test',
limit: 'invalid'
});
expect(mockSearchNodes).toHaveBeenCalledWith('test', 20, { mode: undefined });
});
it('should use default when limit is undefined', async () => {
const mockSearchNodes = vi.spyOn(server as any, 'searchNodes');
await server.testExecuteTool('search_nodes', {
query: 'test'
});
expect(mockSearchNodes).toHaveBeenCalledWith('test', 20, { mode: undefined });
});
it('should handle zero as valid limit', async () => {
const mockSearchNodes = vi.spyOn(server as any, 'searchNodes');
await server.testExecuteTool('search_nodes', {
query: 'test',
limit: 0
});
expect(mockSearchNodes).toHaveBeenCalledWith('test', 20, { mode: undefined }); // 0 converts to falsy, uses default
});
});
describe('maxResults parameter conversion', () => {
it('should convert string numbers to numbers', async () => {
const mockSearchNodeProperties = vi.spyOn(server as any, 'searchNodeProperties');
await server.testExecuteTool('search_node_properties', {
nodeType: 'nodes-base.httpRequest',
query: 'auth',
maxResults: '5'
});
expect(mockSearchNodeProperties).toHaveBeenCalledWith('nodes-base.httpRequest', 'auth', 5);
});
it('should use default when maxResults is invalid', async () => {
const mockSearchNodeProperties = vi.spyOn(server as any, 'searchNodeProperties');
await server.testExecuteTool('search_node_properties', {
nodeType: 'nodes-base.httpRequest',
query: 'auth',
maxResults: 'invalid'
});
expect(mockSearchNodeProperties).toHaveBeenCalledWith('nodes-base.httpRequest', 'auth', 20);
});
});
describe('templateLimit parameter conversion', () => {
it('should convert string numbers to numbers', async () => {
const mockListNodeTemplates = vi.spyOn(server as any, 'listNodeTemplates');
await server.testExecuteTool('list_node_templates', {
nodeTypes: ['nodes-base.httpRequest'],
limit: '5'
});
expect(mockListNodeTemplates).toHaveBeenCalledWith(['nodes-base.httpRequest'], 5);
});
it('should use default when templateLimit is invalid', async () => {
const mockListNodeTemplates = vi.spyOn(server as any, 'listNodeTemplates');
await server.testExecuteTool('list_node_templates', {
nodeTypes: ['nodes-base.httpRequest'],
limit: 'invalid'
});
expect(mockListNodeTemplates).toHaveBeenCalledWith(['nodes-base.httpRequest'], 10);
});
});
describe('templateId parameter handling', () => {
it('should pass through numeric templateId', async () => {
const mockGetTemplate = vi.spyOn(server as any, 'getTemplate');
await server.testExecuteTool('get_template', {
templateId: 123
});
expect(mockGetTemplate).toHaveBeenCalledWith(123);
});
it('should convert string templateId to number', async () => {
const mockGetTemplate = vi.spyOn(server as any, 'getTemplate');
await server.testExecuteTool('get_template', {
templateId: '123'
});
expect(mockGetTemplate).toHaveBeenCalledWith(123);
});
});
});
describe('Tools with No Required Parameters', () => {
beforeEach(() => {
vi.spyOn(server as any, 'getToolsDocumentation').mockResolvedValue({ docs: 'test' });
vi.spyOn(server as any, 'listNodes').mockResolvedValue({ nodes: [] });
vi.spyOn(server as any, 'listAITools').mockResolvedValue({ tools: [] });
vi.spyOn(server as any, 'getDatabaseStatistics').mockResolvedValue({ stats: {} });
vi.spyOn(server as any, 'listTasks').mockResolvedValue({ tasks: [] });
});
it('should allow tools_documentation with no parameters', async () => {
const result = await server.testExecuteTool('tools_documentation', {});
expect(result).toEqual({ docs: 'test' });
});
it('should allow list_nodes with no parameters', async () => {
const result = await server.testExecuteTool('list_nodes', {});
expect(result).toEqual({ nodes: [] });
});
it('should allow list_ai_tools with no parameters', async () => {
const result = await server.testExecuteTool('list_ai_tools', {});
expect(result).toEqual({ tools: [] });
});
it('should allow get_database_statistics with no parameters', async () => {
const result = await server.testExecuteTool('get_database_statistics', {});
expect(result).toEqual({ stats: {} });
});
it('should allow list_tasks with no parameters', async () => {
const result = await server.testExecuteTool('list_tasks', {});
expect(result).toEqual({ tasks: [] });
});
});
describe('Error Message Quality', () => {
it('should provide clear error messages with tool name', () => {
expect(() => {
server.testValidateToolParams('get_node_info', {}, ['nodeType']);
}).toThrow('Missing required parameters for get_node_info: nodeType. Please provide the required parameters to use this tool.');
});
it('should list all missing parameters', () => {
expect(() => {
server.testValidateToolParams('validate_node_operation', { profile: 'strict' }, ['nodeType', 'config']);
}).toThrow('Missing required parameters for validate_node_operation: nodeType, config');
});
it('should include helpful guidance', () => {
try {
server.testValidateToolParams('test_tool', {}, ['param1', 'param2']);
} catch (error: any) {
expect(error.message).toContain('Please provide the required parameters to use this tool');
}
});
});
describe('MCP Error Response Handling', () => {
it('should convert validation errors to MCP error responses rather than throwing exceptions', async () => {
// This test simulates what happens at the MCP level when a tool validation fails
// The server should catch the validation error and return it as an MCP error response
// Directly test the executeTool method to ensure it throws appropriately
// The MCP server's request handler should catch these and convert to error responses
await expect(server.testExecuteTool('get_node_info', {}))
.rejects.toThrow('Missing required parameters for get_node_info: nodeType');
await expect(server.testExecuteTool('search_nodes', {}))
.rejects.toThrow('Missing required parameters for search_nodes: query');
await expect(server.testExecuteTool('validate_node_operation', { nodeType: 'test' }))
.rejects.toThrow('Missing required parameters for validate_node_operation: config');
});
it('should handle edge cases in parameter validation gracefully', async () => {
// Test with null args (should be handled by args = args || {})
await expect(server.testExecuteTool('get_node_info', null))
.rejects.toThrow('Missing required parameters');
// Test with undefined args
await expect(server.testExecuteTool('get_node_info', undefined))
.rejects.toThrow('Missing required parameters');
});
it('should provide consistent error format across all tools', async () => {
const toolsWithRequiredParams = [
{ name: 'get_node_info', args: {}, missing: 'nodeType' },
{ name: 'search_nodes', args: {}, missing: 'query' },
{ name: 'get_node_documentation', args: {}, missing: 'nodeType' },
{ name: 'get_node_essentials', args: {}, missing: 'nodeType' },
{ name: 'search_node_properties', args: {}, missing: 'nodeType, query' },
{ name: 'get_node_for_task', args: {}, missing: 'task' },
{ name: 'validate_node_operation', args: {}, missing: 'nodeType, config' },
{ name: 'validate_node_minimal', args: {}, missing: 'nodeType, config' },
{ name: 'get_property_dependencies', args: {}, missing: 'nodeType' },
{ name: 'get_node_as_tool_info', args: {}, missing: 'nodeType' },
{ name: 'list_node_templates', args: {}, missing: 'nodeTypes' },
{ name: 'get_template', args: {}, missing: 'templateId' },
];
for (const tool of toolsWithRequiredParams) {
await expect(server.testExecuteTool(tool.name, tool.args))
.rejects.toThrow(`Missing required parameters for ${tool.name}: ${tool.missing}`);
}
});
it('should validate n8n management tools parameters', async () => {
// Mock the n8n handlers to avoid actual API calls
const mockHandlers = [
'handleCreateWorkflow',
'handleGetWorkflow',
'handleGetWorkflowDetails',
'handleGetWorkflowStructure',
'handleGetWorkflowMinimal',
'handleUpdateWorkflow',
'handleDeleteWorkflow',
'handleValidateWorkflow',
'handleTriggerWebhookWorkflow',
'handleGetExecution',
'handleDeleteExecution'
];
for (const handler of mockHandlers) {
vi.doMock('../../../src/mcp/handlers-n8n-manager', () => ({
[handler]: vi.fn().mockResolvedValue({ success: true })
}));
}
vi.doMock('../../../src/mcp/handlers-workflow-diff', () => ({
handleUpdatePartialWorkflow: vi.fn().mockResolvedValue({ success: true })
}));
const n8nToolsWithRequiredParams = [
{ name: 'n8n_create_workflow', args: {}, missing: 'name, nodes, connections' },
{ name: 'n8n_get_workflow', args: {}, missing: 'id' },
{ name: 'n8n_get_workflow_details', args: {}, missing: 'id' },
{ name: 'n8n_get_workflow_structure', args: {}, missing: 'id' },
{ name: 'n8n_get_workflow_minimal', args: {}, missing: 'id' },
{ name: 'n8n_update_full_workflow', args: {}, missing: 'id' },
{ name: 'n8n_update_partial_workflow', args: {}, missing: 'id, operations' },
{ name: 'n8n_delete_workflow', args: {}, missing: 'id' },
{ name: 'n8n_validate_workflow', args: {}, missing: 'id' },
{ name: 'n8n_trigger_webhook_workflow', args: {}, missing: 'webhookUrl' },
{ name: 'n8n_get_execution', args: {}, missing: 'id' },
{ name: 'n8n_delete_execution', args: {}, missing: 'id' },
];
for (const tool of n8nToolsWithRequiredParams) {
await expect(server.testExecuteTool(tool.name, tool.args))
.rejects.toThrow(`Missing required parameters for ${tool.name}: ${tool.missing}`);
}
});
});
});