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,45 @@
import { ToolDocumentation } from '../types';
export const searchNodesDoc: ToolDocumentation = {
name: 'search_nodes',
category: 'discovery',
essentials: {
description: 'Search nodes by keyword. Common nodes ranked first.',
keyParameters: ['query', 'mode'],
example: 'search_nodes({query: "webhook"})',
performance: 'Fast (<20ms)',
tips: [
'OR=any word, AND=all words, FUZZY=typos',
'Quotes for exact phrase'
]
},
full: {
description: 'Full-text search with relevance ranking. Common nodes (webhook, http) prioritized.',
parameters: {
query: { type: 'string', description: 'Use quotes for exact phrase', required: true },
limit: { type: 'number', description: 'Default: 20', required: false },
mode: { type: 'string', description: 'OR|AND|FUZZY', required: false }
},
returns: 'Nodes array sorted by relevance',
examples: [
'search_nodes({query: "webhook"}) - Finds Webhook node',
'search_nodes({query: "slak", mode: "FUZZY"}) - Finds Slack'
],
useCases: [
'Finding nodes by keyword',
'Typo-tolerant search',
'Multi-word searches'
],
performance: 'Fast - FTS5 search',
bestPractices: [
'Single words for best results',
'FUZZY for uncertain spelling',
'AND requires all terms anywhere'
],
pitfalls: [
'AND searches all fields not just names',
'Short queries + FUZZY = unexpected results'
],
relatedTools: ['list_nodes', 'get_node_essentials']
}
};