feat: complete modular documentation system for all MCP tools (#60)

- 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>
This commit is contained in:
czlonkowski
2025-07-17 18:39:29 +02:00
parent 8025d31e63
commit c1a6347d4f
53 changed files with 2744 additions and 1322 deletions

View File

@@ -0,0 +1,57 @@
import { ToolDocumentation } from '../types';
export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
name: 'n8n_update_partial_workflow',
category: 'workflow_management',
essentials: {
description: 'Update workflow incrementally with diff operations. Max 5 ops. Types: addNode, removeNode, updateNode, moveNode, enable/disableNode, addConnection, removeConnection, updateSettings, updateName, add/removeTag.',
keyParameters: ['id', 'operations'],
example: 'n8n_update_partial_workflow({id: "wf_123", operations: [{type: "updateNode", ...}]})',
performance: 'Fast (50-200ms)',
tips: [
'Use for targeted changes',
'Supports up to 5 operations',
'Validate with validateOnly first'
]
},
full: {
description: 'Updates workflows using surgical diff operations instead of full replacement. Supports 13 operation types for precise modifications. Operations are validated and applied atomically - all succeed or none are applied. Maximum 5 operations per call for safety.',
parameters: {
id: { type: 'string', required: true, description: 'Workflow ID to update' },
operations: {
type: 'array',
required: true,
description: 'Array of diff operations. Each must have "type" field and operation-specific properties. Max 5 operations.'
},
validateOnly: { type: 'boolean', description: 'If true, only validate operations without applying them' }
},
returns: 'Updated workflow object or validation results if validateOnly=true',
examples: [
'n8n_update_partial_workflow({id: "abc", operations: [{type: "updateNode", nodeId: "n1", updates: {name: "New Name"}}]})',
'n8n_update_partial_workflow({id: "xyz", operations: [{type: "addConnection", source: "n1", target: "n2"}]})',
'n8n_update_partial_workflow({id: "123", operations: [{type: "removeNode", nodeId: "oldNode"}], validateOnly: true})'
],
useCases: [
'Update single node parameters',
'Add/remove connections',
'Enable/disable nodes',
'Rename workflows or nodes',
'Manage tags efficiently'
],
performance: 'Very fast - typically 50-200ms. Much faster than full updates as only changes are processed.',
bestPractices: [
'Use validateOnly to test operations',
'Group related changes in one call',
'Keep operations under 5 for clarity',
'Check operation order for dependencies'
],
pitfalls: [
'Requires N8N_API_URL and N8N_API_KEY configured',
'Maximum 5 operations per call',
'Operations must be valid together',
'Some operations have dependencies',
'See full docs for operation schemas'
],
relatedTools: ['n8n_update_full_workflow', 'n8n_get_workflow', 'validate_workflow', 'tools_documentation']
}
};