docs: Remove telemetry and research context from user-facing documentation

Clean up all README files to focus on user value rather than research metrics.
Remove telemetry numbers and research context that isn't useful for end users.

## Changes

**Main README.md**:
- Removed "Based on 447,557 real MCP tool usage events" section
- Replaced failure rate metrics with user benefits
- Removed entire "Data-Driven Design" section with telemetry statistics
- Fixed all GitHub links to use czlonkowski/n8n-mcp
- Updated "Repository Stats" to "What's Included" with user-focused content

**dist/README.md**:
- Changed "HIGHEST PRIORITY" to "recommended to install first"
- Added link to n8n-mcp repository
- More user-friendly language throughout

**Skill README.md files**:
- n8n-mcp-tools-expert: Removed "447,557 events", "20% failure rate" metrics
- n8n-workflow-patterns: Removed "Based on 31,917 real workflows"
- n8n-validation-expert: Removed "From 7,841 validate → fix cycles"
- Replaced frequency percentages with priority levels (Highest/High/Medium/Low)
- Reframed "Success Metrics" as "What You'll Learn"
- Changed "Critical Insights from telemetry" to "Key Insights" for users

## Kept What Matters

- Template counts (2,653+) - this is a feature, not research
- Node counts (525+) - this is a feature
- Practical insights (validation takes 2-3 iterations, false positives exist)
- Best practices and common patterns

## Result

Documentation now focuses on what users need to know to use the skills
effectively, rather than the research that informed their creation.

All distribution packages regenerated with cleaned documentation.

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

Co-Authored-By: Claude <noreply@anthropic.com>
Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en
This commit is contained in:
czlonkowski
2025-10-20 13:05:41 +02:00
parent 94c7036d29
commit e19ea6ea8d
11 changed files with 50 additions and 91 deletions

View File

@@ -25,7 +25,7 @@ Teaches how to use n8n-mcp MCP server tools correctly for efficient workflow bui
## Priority
**HIGHEST** - Fixes 20% MCP tool failure rate
**HIGHEST** - Essential for correct MCP tool usage
## Dependencies
@@ -66,12 +66,12 @@ Teaches how to use n8n-mcp MCP server tools correctly for efficient workflow bui
## Key Features
**Data-Driven**: Based on 447,557 real MCP tool events
**Telemetry Insights**: Actual usage patterns (56s between edits, 18s between search/essentials)
**Critical Mistakes**: Highlights 20% failure rate issues
**Smart Parameters**: Teaches semantic branch/case routing
**Auto-Sanitization**: Explains automatic fixes
**Comprehensive**: Covers all 40+ tools
**Tool Selection Guide**: Which tool to use for each task
**Common Patterns**: Most effective tool usage sequences
**Format Guidance**: nodeType format differences explained
**Smart Parameters**: Semantic branch/case routing for multi-output nodes
**Auto-Sanitization**: Explains automatic validation fixes
**Comprehensive**: Covers all 40+ MCP tools
## Files
@@ -81,22 +81,13 @@ Teaches how to use n8n-mcp MCP server tools correctly for efficient workflow bui
- **WORKFLOW_GUIDE.md** (200 lines) - Workflow management
- **README.md** (this file) - Skill metadata
## Success Metrics
## What You'll Learn
**Expected outcomes**:
- Correct nodeType formats (nodes-base.* for search)
- get_node_essentials preferred over get_node_info
- Validation profiles used correctly
- Smart parameters for IF/Switch nodes
- 20% failure rate reduced to <5%
## Critical Insights
**From MCP Testing Log**:
- search essentials: 9,835 occurrences, 18s avg
- validate fix: 7,841 loops, 23s thinking, 58s fixing
- update_partial: 38,287 uses, 56s between edits
- get_node_info: 20% failure rate (use essentials!)
- Correct nodeType formats (nodes-base.* for search tools)
- When to use get_node_essentials vs get_node_info
- How to use validation profiles effectively
- Smart parameters for multi-output nodes (IF/Switch)
- Common tool usage patterns and workflows
## Last Updated

View File

@@ -94,39 +94,27 @@ n8n-validation-expert/
**Total**: ~2,224 lines across 4 files
## Error Distribution
## Common Error Types
Based on 19,113 validation errors:
| Error Type | Frequency | Auto-Fix | Severity |
| Error Type | Priority | Auto-Fix | Severity |
|---|---|---|---|
| missing_required | 45% | ❌ | Error |
| invalid_value | 28% | ❌ | Error |
| type_mismatch | 12% | ❌ | Error |
| invalid_expression | 8% | ❌ | Error |
| invalid_reference | 5% | ❌ | Error |
| operator_structure | 2% | ✅ | Warning |
## Validation Loop Statistics
From 7,841 validate → fix cycles:
- **Average thinking time**: 23 seconds
- **Average fix time**: 58 seconds
- **Total cycle time**: 81 seconds average
- **Iterations to success**: 2-3 average
- **Success rate after 3 iterations**: 94%
| missing_required | Highest | ❌ | Error |
| invalid_value | High | ❌ | Error |
| type_mismatch | Medium | ❌ | Error |
| invalid_expression | Medium | ❌ | Error |
| invalid_reference | Low | ❌ | Error |
| operator_structure | Low | ✅ | Warning |
## Key Insights
### 1. Validation is Iterative
Don't expect to get it right on the first try. The data shows 2-3 iterations is normal!
Don't expect to get it right on the first try. Multiple validation cycles (typically 2-3) are normal and expected!
### 2. False Positives Exist
~40% of warnings are accepted in production workflows. Learn to recognize them.
Many validation warnings are acceptable in production workflows. This skill helps you recognize which ones to address vs. which to ignore.
### 3. Auto-Sanitization Works
Operator structure issues (2% of errors) are auto-fixed. Don't manually fix these!
Certain error types (like operator structure issues) are automatically fixed by n8n. Don't waste time manually fixing these!
### 4. Profile Matters
- `ai-friendly` reduces false positives by 60%

View File

@@ -93,12 +93,12 @@ Teaches architectural patterns for building n8n workflows. Provides structure, b
## Key Features
**Data-Driven**: Based on 31,917 real workflows
**Pattern Statistics**: Usage data for each pattern
**Complete Examples**: Working workflows for each pattern
**Best Practices**: Proven approaches from production workflows
**Common Gotchas**: Documented mistakes and fixes
**5 Proven Patterns**: Webhook, HTTP API, Database, AI Agent, Scheduled tasks
**Complete Examples**: Working workflow configurations for each pattern
**Best Practices**: Proven approaches from real-world n8n usage
**Common Gotchas**: Documented mistakes and their fixes
**Integration Guide**: How patterns work with other skills
**Template Examples**: Real examples from 2,653+ n8n templates
## Files