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:
40
src/mcp/tool-docs/configuration/get-node-essentials.ts
Normal file
40
src/mcp/tool-docs/configuration/get-node-essentials.ts
Normal file
@@ -0,0 +1,40 @@
|
||||
import { ToolDocumentation } from '../types';
|
||||
|
||||
export const getNodeEssentialsDoc: ToolDocumentation = {
|
||||
name: 'get_node_essentials',
|
||||
category: 'configuration',
|
||||
essentials: {
|
||||
description: 'Get 10-20 key properties with examples (<5KB)',
|
||||
keyParameters: ['nodeType'],
|
||||
example: 'get_node_essentials("nodes-base.slack")',
|
||||
performance: 'Fast (<5KB response)',
|
||||
tips: [
|
||||
'Use this first - has examples'
|
||||
]
|
||||
},
|
||||
full: {
|
||||
description: 'Curated essential properties only. 95% smaller than full schema, includes examples.',
|
||||
parameters: {
|
||||
nodeType: { type: 'string', description: 'e.g., "nodes-base.slack"', required: true }
|
||||
},
|
||||
returns: 'Essential properties, examples, common patterns',
|
||||
examples: [
|
||||
'get_node_essentials("nodes-base.httpRequest")'
|
||||
],
|
||||
useCases: [
|
||||
'Quick node configuration',
|
||||
'Getting examples',
|
||||
'Learning basics'
|
||||
],
|
||||
performance: 'Fast - minimal data',
|
||||
bestPractices: [
|
||||
'Always use before get_node_info',
|
||||
'Copy examples as starting point'
|
||||
],
|
||||
pitfalls: [
|
||||
'Advanced properties not included',
|
||||
'Use search_node_properties for specific needs'
|
||||
],
|
||||
relatedTools: ['get_node_info', 'search_node_properties']
|
||||
}
|
||||
};
|
||||
Reference in New Issue
Block a user