Files
n8n-mcp/src/mcp/tool-docs/validation/validate-node-operation.ts
czlonkowski c1a6347d4f 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>
2025-07-17 21:35:00 +02:00

49 lines
2.3 KiB
TypeScript

import { ToolDocumentation } from '../types';
export const validateNodeOperationDoc: ToolDocumentation = {
name: 'validate_node_operation',
category: 'validation',
essentials: {
description: 'Validate node config. Checks required fields, types, operation rules. Returns errors with fixes. Essential for Slack/Sheets/DB nodes.',
keyParameters: ['nodeType', 'config', 'profile'],
example: 'validate_node_operation("nodes-base.slack", {resource: "message", operation: "post", text: "Hi"})',
performance: 'Fast',
tips: [
'Returns errors, warnings, fixes',
'Operation-aware validation',
'Use profiles: minimal/runtime/ai-friendly/strict'
]
},
full: {
description: 'Comprehensive node configuration validation with operation awareness. Validates required fields, types, operation-specific rules, and provides fix suggestions. Supports validation profiles for different use cases.',
parameters: {
nodeType: { type: 'string', required: true, description: 'Node type with prefix (e.g., "nodes-base.slack")' },
config: { type: 'object', required: true, description: 'Configuration including operation fields (resource/operation/action)' },
profile: { type: 'string', description: 'Validation profile: minimal/runtime/ai-friendly(default)/strict' }
},
returns: 'Validation result with isValid, errors[], warnings[], suggestions[], fixes{}',
examples: [
'validate_node_operation("nodes-base.slack", {resource: "message", operation: "post", text: "Hello"}) - Validate Slack message',
'validate_node_operation("nodes-base.httpRequest", {method: "POST", url: "{{$json.url}}"}, "strict") - Strict HTTP validation'
],
useCases: [
'Pre-deployment validation',
'Configuration debugging',
'Operation-specific checks',
'Fix suggestion generation'
],
performance: 'Fast - Schema analysis with operation context',
bestPractices: [
'Include operation fields in config',
'Use ai-friendly profile by default',
'Apply suggested fixes',
'Validate before workflow deployment'
],
pitfalls: [
'Config must include operation fields',
'Some fixes are suggestions only',
'Profile affects strictness level'
],
relatedTools: ['validate_node_minimal', 'get_node_essentials', 'validate_workflow']
}
};