mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-01-30 22:42:04 +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>
45 lines
1.8 KiB
TypeScript
45 lines
1.8 KiB
TypeScript
import { ToolDocumentation } from '../types';
|
|
|
|
export const getNodeDocumentationDoc: ToolDocumentation = {
|
|
name: 'get_node_documentation',
|
|
category: 'configuration',
|
|
essentials: {
|
|
description: 'Get readable docs with examples/auth/patterns. Better than raw schema! 87% coverage. Format: "nodes-base.slack"',
|
|
keyParameters: ['nodeType'],
|
|
example: 'get_node_documentation({nodeType: "nodes-base.slack"})',
|
|
performance: 'Fast - pre-parsed',
|
|
tips: [
|
|
'87% coverage',
|
|
'Includes auth examples',
|
|
'Human-readable format'
|
|
]
|
|
},
|
|
full: {
|
|
description: 'Returns human-readable documentation parsed from n8n-docs including examples, authentication setup, and common patterns. More useful than raw schema for understanding node usage.',
|
|
parameters: {
|
|
nodeType: { type: 'string', required: true, description: 'Full node type with prefix (e.g., "nodes-base.slack")' }
|
|
},
|
|
returns: 'Parsed markdown documentation with examples, authentication guides, common patterns',
|
|
examples: [
|
|
'get_node_documentation({nodeType: "nodes-base.slack"}) - Slack usage guide',
|
|
'get_node_documentation({nodeType: "nodes-base.googleSheets"}) - Sheets examples'
|
|
],
|
|
useCases: [
|
|
'Understanding authentication setup',
|
|
'Finding usage examples',
|
|
'Learning common patterns'
|
|
],
|
|
performance: 'Fast - Pre-parsed documentation stored in database',
|
|
bestPractices: [
|
|
'Use for learning node usage',
|
|
'Check coverage with get_database_statistics',
|
|
'Combine with get_node_essentials'
|
|
],
|
|
pitfalls: [
|
|
'Not all nodes have docs (87% coverage)',
|
|
'May be outdated for new features',
|
|
'Requires full node type prefix'
|
|
],
|
|
relatedTools: ['get_node_info', 'get_node_essentials', 'search_nodes']
|
|
}
|
|
}; |