feat: Tool Consolidation - Reduce MCP Tools by 38% (v2.26.0) (#439)

* feat: Remove 9 low-value tools and consolidate n8n_health_check (v2.25.0)

Telemetry-driven tool cleanup to improve API clarity:

**Removed Tools (9):**
- list_nodes - Use search_nodes instead
- list_ai_tools - Use search_nodes with isAITool filter
- list_tasks - Low usage (0.02%)
- get_database_statistics - Use n8n_health_check
- list_templates - Use search_templates or get_templates_for_task
- get_node_as_tool_info - Documented in get_node
- validate_workflow_connections - Use validate_workflow
- validate_workflow_expressions - Use validate_workflow
- n8n_list_available_tools - Use n8n_health_check
- n8n_diagnostic - Merged into n8n_health_check

**Consolidated Tool:**
- n8n_health_check now supports mode='diagnostic' for detailed troubleshooting

**Tool Count:**
- Before: 38 tools
- After: 31 tools (18% reduction)

Concieved by Romuald Członkowski - www.aiadvisors.pl/en

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

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: cleanup stale references and update tests after tool removal

- Remove handleListAvailableTools dead code from handlers-n8n-manager.ts
- Update error messages to reference n8n_health_check(mode="diagnostic") instead of n8n_diagnostic
- Update tool counts in diagnostic messages (14 doc tools, 31 total)
- Fix error-handling.test.ts to use valid tools (search_nodes, tools_documentation)
- Remove obsolete list-tools.test.ts integration tests
- Remove unused ListToolsResponse type from response-types.ts
- Update tools.ts QUICK REFERENCE to remove list_nodes references
- Update tools-documentation.ts to remove references to removed tools
- Update tool-docs files to remove stale relatedTools references
- Fix tools.test.ts to not test removed tools (list_nodes, list_ai_tools, etc.)
- Fix parameter-validation.test.ts to not test removed tools
- Update handlers-n8n-manager.test.ts error message expectations

All 399 MCP unit tests now pass.

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>

* fix: update integration tests to use valid tools after v2.25.0 removal

Replaced all references to removed tools in integration tests:
- list_nodes -> search_nodes
- get_database_statistics -> tools_documentation
- list_ai_tools -> search_nodes/tools_documentation
- list_tasks -> tools_documentation
- get_node_as_tool_info -> removed test section

Updated test files:
- tests/integration/mcp-protocol/basic-connection.test.ts
- tests/integration/mcp-protocol/performance.test.ts
- tests/integration/mcp-protocol/session-management.test.ts
- tests/integration/mcp-protocol/test-helpers.ts
- tests/integration/mcp-protocol/tool-invocation.test.ts
- tests/integration/telemetry/mcp-telemetry.test.ts
- tests/unit/mcp/disabled-tools.test.ts
- tests/unit/mcp/tools-documentation.test.ts

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>

* feat: Tool consolidation v2.26.0 - reduce tools by 38% (31 → 19)

Major consolidation of MCP tools using mode-based parameters for better
AI agent ergonomics:

Node Tools:
- get_node_documentation → get_node with mode='documentation'
- search_node_properties → get_node with mode='search_properties'
- get_property_dependencies → removed

Validation Tools:
- validate_node_operation + validate_node_minimal → validate_node with mode param

Template Tools:
- list_node_templates → search_templates with searchMode='nodes'
- search_templates_by_metadata → search_templates with searchMode='metadata'
- get_templates_for_task → search_templates with searchMode='task'

Workflow Getters:
- n8n_get_workflow_details/structure/minimal → n8n_get_workflow with mode param

Execution Tools:
- n8n_list/get/delete_execution → n8n_executions with action param

Test updates for all consolidated tools.

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

Co-Authored-By: Claude <noreply@anthropic.com>

Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en

* docs: comprehensive README update for v2.26.0 tool consolidation

- Quick Start: Added hosted service (dashboard.n8n-mcp.com) as primary option
- Self-hosting: Renamed options to A (npx), B (Docker), C (Local), D (Railway)
- Removed: "Memory Leak Fix (v2.20.2)" section (outdated)
- Removed: "Known Issues" section (outdated container management)
- Claude Project Setup: Updated all tool references to v2.26.0 consolidated tools
  - validate_node({mode: 'minimal'|'full'}) instead of separate tools
  - search_templates({searchMode: ...}) unified template search
  - get_node({mode: 'docs'|'search_properties'}) for documentation
  - n8n_executions({action: ...}) unified execution management
- Available MCP Tools: Updated to show 19 consolidated tools (7 core + 12 mgmt)
- Recent Updates: Simplified to just link to CHANGELOG.md

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

Co-Authored-By: Claude <noreply@anthropic.com>

Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en

* fix: update tool count from 31 to 19 in diagnostic message

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

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(tests): update tool count expectations for v2.26.0

Update handlers-n8n-manager.test.ts to expect new consolidated
tool counts (7/12/19) after v2.26.0 tool consolidation.

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>

---------

Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Romuald Członkowski
2025-11-25 18:39:00 +01:00
committed by GitHub
parent 9ee4b9492f
commit ff69e4ccca
28 changed files with 925 additions and 1766 deletions

View File

@@ -1,207 +0,0 @@
/**
* Integration Tests: handleListAvailableTools
*
* Tests tool listing functionality.
* Covers tool discovery and configuration status.
*/
import { describe, it, expect, beforeEach } from 'vitest';
import { createMcpContext } from '../utils/mcp-context';
import { InstanceContext } from '../../../../src/types/instance-context';
import { handleListAvailableTools } from '../../../../src/mcp/handlers-n8n-manager';
import { ListToolsResponse } from '../utils/response-types';
describe('Integration: handleListAvailableTools', () => {
let mcpContext: InstanceContext;
beforeEach(() => {
mcpContext = createMcpContext();
});
// ======================================================================
// List All Tools
// ======================================================================
describe('Tool Listing', () => {
it('should list all available tools organized by category', async () => {
const response = await handleListAvailableTools(mcpContext);
expect(response.success).toBe(true);
expect(response.data).toBeDefined();
const data = response.data as ListToolsResponse;
// Verify tools array exists
expect(data).toHaveProperty('tools');
expect(Array.isArray(data.tools)).toBe(true);
expect(data.tools.length).toBeGreaterThan(0);
// Verify tool categories
const categories = data.tools.map((cat: any) => cat.category);
expect(categories).toContain('Workflow Management');
expect(categories).toContain('Execution Management');
expect(categories).toContain('System');
// Verify each category has tools
data.tools.forEach(category => {
expect(category).toHaveProperty('category');
expect(category).toHaveProperty('tools');
expect(Array.isArray(category.tools)).toBe(true);
expect(category.tools.length).toBeGreaterThan(0);
// Verify each tool has required fields
category.tools.forEach(tool => {
expect(tool).toHaveProperty('name');
expect(tool).toHaveProperty('description');
expect(typeof tool.name).toBe('string');
expect(typeof tool.description).toBe('string');
});
});
});
it('should include API configuration status', async () => {
const response = await handleListAvailableTools(mcpContext);
expect(response.success).toBe(true);
const data = response.data as ListToolsResponse;
// Verify configuration status
expect(data).toHaveProperty('apiConfigured');
expect(typeof data.apiConfigured).toBe('boolean');
// Since tests run with API configured, should be true
expect(data.apiConfigured).toBe(true);
// Verify configuration details are present when configured
if (data.apiConfigured) {
expect(data).toHaveProperty('configuration');
expect(data.configuration).toBeDefined();
expect(data.configuration).toHaveProperty('apiUrl');
expect(data.configuration).toHaveProperty('timeout');
expect(data.configuration).toHaveProperty('maxRetries');
}
});
it('should include API limitations information', async () => {
const response = await handleListAvailableTools(mcpContext);
expect(response.success).toBe(true);
const data = response.data as ListToolsResponse;
// Verify limitations are documented
expect(data).toHaveProperty('limitations');
expect(Array.isArray(data.limitations)).toBe(true);
expect(data.limitations.length).toBeGreaterThan(0);
// Verify limitations are informative strings
data.limitations.forEach(limitation => {
expect(typeof limitation).toBe('string');
expect(limitation.length).toBeGreaterThan(0);
});
// Common known limitations
const limitationsText = data.limitations.join(' ');
expect(limitationsText).toContain('Cannot execute workflows directly');
});
});
// ======================================================================
// Workflow Management Tools
// ======================================================================
describe('Workflow Management Tools', () => {
it('should include all workflow management tools', async () => {
const response = await handleListAvailableTools(mcpContext);
const data = response.data as ListToolsResponse;
const workflowCategory = data.tools.find(cat => cat.category === 'Workflow Management');
expect(workflowCategory).toBeDefined();
const toolNames = workflowCategory!.tools.map(t => t.name);
// Core workflow tools
expect(toolNames).toContain('n8n_create_workflow');
expect(toolNames).toContain('n8n_get_workflow');
expect(toolNames).toContain('n8n_update_workflow');
expect(toolNames).toContain('n8n_delete_workflow');
expect(toolNames).toContain('n8n_list_workflows');
// Enhanced workflow tools
expect(toolNames).toContain('n8n_get_workflow_details');
expect(toolNames).toContain('n8n_get_workflow_structure');
expect(toolNames).toContain('n8n_get_workflow_minimal');
expect(toolNames).toContain('n8n_validate_workflow');
expect(toolNames).toContain('n8n_autofix_workflow');
});
});
// ======================================================================
// Execution Management Tools
// ======================================================================
describe('Execution Management Tools', () => {
it('should include all execution management tools', async () => {
const response = await handleListAvailableTools(mcpContext);
const data = response.data as ListToolsResponse;
const executionCategory = data.tools.find(cat => cat.category === 'Execution Management');
expect(executionCategory).toBeDefined();
const toolNames = executionCategory!.tools.map(t => t.name);
expect(toolNames).toContain('n8n_trigger_webhook_workflow');
expect(toolNames).toContain('n8n_get_execution');
expect(toolNames).toContain('n8n_list_executions');
expect(toolNames).toContain('n8n_delete_execution');
});
});
// ======================================================================
// System Tools
// ======================================================================
describe('System Tools', () => {
it('should include system tools', async () => {
const response = await handleListAvailableTools(mcpContext);
const data = response.data as ListToolsResponse;
const systemCategory = data.tools.find(cat => cat.category === 'System');
expect(systemCategory).toBeDefined();
const toolNames = systemCategory!.tools.map(t => t.name);
expect(toolNames).toContain('n8n_health_check');
expect(toolNames).toContain('n8n_list_available_tools');
});
});
// ======================================================================
// Response Format Verification
// ======================================================================
describe('Response Format', () => {
it('should return complete tool list response structure', async () => {
const response = await handleListAvailableTools(mcpContext);
expect(response.success).toBe(true);
expect(response.data).toBeDefined();
const data = response.data as ListToolsResponse;
// Verify all required fields
expect(data).toHaveProperty('tools');
expect(data).toHaveProperty('apiConfigured');
expect(data).toHaveProperty('limitations');
// Verify optional configuration field
if (data.apiConfigured) {
expect(data).toHaveProperty('configuration');
}
// Verify data types
expect(Array.isArray(data.tools)).toBe(true);
expect(typeof data.apiConfigured).toBe('boolean');
expect(Array.isArray(data.limitations)).toBe(true);
});
});
});

View File

@@ -19,29 +19,6 @@ export interface HealthCheckResponse {
[key: string]: any; // Allow dynamic property access for optional field checks
}
export interface ToolDefinition {
name: string;
description: string;
}
export interface ToolCategory {
category: string;
tools: ToolDefinition[];
}
export interface ApiConfiguration {
apiUrl: string;
timeout: number;
maxRetries: number;
}
export interface ListToolsResponse {
tools: ToolCategory[];
apiConfigured: boolean;
configuration?: ApiConfiguration | null;
limitations: string[];
}
export interface ApiStatus {
configured: boolean;
connected: boolean;