mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-03-20 09:23:07 +00:00
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:
45
src/mcp/tool-docs/configuration/get-node-info.ts
Normal file
45
src/mcp/tool-docs/configuration/get-node-info.ts
Normal file
@@ -0,0 +1,45 @@
|
||||
import { ToolDocumentation } from '../types';
|
||||
|
||||
export const getNodeInfoDoc: ToolDocumentation = {
|
||||
name: 'get_node_info',
|
||||
category: 'configuration',
|
||||
essentials: {
|
||||
description: 'Get FULL node schema (100KB+). TIP: Use get_node_essentials first! Returns all properties/operations/credentials. Prefix required: "nodes-base.httpRequest" not "httpRequest".',
|
||||
keyParameters: ['nodeType'],
|
||||
example: 'get_node_info({nodeType: "nodes-base.slack"})',
|
||||
performance: 'Moderate - large responses',
|
||||
tips: [
|
||||
'Use get_node_essentials first',
|
||||
'Required: Full prefix "nodes-base."',
|
||||
'Returns entire schema'
|
||||
]
|
||||
},
|
||||
full: {
|
||||
description: 'Returns complete node JSON schema including all properties, operations, credentials, and metadata. Response size often exceeds 100KB. Always prefer get_node_essentials unless you need the complete schema.',
|
||||
parameters: {
|
||||
nodeType: { type: 'string', required: true, description: 'Full node type with prefix (e.g., "nodes-base.slack", "nodes-langchain.openAi")' }
|
||||
},
|
||||
returns: 'Complete node JSON with type, displayName, description, properties, credentials, version info',
|
||||
examples: [
|
||||
'get_node_info({nodeType: "nodes-base.httpRequest"}) - Get HTTP Request node',
|
||||
'get_node_info({nodeType: "nodes-langchain.openAi"}) - Get OpenAI node'
|
||||
],
|
||||
useCases: [
|
||||
'Complete schema analysis',
|
||||
'Credential requirement discovery',
|
||||
'Advanced property exploration'
|
||||
],
|
||||
performance: 'Moderate - Response size 50-500KB depending on node complexity',
|
||||
bestPractices: [
|
||||
'Always use get_node_essentials first',
|
||||
'Only use when complete schema needed',
|
||||
'Cache results for repeated access'
|
||||
],
|
||||
pitfalls: [
|
||||
'Response often exceeds 100KB',
|
||||
'Overwhelming for simple configurations',
|
||||
'Must include full prefix'
|
||||
],
|
||||
relatedTools: ['get_node_essentials', 'search_node_properties', 'validate_node_operation']
|
||||
}
|
||||
};
|
||||
Reference in New Issue
Block a user