refactor: rewrite all MCP tool documentation for AI agent optimization

- Redesigned documentation to be utilitarian and AI-agent focused
- Removed all pleasantries, emojis, and conversational language
- Added concrete numbers throughout (528 nodes, 108 triggers, 264 AI tools)
- Updated all tool descriptions with practical, actionable information
- Enhanced examples with actual return structures and usage patterns
- Made Code node guides prominently featured in overview
- Verified documentation accuracy through extensive testing
- Standardized format across all 30+ tool documentation files

Documentation now optimized for token efficiency while maintaining
clarity and completeness for AI agent consumption.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-07-17 19:49:07 +02:00
parent c1a6347d4f
commit 24d775960b
16 changed files with 1031 additions and 289 deletions

View File

@@ -4,39 +4,64 @@ export const getDatabaseStatisticsDoc: ToolDocumentation = {
name: 'get_database_statistics',
category: 'discovery',
essentials: {
description: 'Node stats: 525 total, 263 AI tools, 104 triggers, 87% docs coverage. Verifies MCP working.',
description: 'Returns database health metrics and node inventory. Shows 525 total nodes, 263 AI-capable nodes, 104 triggers, with 87% documentation coverage. Primary use: verify MCP connection is working correctly.',
keyParameters: [],
example: 'get_database_statistics()',
performance: 'Instant',
tips: [
'Use to verify MCP connection',
'Check doc coverage',
'See AI tool counts'
'First tool to call when testing MCP connection',
'Shows exact counts for all node categories',
'Documentation coverage indicates data quality'
]
},
full: {
description: 'Returns comprehensive database statistics including node counts, AI tool availability, trigger nodes, documentation coverage, and package distribution. Useful for verifying MCP connectivity.',
description: 'Returns comprehensive database statistics showing the complete inventory of n8n nodes, their categories, documentation coverage, and package distribution. Essential for verifying MCP connectivity and understanding available resources.',
parameters: {},
returns: 'Statistics object with total_nodes, ai_tools, triggers, docs_coverage, packages breakdown',
returns: `Object containing:
{
"total_nodes": 525, // All nodes in database
"nodes_with_properties": 520, // Nodes with extracted properties (99%)
"nodes_with_operations": 334, // Nodes with multiple operations (64%)
"ai_tools": 263, // AI-capable nodes
"triggers": 104, // Workflow trigger nodes
"documentation_coverage": "87%", // Nodes with official docs
"packages": {
"n8n-nodes-base": 456, // Core n8n nodes
"@n8n/n8n-nodes-langchain": 69 // AI/LangChain nodes
},
"categories": {
"trigger": 104,
"transform": 250,
"output": 45,
"input": 38,
"AI": 88
}
}`,
examples: [
'get_database_statistics() - Get all statistics'
'get_database_statistics() - Returns complete statistics object',
'// Common check:',
'const stats = get_database_statistics();',
'if (stats.total_nodes < 500) console.error("Database incomplete!");'
],
useCases: [
'Verify MCP is working',
'Check documentation coverage',
'Audit available nodes',
'Monitor AI tool availability'
'Verify MCP server is connected and responding',
'Check if database rebuild is needed (low node count)',
'Monitor documentation coverage improvements',
'Validate AI tools availability for workflows',
'Audit node distribution across packages'
],
performance: 'Instant - Pre-calculated statistics',
performance: 'Instant (<1ms) - Statistics are pre-calculated and cached',
bestPractices: [
'Use to verify connection',
'Check before bulk operations',
'Monitor after database updates'
'Call this first to verify MCP connection before other operations',
'Check total_nodes >= 500 to ensure complete database',
'Monitor documentation_coverage for data quality',
'Use ai_tools count to verify AI capabilities'
],
pitfalls: [
'Stats cached until rebuild',
'May not reflect runtime changes'
'Statistics are cached at database build time, not real-time',
'Won\'t reflect changes until database is rebuilt',
'Package counts may vary with n8n version updates'
],
relatedTools: ['list_nodes', 'list_ai_tools', 'search_nodes']
relatedTools: ['list_nodes for detailed node listing', 'list_ai_tools for AI nodes', 'n8n_health_check for API connectivity']
}
};