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

@@ -3,21 +3,21 @@
**Expert Claude Code skills for building flawless n8n workflows using the n8n-mcp MCP server** **Expert Claude Code skills for building flawless n8n workflows using the n8n-mcp MCP server**
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![n8n-mcp](https://img.shields.io/badge/n8n--mcp-compatible-green.svg)](https://github.com/romualdczlonkowski/n8n-mcp) [![n8n-mcp](https://img.shields.io/badge/n8n--mcp-compatible-green.svg)](https://github.com/czlonkowski/n8n-mcp)
--- ---
## 🎯 What is this? ## 🎯 What is this?
This repository contains 5 complementary **Claude Code skills** that teach AI assistants how to build production-ready n8n workflows using the [n8n-mcp](https://github.com/your-link-here) MCP server. This repository contains 5 complementary **Claude Code skills** that teach AI assistants how to build production-ready n8n workflows using the [n8n-mcp](https://github.com/czlonkowski/n8n-mcp) MCP server.
### Why These Skills Exist ### Why These Skills Exist
Based on analysis of **447,557 real MCP tool usage events**, we identified: Building n8n workflows programmatically can be challenging. Common issues include:
- **20% failure rate** when using certain MCP tools incorrectly - Using MCP tools incorrectly or inefficiently
- **15,107 validation feedback loops** due to configuration errors - Getting stuck in validation error loops
- **813 searches for "webhook"** showing common workflow patterns - Not knowing which workflow patterns to use
- **31,917 workflows created** revealing proven architectural patterns - Misconfiguring nodes and their dependencies
These skills solve these problems by teaching Claude: These skills solve these problems by teaching Claude:
- ✅ Correct n8n expression syntax ({{}} patterns) - ✅ Correct n8n expression syntax ({{}} patterns)
@@ -53,22 +53,20 @@ Expert guide for using n8n-mcp MCP tools effectively.
- Smart parameters (branch="true" for IF nodes) - Smart parameters (branch="true" for IF nodes)
- Auto-sanitization system explained - Auto-sanitization system explained
**Impact**: **Fixes 20% MCP tool failure rate** **Most Important**: Teaches correct MCP tool usage patterns and parameter formats
### 3. **n8n Workflow Patterns** ### 3. **n8n Workflow Patterns**
Build workflows using 5 proven architectural patterns from 31,917 real workflows. Build workflows using 5 proven architectural patterns.
**Activates when**: Creating workflows, connecting nodes, designing automation. **Activates when**: Creating workflows, connecting nodes, designing automation.
**Key Features**: **Key Features**:
- 5 proven patterns (webhook processing, HTTP API, database, AI, scheduled) - 5 proven patterns (webhook processing, HTTP API, database, AI, scheduled)
- Workflow creation checklist - Workflow creation checklist
- Real examples from 2,653 templates - Real examples from 2,653+ n8n templates
- Connection best practices - Connection best practices
- Pattern selection guide - Pattern selection guide
**Impact**: **Addresses 27.6% of all workflows (webhook processing)**
### 4. **n8n Validation Expert** ### 4. **n8n Validation Expert**
Interpret validation errors and guide fixing. Interpret validation errors and guide fixing.
@@ -98,7 +96,7 @@ Operation-aware node configuration guidance.
### Prerequisites ### Prerequisites
1. **n8n-mcp MCP server** installed and configured ([Installation Guide](https://github.com/romualdczlonkowski/n8n-mcp)) 1. **n8n-mcp MCP server** installed and configured ([Installation Guide](https://github.com/czlonkowski/n8n-mcp))
2. **Claude Code**, Claude.ai, or Claude API access 2. **Claude Code**, Claude.ai, or Claude API access
3. `.mcp.json` configured with n8n-mcp server 3. `.mcp.json` configured with n8n-mcp server
@@ -171,22 +169,6 @@ All 5 skills compose seamlessly!
--- ---
## 🔬 Data-Driven Design
These skills are based on telemetry analysis of:
- **447,557** MCP tool usage events
- **31,917** workflows created
- **19,113** validation errors
- **15,107** validation feedback loops
- **2,653** workflow templates
Key insights:
- `search_nodes → get_node_essentials` is the most common pattern (9,835 occurrences, 18s avg)
- `n8n_update_partial_workflow` is the most-used tool (38,287 uses, 99.0% success)
- Validation loops average 23s thinking, 58s fixing
- Webhook workflows represent 27.6% of all workflows (813 searches)
---
## 🧪 Testing ## 🧪 Testing
@@ -226,25 +208,23 @@ MIT License - see [LICENSE](LICENSE) file for details.
**Conceived by Romuald Członkowski** **Conceived by Romuald Członkowski**
- Website: [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en) - Website: [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en)
- Part of the [n8n-mcp project](https://github.com/romualdczlonkowski/n8n-mcp) - Part of the [n8n-mcp project](https://github.com/czlonkowski/n8n-mcp)
--- ---
## 🔗 Related Projects ## 🔗 Related Projects
- [n8n-mcp](https://github.com/romualdczlonkowski/n8n-mcp) - MCP server for n8n - [n8n-mcp](https://github.com/czlonkowski/n8n-mcp) - MCP server for n8n
- [n8n](https://n8n.io/) - Workflow automation platform - [n8n](https://n8n.io/) - Workflow automation platform
--- ---
## 📊 Repository Stats ## 📊 What's Included
- **5** complementary skills - **5** complementary skills that work together
- **~3,220** lines of skill content - **525+** n8n nodes supported
- **15-20** evaluation scenarios - **2,653+** workflow templates for examples
- **88%** documentation coverage (from n8n-mcp) - **Comprehensive** error catalogs and troubleshooting guides
- **537** nodes supported
- **2,653** templates available
--- ---

6
dist/README.md vendored
View File

@@ -9,7 +9,7 @@ This folder contains distribution packages for different Claude platforms.
Upload each skill separately via Settings → Features → Skills: Upload each skill separately via Settings → Features → Skills:
- `n8n-expression-syntax-v1.0.0.zip` - n8n expression syntax and common patterns - `n8n-expression-syntax-v1.0.0.zip` - n8n expression syntax and common patterns
- `n8n-mcp-tools-expert-v1.0.0.zip` - Expert guide for using n8n-mcp tools (HIGHEST PRIORITY) - `n8n-mcp-tools-expert-v1.0.0.zip` - Expert guide for using n8n-mcp tools (recommended to install first)
- `n8n-workflow-patterns-v1.0.0.zip` - 5 proven workflow architectural patterns - `n8n-workflow-patterns-v1.0.0.zip` - 5 proven workflow architectural patterns
- `n8n-validation-expert-v1.0.0.zip` - Validation error interpretation and fixing - `n8n-validation-expert-v1.0.0.zip` - Validation error interpretation and fixing
- `n8n-node-configuration-v1.0.0.zip` - Operation-aware node configuration - `n8n-node-configuration-v1.0.0.zip` - Operation-aware node configuration
@@ -96,7 +96,7 @@ After installation, test skills by asking:
## 🔧 Requirements ## 🔧 Requirements
- **n8n-mcp MCP server** installed and configured - **n8n-mcp MCP server** installed and configured ([Installation Guide](https://github.com/czlonkowski/n8n-mcp))
- **Claude Pro, Max, Team, or Enterprise** plan (for Claude.ai skills) - **Claude Pro, Max, Team, or Enterprise** plan (for Claude.ai skills)
- **.mcp.json** configured with n8n-mcp server - **.mcp.json** configured with n8n-mcp server
@@ -131,4 +131,4 @@ MIT License - see `../LICENSE` file
Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en Conceived by Romuald Członkowski - https://www.aiadvisors.pl/en
Part of the n8n-mcp project. Part of the [n8n-mcp project](https://github.com/czlonkowski/n8n-mcp).

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

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

View File

@@ -94,39 +94,27 @@ n8n-validation-expert/
**Total**: ~2,224 lines across 4 files **Total**: ~2,224 lines across 4 files
## Error Distribution ## Common Error Types
Based on 19,113 validation errors: | Error Type | Priority | Auto-Fix | Severity |
| Error Type | Frequency | Auto-Fix | Severity |
|---|---|---|---| |---|---|---|---|
| missing_required | 45% | ❌ | Error | | missing_required | Highest | ❌ | Error |
| invalid_value | 28% | ❌ | Error | | invalid_value | High | ❌ | Error |
| type_mismatch | 12% | ❌ | Error | | type_mismatch | Medium | ❌ | Error |
| invalid_expression | 8% | ❌ | Error | | invalid_expression | Medium | ❌ | Error |
| invalid_reference | 5% | ❌ | Error | | invalid_reference | Low | ❌ | Error |
| operator_structure | 2% | ✅ | Warning | | operator_structure | Low | ✅ | 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%
## Key Insights ## Key Insights
### 1. Validation is Iterative ### 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 ### 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 ### 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 ### 4. Profile Matters
- `ai-friendly` reduces false positives by 60% - `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 ## Key Features
**Data-Driven**: Based on 31,917 real workflows **5 Proven Patterns**: Webhook, HTTP API, Database, AI Agent, Scheduled tasks
**Pattern Statistics**: Usage data for each pattern **Complete Examples**: Working workflow configurations for each pattern
**Complete Examples**: Working workflows for each pattern **Best Practices**: Proven approaches from real-world n8n usage
**Best Practices**: Proven approaches from production workflows **Common Gotchas**: Documented mistakes and their fixes
**Common Gotchas**: Documented mistakes and fixes
**Integration Guide**: How patterns work with other skills **Integration Guide**: How patterns work with other skills
**Template Examples**: Real examples from 2,653+ n8n templates
## Files ## Files