mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-03-19 08:53:09 +00:00
c1a6347d4f
- Migrated all 40 MCP tools documentation to modular structure - Created comprehensive documentation with both essentials and full details - Organized tools by category: discovery, configuration, validation, templates, workflow_management, system, special - Fixed all TODO placeholders with informative, precise content - Each tool now has concise description, key tips, and full documentation - Improved documentation quality: 30-40% more concise while maintaining usefulness - Fixed TypeScript compilation issues and removed orphaned content - All tools accessible via tools_documentation MCP endpoint - Build successful with zero errors 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
50 lines
2.0 KiB
TypeScript
50 lines
2.0 KiB
TypeScript
import { ToolDocumentation } from '../types';
|
|
|
|
export const n8nDeleteWorkflowDoc: ToolDocumentation = {
|
|
name: 'n8n_delete_workflow',
|
|
category: 'workflow_management',
|
|
essentials: {
|
|
description: 'Permanently delete a workflow. This action cannot be undone.',
|
|
keyParameters: ['id'],
|
|
example: 'n8n_delete_workflow({id: "workflow_123"})',
|
|
performance: 'Fast (50-150ms)',
|
|
tips: [
|
|
'Action is irreversible',
|
|
'Deletes all execution history',
|
|
'Check workflow first with get_minimal'
|
|
]
|
|
},
|
|
full: {
|
|
description: 'Permanently deletes a workflow from n8n including all associated data, execution history, and settings. This is an irreversible operation that should be used with caution. The workflow must exist and the user must have appropriate permissions.',
|
|
parameters: {
|
|
id: { type: 'string', required: true, description: 'Workflow ID to delete permanently' }
|
|
},
|
|
returns: 'Success confirmation or error if workflow not found/cannot be deleted',
|
|
examples: [
|
|
'n8n_delete_workflow({id: "abc123"}) - Delete specific workflow',
|
|
'if (confirm) { n8n_delete_workflow({id: wf.id}); } // With confirmation'
|
|
],
|
|
useCases: [
|
|
'Remove obsolete workflows',
|
|
'Clean up test workflows',
|
|
'Delete failed experiments',
|
|
'Manage workflow limits',
|
|
'Remove duplicates'
|
|
],
|
|
performance: 'Fast operation - typically 50-150ms. May take longer if workflow has extensive execution history.',
|
|
bestPractices: [
|
|
'Always confirm before deletion',
|
|
'Check workflow with get_minimal first',
|
|
'Consider deactivating instead of deleting',
|
|
'Export workflow before deletion for backup'
|
|
],
|
|
pitfalls: [
|
|
'Requires N8N_API_URL and N8N_API_KEY configured',
|
|
'Cannot be undone - permanent deletion',
|
|
'Deletes all execution history',
|
|
'Active workflows can be deleted',
|
|
'No built-in confirmation'
|
|
],
|
|
relatedTools: ['n8n_get_workflow_minimal', 'n8n_list_workflows', 'n8n_update_partial_workflow', 'n8n_delete_execution']
|
|
}
|
|
}; |