Compare commits

..

1 Commits

Author SHA1 Message Date
czlonkowski
217825c6e1 feat: implement Phase 2 security fixes (partial - HIGH-01, HIGH-04, HIGH-08, MEDIUM-02, MEDIUM-05)
Implements 5 of 8 security fixes from Issue #265 Phase 2:

 COMPLETED:

- **MEDIUM-05: Dependency Audit Documentation**
  - Added Security & Dependencies section to README.md
  - Documents that n8n package vulnerabilities are upstream responsibilities
  - Explains our direct dependencies are kept up to date
  - Provides security update workflow

- **HIGH-01: SQL Injection ESLint Safeguards**
  - Installed ESLint with TypeScript support
  - Created eslint.config.js with no-restricted-syntax rule
  - Blocks template literals in db.exec() calls
  - Added JSDoc @security comments to 8 existing db.exec() calls
  - All static SQL statements documented and safe

- **MEDIUM-02: Input Length Limits**
  - Reduced express.json() body size from 10mb to 1mb
  - Added URL length validation middleware (2048 char limit)
  - Returns HTTP 414 for oversized URLs
  - Logs input_validation_failure events

- **HIGH-08: Security Headers**
  - Installed helmet package
  - Configured comprehensive CSP, Referrer-Policy, HSTS, Permissions-Policy
  - Disabled x-powered-by header
  - All security headers now present on responses

- **HIGH-04: Error Sanitization Consistency**
  - Updated Express global error handler
  - Now uses sanitizeErrorForClient() method
  - Ensures no stack traces or internal details leak in any mode
  - Production-safe error responses

 REMAINING (to be completed):
- HIGH-06: CORS production validation
- HIGH-05: Multi-tenant shared mode safety check
- MEDIUM-04: Audit logging event field verification

Files modified:
- README.md (new Security & Dependencies section)
- package.json, package-lock.json (eslint, helmet dependencies)
- eslint.config.js (new ESLint flat config)
- src/http-server-single-session.ts (security headers, input limits, error handler)
- src/templates/template-repository.ts (JSDoc security comments)
- src/scripts/fetch-templates.ts (JSDoc security comments)

Part of Issue #265 security audit remediation.
Next: Complete remaining 3 fixes, add tests, version bump to 2.16.4.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-06 19:41:35 +02:00
147 changed files with 11582 additions and 27609 deletions

View File

@@ -5,6 +5,8 @@ on:
push:
branches:
- main
tags:
- 'v*'
paths-ignore:
- '**.md'
- '**.txt'
@@ -36,12 +38,6 @@ on:
- 'CODE_OF_CONDUCT.md'
workflow_dispatch:
# Prevent concurrent Docker pushes across all workflows (shared with release.yml)
# This ensures docker-build.yml and release.yml never push to 'latest' simultaneously
concurrency:
group: docker-push-${{ github.ref }}
cancel-in-progress: false
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
@@ -93,54 +89,16 @@ jobs:
uses: docker/build-push-action@v5
with:
context: .
no-cache: false
no-cache: true
platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
provenance: false
- name: Verify multi-arch manifest for latest tag
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
run: |
echo "Verifying multi-arch manifest for latest tag..."
# Retry with exponential backoff (registry propagation can take time)
MAX_ATTEMPTS=5
ATTEMPT=1
WAIT_TIME=2
while [ $ATTEMPT -le $MAX_ATTEMPTS ]; do
echo "Attempt $ATTEMPT of $MAX_ATTEMPTS..."
MANIFEST=$(docker buildx imagetools inspect ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest 2>&1 || true)
# Check for both platforms
if echo "$MANIFEST" | grep -q "linux/amd64" && echo "$MANIFEST" | grep -q "linux/arm64"; then
echo "✅ Multi-arch manifest verified: both amd64 and arm64 present"
echo "$MANIFEST"
exit 0
fi
if [ $ATTEMPT -lt $MAX_ATTEMPTS ]; then
echo "⏳ Registry still propagating, waiting ${WAIT_TIME}s before retry..."
sleep $WAIT_TIME
WAIT_TIME=$((WAIT_TIME * 2)) # Exponential backoff: 2s, 4s, 8s, 16s
fi
ATTEMPT=$((ATTEMPT + 1))
done
echo "❌ ERROR: Multi-arch manifest incomplete after $MAX_ATTEMPTS attempts!"
echo "$MANIFEST"
exit 1
build-railway:
name: Build Railway Docker Image
runs-on: ubuntu-latest
needs: build
permissions:
contents: read
packages: write
@@ -185,13 +143,11 @@ jobs:
with:
context: .
file: ./Dockerfile.railway
no-cache: false
no-cache: true
platforms: linux/amd64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta-railway.outputs.tags }}
labels: ${{ steps.meta-railway.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
provenance: false
# Nginx build commented out until Phase 2

View File

@@ -13,10 +13,9 @@ permissions:
issues: write
pull-requests: write
# Prevent concurrent Docker pushes across all workflows (shared with docker-build.yml)
# This ensures release.yml and docker-build.yml never push to 'latest' simultaneously
# Prevent concurrent releases
concurrency:
group: docker-push-${{ github.ref }}
group: release
cancel-in-progress: false
env:
@@ -80,38 +79,6 @@ jobs:
echo " No version change detected"
fi
- name: Validate version against npm registry
if: steps.check.outputs.changed == 'true'
run: |
CURRENT_VERSION="${{ steps.check.outputs.version }}"
# Get latest version from npm (handle package not found)
NPM_VERSION=$(npm view n8n-mcp version 2>/dev/null || echo "0.0.0")
echo "Current version: $CURRENT_VERSION"
echo "NPM registry version: $NPM_VERSION"
# Check if version already exists in npm
if [ "$CURRENT_VERSION" = "$NPM_VERSION" ]; then
echo "❌ Error: Version $CURRENT_VERSION already published to npm"
echo "Please bump the version in package.json before releasing"
exit 1
fi
# Simple semver comparison (assumes format: major.minor.patch)
# Compare if current version is greater than npm version
if [ "$NPM_VERSION" != "0.0.0" ]; then
# Sort versions and check if current is not the highest
HIGHEST=$(printf '%s\n%s' "$NPM_VERSION" "$CURRENT_VERSION" | sort -V | tail -n1)
if [ "$HIGHEST" != "$CURRENT_VERSION" ]; then
echo "❌ Error: Version $CURRENT_VERSION is not greater than npm version $NPM_VERSION"
echo "Please use a higher version number"
exit 1
fi
fi
echo "✅ Version $CURRENT_VERSION is valid (higher than npm version $NPM_VERSION)"
extract-changelog:
name: Extract Changelog
runs-on: ubuntu-latest
@@ -239,8 +206,8 @@ jobs:
echo "id=$RELEASE_ID" >> $GITHUB_OUTPUT
echo "upload_url=https://uploads.github.com/repos/${{ github.repository }}/releases/$RELEASE_ID/assets{?name,label}" >> $GITHUB_OUTPUT
build-and-verify:
name: Build and Verify
build-and-test:
name: Build and Test
runs-on: ubuntu-latest
needs: detect-version-change
if: needs.detect-version-change.outputs.version-changed == 'true'
@@ -259,28 +226,22 @@ jobs:
- name: Build project
run: npm run build
# Database is already built and committed during development
# Rebuilding here causes segfault due to memory pressure (exit code 139)
- name: Verify database exists
run: |
if [ ! -f "data/nodes.db" ]; then
echo "❌ Error: data/nodes.db not found"
echo "Please run 'npm run rebuild' locally and commit the database"
exit 1
fi
echo "✅ Database exists ($(du -h data/nodes.db | cut -f1))"
# Skip tests - they already passed in PR before merge
# Running them again on the same commit adds no safety, only time (~6-7 min)
- name: Rebuild database
run: npm run rebuild
- name: Run tests
run: npm test
env:
CI: true
- name: Run type checking
run: npm run typecheck
publish-npm:
name: Publish to NPM
runs-on: ubuntu-latest
needs: [detect-version-change, build-and-verify, create-release]
needs: [detect-version-change, build-and-test, create-release]
if: needs.detect-version-change.outputs.version-changed == 'true'
steps:
- name: Checkout repository
@@ -298,16 +259,10 @@ jobs:
- name: Build project
run: npm run build
# Database is already built and committed during development
- name: Verify database exists
run: |
if [ ! -f "data/nodes.db" ]; then
echo "❌ Error: data/nodes.db not found"
exit 1
fi
echo "✅ Database exists ($(du -h data/nodes.db | cut -f1))"
- name: Rebuild database
run: npm run rebuild
- name: Sync runtime version
run: npm run sync:runtime-version
@@ -335,15 +290,6 @@ jobs:
const pkg = require('./package.json');
pkg.name = 'n8n-mcp';
pkg.description = 'Integration between n8n workflow automation and Model Context Protocol (MCP)';
pkg.main = 'dist/index.js';
pkg.types = 'dist/index.d.ts';
pkg.exports = {
'.': {
types: './dist/index.d.ts',
require: './dist/index.js',
import: './dist/index.js'
}
};
pkg.bin = { 'n8n-mcp': './dist/mcp/index.js' };
pkg.repository = { type: 'git', url: 'git+https://github.com/czlonkowski/n8n-mcp.git' };
pkg.keywords = ['n8n', 'mcp', 'model-context-protocol', 'ai', 'workflow', 'automation'];
@@ -378,7 +324,7 @@ jobs:
build-docker:
name: Build and Push Docker Images
runs-on: ubuntu-latest
needs: [detect-version-change, build-and-verify]
needs: [detect-version-change, build-and-test]
if: needs.detect-version-change.outputs.version-changed == 'true'
permissions:
contents: read
@@ -436,76 +382,7 @@ jobs:
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
- name: Verify multi-arch manifest for latest tag
run: |
echo "Verifying multi-arch manifest for latest tag..."
# Retry with exponential backoff (registry propagation can take time)
MAX_ATTEMPTS=5
ATTEMPT=1
WAIT_TIME=2
while [ $ATTEMPT -le $MAX_ATTEMPTS ]; do
echo "Attempt $ATTEMPT of $MAX_ATTEMPTS..."
MANIFEST=$(docker buildx imagetools inspect ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest 2>&1 || true)
# Check for both platforms
if echo "$MANIFEST" | grep -q "linux/amd64" && echo "$MANIFEST" | grep -q "linux/arm64"; then
echo "✅ Multi-arch manifest verified: both amd64 and arm64 present"
echo "$MANIFEST"
exit 0
fi
if [ $ATTEMPT -lt $MAX_ATTEMPTS ]; then
echo "⏳ Registry still propagating, waiting ${WAIT_TIME}s before retry..."
sleep $WAIT_TIME
WAIT_TIME=$((WAIT_TIME * 2)) # Exponential backoff: 2s, 4s, 8s, 16s
fi
ATTEMPT=$((ATTEMPT + 1))
done
echo "❌ ERROR: Multi-arch manifest incomplete after $MAX_ATTEMPTS attempts!"
echo "$MANIFEST"
exit 1
- name: Verify multi-arch manifest for version tag
run: |
VERSION="${{ needs.detect-version-change.outputs.new-version }}"
echo "Verifying multi-arch manifest for version tag :$VERSION (without 'v' prefix)..."
# Retry with exponential backoff (registry propagation can take time)
MAX_ATTEMPTS=5
ATTEMPT=1
WAIT_TIME=2
while [ $ATTEMPT -le $MAX_ATTEMPTS ]; do
echo "Attempt $ATTEMPT of $MAX_ATTEMPTS..."
MANIFEST=$(docker buildx imagetools inspect ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:$VERSION 2>&1 || true)
# Check for both platforms
if echo "$MANIFEST" | grep -q "linux/amd64" && echo "$MANIFEST" | grep -q "linux/arm64"; then
echo "✅ Multi-arch manifest verified for $VERSION: both amd64 and arm64 present"
echo "$MANIFEST"
exit 0
fi
if [ $ATTEMPT -lt $MAX_ATTEMPTS ]; then
echo "⏳ Registry still propagating, waiting ${WAIT_TIME}s before retry..."
sleep $WAIT_TIME
WAIT_TIME=$((WAIT_TIME * 2)) # Exponential backoff: 2s, 4s, 8s, 16s
fi
ATTEMPT=$((ATTEMPT + 1))
done
echo "❌ ERROR: Multi-arch manifest incomplete for version $VERSION after $MAX_ATTEMPTS attempts!"
echo "$MANIFEST"
exit 1
- name: Extract metadata for Railway image
id: meta-railway
uses: docker/metadata-action@v5

File diff suppressed because it is too large Load Diff

View File

@@ -192,5 +192,4 @@ NEVER proactively create documentation files (*.md) or README files. Only create
- When the user asks to review issues, you should use GH CLI to get the issue and all the comments
- When the task can be divided into separated subtasks, you should spawn separate sub-agents to handle them in paralel
- Use the best sub-agent for the task as per their descriptions
- Do not use hyperbolic or dramatic language in comments and documentation
- Add to every commit and PR: Concieved by Romuald Członkowski - and then link to www.aiadvisors.pl/en. Don't add it in conversations
- Do not use hyperbolic or dramatic language in comments and documentation

View File

@@ -34,13 +34,9 @@ RUN apk add --no-cache curl su-exec && \
# Copy runtime-only package.json
COPY package.runtime.json package.json
# Install runtime dependencies with better-sqlite3 compilation
# Build tools (python3, make, g++) are installed, used for compilation, then removed
# This enables native SQLite (better-sqlite3) instead of sql.js, preventing memory leaks
# Install runtime dependencies with cache mount
RUN --mount=type=cache,target=/root/.npm \
apk add --no-cache python3 make g++ && \
npm install --production --no-audit --no-fund && \
apk del python3 make g++
npm install --production --no-audit --no-fund
# Copy built application
COPY --from=builder /app/dist ./dist

View File

@@ -25,20 +25,16 @@ RUN npm run build
FROM node:22-alpine AS runtime
WORKDIR /app
# Install runtime dependencies
RUN apk add --no-cache curl && \
# Install system dependencies
RUN apk add --no-cache curl python3 make g++ && \
rm -rf /var/cache/apk/*
# Copy runtime-only package.json
COPY package.runtime.json package.json
# Install production dependencies with temporary build tools
# Build tools (python3, make, g++) enable better-sqlite3 compilation (native SQLite)
# They are removed after installation to reduce image size and attack surface
RUN apk add --no-cache python3 make g++ && \
npm install --production --no-audit --no-fund && \
npm cache clean --force && \
apk del python3 make g++
# Install only production dependencies
RUN npm install --production --no-audit --no-fund && \
npm cache clean --force
# Copy built application from builder stage
COPY --from=builder /app/dist ./dist

265
README.md
View File

@@ -5,7 +5,7 @@
[![npm version](https://img.shields.io/npm/v/n8n-mcp.svg)](https://www.npmjs.com/package/n8n-mcp)
[![codecov](https://codecov.io/gh/czlonkowski/n8n-mcp/graph/badge.svg?token=YOUR_TOKEN)](https://codecov.io/gh/czlonkowski/n8n-mcp)
[![Tests](https://img.shields.io/badge/tests-3336%20passing-brightgreen.svg)](https://github.com/czlonkowski/n8n-mcp/actions)
[![n8n version](https://img.shields.io/badge/n8n-^1.116.2-orange.svg)](https://github.com/n8n-io/n8n)
[![n8n version](https://img.shields.io/badge/n8n-^1.113.3-orange.svg)](https://github.com/n8n-io/n8n)
[![Docker](https://img.shields.io/badge/docker-ghcr.io%2Fczlonkowski%2Fn8n--mcp-green.svg)](https://github.com/czlonkowski/n8n-mcp/pkgs/container/n8n-mcp)
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/n8n-mcp?referralCode=n8n-mcp)
@@ -284,86 +284,6 @@ environment:
N8N_MCP_TELEMETRY_DISABLED: "true"
```
## ⚙️ Database & Memory Configuration
### Database Adapters
n8n-mcp uses SQLite for storing node documentation. Two adapters are available:
1. **better-sqlite3** (Default in Docker)
- Native C++ bindings for best performance
- Direct disk writes (no memory overhead)
- **Now enabled by default** in Docker images (v2.20.2+)
- Memory usage: ~100-120 MB stable
2. **sql.js** (Fallback)
- Pure JavaScript implementation
- In-memory database with periodic saves
- Used when better-sqlite3 compilation fails
- Memory usage: ~150-200 MB stable
### Memory Optimization (sql.js)
If using sql.js fallback, you can configure the save interval to balance between data safety and memory efficiency:
**Environment Variable:**
```bash
SQLJS_SAVE_INTERVAL_MS=5000 # Default: 5000ms (5 seconds)
```
**Usage:**
- Controls how long to wait after database changes before saving to disk
- Lower values = more frequent saves = higher memory churn
- Higher values = less frequent saves = lower memory usage
- Minimum: 100ms
- Recommended: 5000-10000ms for production
**Docker Configuration:**
```json
{
"mcpServers": {
"n8n-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"--init",
"-e", "SQLJS_SAVE_INTERVAL_MS=10000",
"ghcr.io/czlonkowski/n8n-mcp:latest"
]
}
}
}
```
**docker-compose:**
```yaml
environment:
SQLJS_SAVE_INTERVAL_MS: "10000"
```
### Memory Leak Fix (v2.20.2)
**Issue #330** identified a critical memory leak in long-running Docker/Kubernetes deployments:
- **Before:** 100 MB → 2.2 GB over 72 hours (OOM kills)
- **After:** Stable at 100-200 MB indefinitely
**Fixes Applied:**
- ✅ Docker images now use better-sqlite3 by default (eliminates leak entirely)
- ✅ sql.js fallback optimized (98% reduction in save frequency)
- ✅ Removed unnecessary memory allocations (50% reduction per save)
- ✅ Configurable save interval via `SQLJS_SAVE_INTERVAL_MS`
For Kubernetes deployments with memory limits:
```yaml
resources:
requests:
memory: 256Mi
limits:
memory: 512Mi
```
## 💖 Support This Project
<div align="center">
@@ -501,14 +421,6 @@ Complete guide for integrating n8n-MCP with Windsurf using project rules.
### [Codex](./docs/CODEX_SETUP.md)
Complete guide for integrating n8n-MCP with Codex.
## 🎓 Add Claude Skills (Optional)
Supercharge your n8n workflow building with specialized skills that teach AI how to build production-ready workflows!
[![n8n-mcp Skills Setup](./docs/img/skills.png)](https://www.youtube.com/watch?v=e6VvRqmUY2Y)
Learn more: [n8n-skills repository](https://github.com/czlonkowski/n8n-skills)
## 🤖 Claude Project Setup
For the best results when using n8n-MCP with Claude Projects, use these enhanced system instructions:
@@ -674,97 +586,6 @@ n8n_update_partial_workflow({id: "wf-123", operations: [{...}]})
n8n_update_partial_workflow({id: "wf-123", operations: [{...}]})
```
### CRITICAL: addConnection Syntax
The `addConnection` operation requires **four separate string parameters**. Common mistakes cause misleading errors.
❌ WRONG - Object format (fails with "Expected string, received object"):
```json
{
"type": "addConnection",
"connection": {
"source": {"nodeId": "node-1", "outputIndex": 0},
"destination": {"nodeId": "node-2", "inputIndex": 0}
}
}
```
❌ WRONG - Combined string (fails with "Source node not found"):
```json
{
"type": "addConnection",
"source": "node-1:main:0",
"target": "node-2:main:0"
}
```
✅ CORRECT - Four separate string parameters:
```json
{
"type": "addConnection",
"source": "node-id-string",
"target": "target-node-id-string",
"sourcePort": "main",
"targetPort": "main"
}
```
**Reference**: [GitHub Issue #327](https://github.com/czlonkowski/n8n-mcp/issues/327)
### ⚠️ CRITICAL: IF Node Multi-Output Routing
IF nodes have **two outputs** (TRUE and FALSE). Use the **`branch` parameter** to route to the correct output:
✅ CORRECT - Route to TRUE branch (when condition is met):
```json
{
"type": "addConnection",
"source": "if-node-id",
"target": "success-handler-id",
"sourcePort": "main",
"targetPort": "main",
"branch": "true"
}
```
✅ CORRECT - Route to FALSE branch (when condition is NOT met):
```json
{
"type": "addConnection",
"source": "if-node-id",
"target": "failure-handler-id",
"sourcePort": "main",
"targetPort": "main",
"branch": "false"
}
```
**Common Pattern** - Complete IF node routing:
```json
n8n_update_partial_workflow({
id: "workflow-id",
operations: [
{type: "addConnection", source: "If Node", target: "True Handler", sourcePort: "main", targetPort: "main", branch: "true"},
{type: "addConnection", source: "If Node", target: "False Handler", sourcePort: "main", targetPort: "main", branch: "false"}
]
})
```
**Note**: Without the `branch` parameter, both connections may end up on the same output, causing logic errors!
### removeConnection Syntax
Use the same four-parameter format:
```json
{
"type": "removeConnection",
"source": "source-node-id",
"target": "target-node-id",
"sourcePort": "main",
"targetPort": "main"
}
```
## Example Workflow
### Template-First Approach
@@ -857,32 +678,6 @@ n8n_update_partial_workflow({
- **Avoid when possible** - Prefer standard nodes
- **Only when necessary** - Use code node as last resort
- **AI tool capability** - ANY node can be an AI tool (not just marked ones)
### Most Popular n8n Nodes (for get_node_essentials):
1. **n8n-nodes-base.code** - JavaScript/Python scripting
2. **n8n-nodes-base.httpRequest** - HTTP API calls
3. **n8n-nodes-base.webhook** - Event-driven triggers
4. **n8n-nodes-base.set** - Data transformation
5. **n8n-nodes-base.if** - Conditional routing
6. **n8n-nodes-base.manualTrigger** - Manual workflow execution
7. **n8n-nodes-base.respondToWebhook** - Webhook responses
8. **n8n-nodes-base.scheduleTrigger** - Time-based triggers
9. **@n8n/n8n-nodes-langchain.agent** - AI agents
10. **n8n-nodes-base.googleSheets** - Spreadsheet integration
11. **n8n-nodes-base.merge** - Data merging
12. **n8n-nodes-base.switch** - Multi-branch routing
13. **n8n-nodes-base.telegram** - Telegram bot integration
14. **@n8n/n8n-nodes-langchain.lmChatOpenAi** - OpenAI chat models
15. **n8n-nodes-base.splitInBatches** - Batch processing
16. **n8n-nodes-base.openAi** - OpenAI legacy node
17. **n8n-nodes-base.gmail** - Email automation
18. **n8n-nodes-base.function** - Custom functions
19. **n8n-nodes-base.stickyNote** - Workflow documentation
20. **n8n-nodes-base.executeWorkflowTrigger** - Sub-workflow calls
**Note:** LangChain nodes use the `@n8n/n8n-nodes-langchain.` prefix, core nodes use `n8n-nodes-base.`
````
Save these instructions in your Claude Project for optimal n8n workflow assistance with intelligent template discovery.
@@ -904,11 +699,6 @@ This tool was created to benefit everyone in the n8n community without friction.
- **📖 Essential Properties**: Get only the 10-20 properties that matter
- **💡 Real-World Examples**: 2,646 pre-extracted configurations from popular templates
- **✅ Config Validation**: Validate node configurations before deployment
- **🤖 AI Workflow Validation**: Comprehensive validation for AI Agent workflows (NEW in v2.17.0!)
- Missing language model detection
- AI tool connection validation
- Streaming mode constraints
- Memory and output parser checks
- **🔗 Dependency Analysis**: Understand property relationships and conditions
- **🎯 Template Discovery**: 2,500+ workflow templates with smart filtering
- **⚡ Fast Response**: Average query time ~12ms with optimized SQLite
@@ -950,18 +740,12 @@ Once connected, Claude can use these powerful tools:
- **`get_template`** - Get complete workflow JSON for import
- **`get_templates_for_task`** - Curated templates for common automation tasks
### Validation Tools
- **`validate_workflow`** - Complete workflow validation including **AI Agent validation** (NEW in v2.17.0!)
- Detects missing language model connections
- Validates AI tool connections (no false warnings)
- Enforces streaming mode constraints
- Checks memory and output parser configurations
- **`validate_workflow_connections`** - Check workflow structure and AI tool connections
- **`validate_workflow_expressions`** - Validate n8n expressions including $fromAI()
### Advanced Tools
- **`validate_node_operation`** - Validate node configurations (operation-aware, profiles support)
- **`validate_node_minimal`** - Quick validation for just required fields
### Advanced Tools
- **`validate_workflow`** - Complete workflow validation including AI tool connections
- **`validate_workflow_connections`** - Check workflow structure and AI tool connections
- **`validate_workflow_expressions`** - Validate n8n expressions including $fromAI()
- **`get_property_dependencies`** - Analyze property visibility conditions
- **`get_node_documentation`** - Get parsed documentation from n8n-docs
- **`get_database_statistics`** - View database metrics and coverage
@@ -1211,6 +995,45 @@ MIT License - see [LICENSE](LICENSE) for details.
- 🔗 Linking back to this repo
## 🔒 Security & Dependencies
### Upstream Dependencies
This project depends on n8n packages which are maintained by the n8n team. Any vulnerabilities in the following packages are upstream responsibilities:
- `n8n-workflow`
- `n8n-nodes-base`
- `@n8n/n8n-nodes-langchain`
- Related n8n dependencies (@n8n/*, @langchain/*)
We sync with n8n releases using `npm run update:n8n` when new versions are published by the n8n team.
### Direct Dependencies
Our direct dependencies (express, axios, helmet, etc.) are kept up to date. Run `npm audit` to check current status:
```bash
# Check for vulnerabilities in project dependencies
npm audit
# Note: Vulnerabilities in n8n packages are upstream responsibilities
# and will be fixed by the n8n team in their releases
```
### Security Updates
- **Monitor n8n releases**: https://github.com/n8n-io/n8n/releases
- **Check our dependencies**: `npm audit`
- **Check for n8n updates**: `npm run update:n8n:check`
- **Update n8n packages**: `npm run update:n8n` (when new version available)
### Security Configuration
For production deployments, ensure you configure:
- Strong `AUTH_TOKEN` (minimum 32 characters)
- Specific `CORS_ORIGIN` (not wildcard `*`)
- `WEBHOOK_SECURITY_MODE=strict` (default)
- Review [Security Best Practices](./docs/HTTP_DEPLOYMENT.md#security-best-practices)
## 🤝 Contributing
Contributions are welcome! Please:

Binary file not shown.

View File

@@ -1,111 +0,0 @@
# CI Test Infrastructure - Known Issues
## Integration Test Failures for External Contributor PRs
### Issue Summary
Integration tests fail for external contributor PRs with "No response from n8n server" errors, despite the code changes being correct. This is a **test infrastructure issue**, not a code quality issue.
### Root Cause
1. **GitHub Actions Security**: External contributor PRs don't get access to repository secrets (`N8N_API_URL`, `N8N_API_KEY`, etc.)
2. **MSW Mock Server**: Mock Service Worker (MSW) is not properly intercepting HTTP requests in the CI environment
3. **Test Configuration**: Integration tests expect `http://localhost:3001/mock-api` but the mock server isn't responding
### Evidence
From CI logs (PR #343):
```
[CI-DEBUG] Global setup complete, N8N_API_URL: http://localhost:3001/mock-api
❌ No response from n8n server (repeated 60+ times across 20 tests)
```
The tests ARE using the correct mock URL, but MSW isn't intercepting the requests.
### Why This Happens
**For External PRs:**
- GitHub Actions doesn't expose repository secrets for security reasons
- Prevents malicious PRs from exfiltrating secrets
- MSW setup runs but requests don't get intercepted in CI
**Test Configuration:**
- `.env.test` line 19: `N8N_API_URL=http://localhost:3001/mock-api`
- `.env.test` line 67: `MSW_ENABLED=true`
- CI workflow line 75-80: Secrets set but empty for external PRs
### Impact
-**Code Quality**: NOT affected - the actual code changes are correct
-**Local Testing**: Works fine - MSW intercepts requests locally
-**CI for External PRs**: Integration tests fail (infrastructure issue)
-**CI for Internal PRs**: Works fine (has access to secrets)
### Current Workarounds
1. **For Maintainers**: Use `--admin` flag to merge despite failing tests when code is verified correct
2. **For Contributors**: Run tests locally where MSW works properly
3. **For CI**: Unit tests pass (don't require n8n API), integration tests fail
### Files Affected
- `tests/integration/setup/integration-setup.ts` - MSW server setup
- `tests/setup/msw-setup.ts` - MSW configuration
- `tests/mocks/n8n-api/handlers.ts` - Mock request handlers
- `.github/workflows/test.yml` - CI configuration
- `.env.test` - Test environment configuration
### Potential Solutions (Not Implemented)
1. **Separate Unit/Integration Runs**
- Run integration tests only for internal PRs
- Skip integration tests for external PRs
- Rely on unit tests for external PR validation
2. **MSW CI Debugging**
- Add extensive logging to MSW setup
- Check if MSW server actually starts in CI
- Verify request interception is working
3. **Mock Server Process**
- Start actual HTTP server in CI instead of MSW
- More reliable but adds complexity
- Would require test infrastructure refactoring
4. **Public Test Instance**
- Use publicly accessible test n8n instance
- Exposes test data, security concerns
- Would work for external PRs
### Decision
**Status**: Documented but not fixed
**Rationale**:
- Integration test infrastructure refactoring is separate concern from code quality
- External PRs are relatively rare compared to internal development
- Unit tests provide sufficient coverage for most changes
- Maintainers can verify integration tests locally before merging
### Testing Strategy
**For External Contributor PRs:**
1. ✅ Unit tests must pass
2. ✅ TypeScript compilation must pass
3. ✅ Build must succeed
4. ⚠️ Integration test failures are expected (infrastructure issue)
5. ✅ Maintainer verifies locally before merge
**For Internal PRs:**
1. ✅ All tests must pass (unit + integration)
2. ✅ Full CI validation
### References
- PR #343: First occurrence of this issue
- PR #345: Documented the infrastructure issue
- Issue: External PRs don't get secrets (GitHub Actions security)
### Last Updated
2025-10-21 - Documented as part of PR #345 investigation

View File

@@ -80,53 +80,6 @@ Remove the server:
claude mcp remove n8n-mcp
```
## 🎓 Add Claude Skills (Optional)
Supercharge your n8n workflow building with specialized Claude Code skills! The [n8n-skills](https://github.com/czlonkowski/n8n-skills) repository provides 7 complementary skills that teach AI assistants how to build production-ready n8n workflows.
### What You Get
-**n8n Expression Syntax** - Correct {{}} patterns and common mistakes
-**n8n MCP Tools Expert** - How to use n8n-mcp tools effectively
-**n8n Workflow Patterns** - 5 proven architectural patterns
-**n8n Validation Expert** - Interpret and fix validation errors
-**n8n Node Configuration** - Operation-aware setup guidance
-**n8n Code JavaScript** - Write effective JavaScript in Code nodes
-**n8n Code Python** - Python patterns with limitation awareness
### Installation
**Method 1: Plugin Installation** (Recommended)
```bash
/plugin install czlonkowski/n8n-skills
```
**Method 2: Via Marketplace**
```bash
# Add as marketplace, then browse and install
/plugin marketplace add czlonkowski/n8n-skills
# Then browse available plugins
/plugin install
# Select "n8n-mcp-skills" from the list
```
**Method 3: Manual Installation**
```bash
# 1. Clone the repository
git clone https://github.com/czlonkowski/n8n-skills.git
# 2. Copy skills to your Claude Code skills directory
cp -r n8n-skills/skills/* ~/.claude/skills/
# 3. Reload Claude Code
# Skills will activate automatically
```
For complete installation instructions, configuration options, and usage examples, see the [n8n-skills README](https://github.com/czlonkowski/n8n-skills#-installation).
Skills work seamlessly with n8n-mcp to provide expert guidance throughout the workflow building process!
## Project Instructions
For optimal results, create a `CLAUDE.md` file in your project root with the instructions from the [main README's Claude Project Setup section](../README.md#-claude-project-setup).

File diff suppressed because it is too large Load Diff

View File

@@ -1,724 +0,0 @@
# Library Usage Guide - Multi-Tenant / Hosted Deployments
This guide covers using n8n-mcp as a library dependency for building multi-tenant hosted services.
## Overview
n8n-mcp can be used as a Node.js library to build multi-tenant backends that provide MCP services to multiple users or instances. The package exports all necessary components for integration into your existing services.
## Installation
```bash
npm install n8n-mcp
```
## Core Concepts
### Library Mode vs CLI Mode
- **CLI Mode** (default): Single-player usage via `npx n8n-mcp` or Docker
- **Library Mode**: Multi-tenant usage by importing and using the `N8NMCPEngine` class
### Instance Context
The `InstanceContext` type allows you to pass per-request configuration to the MCP engine:
```typescript
interface InstanceContext {
// Instance-specific n8n API configuration
n8nApiUrl?: string;
n8nApiKey?: string;
n8nApiTimeout?: number;
n8nApiMaxRetries?: number;
// Instance identification
instanceId?: string;
sessionId?: string;
// Extensible metadata
metadata?: Record<string, any>;
}
```
## Basic Example
```typescript
import express from 'express';
import { N8NMCPEngine } from 'n8n-mcp';
const app = express();
const mcpEngine = new N8NMCPEngine({
sessionTimeout: 3600000, // 1 hour
logLevel: 'info'
});
// Handle MCP requests with per-user context
app.post('/mcp', async (req, res) => {
const instanceContext = {
n8nApiUrl: req.user.n8nUrl,
n8nApiKey: req.user.n8nApiKey,
instanceId: req.user.id
};
await mcpEngine.processRequest(req, res, instanceContext);
});
app.listen(3000);
```
## Multi-Tenant Backend Example
This example shows a complete multi-tenant implementation with user authentication and instance management:
```typescript
import express from 'express';
import { N8NMCPEngine, InstanceContext, validateInstanceContext } from 'n8n-mcp';
const app = express();
const mcpEngine = new N8NMCPEngine({
sessionTimeout: 3600000, // 1 hour
logLevel: 'info'
});
// Start MCP engine
await mcpEngine.start();
// Authentication middleware
const authenticate = async (req, res, next) => {
const token = req.headers.authorization?.replace('Bearer ', '');
if (!token) {
return res.status(401).json({ error: 'Unauthorized' });
}
// Verify token and attach user to request
req.user = await getUserFromToken(token);
next();
};
// Get instance configuration from database
const getInstanceConfig = async (instanceId: string, userId: string) => {
// Your database logic here
const instance = await db.instances.findOne({
where: { id: instanceId, userId }
});
if (!instance) {
throw new Error('Instance not found');
}
return {
n8nApiUrl: instance.n8nUrl,
n8nApiKey: await decryptApiKey(instance.encryptedApiKey),
instanceId: instance.id
};
};
// MCP endpoint with per-instance context
app.post('/api/instances/:instanceId/mcp', authenticate, async (req, res) => {
try {
// Get instance configuration
const instance = await getInstanceConfig(req.params.instanceId, req.user.id);
// Create instance context
const context: InstanceContext = {
n8nApiUrl: instance.n8nApiUrl,
n8nApiKey: instance.n8nApiKey,
instanceId: instance.instanceId,
metadata: {
userId: req.user.id,
userAgent: req.headers['user-agent'],
ip: req.ip
}
};
// Validate context before processing
const validation = validateInstanceContext(context);
if (!validation.valid) {
return res.status(400).json({
error: 'Invalid instance configuration',
details: validation.errors
});
}
// Process request with instance context
await mcpEngine.processRequest(req, res, context);
} catch (error) {
console.error('MCP request error:', error);
res.status(500).json({ error: 'Internal server error' });
}
});
// Health endpoint
app.get('/health', async (req, res) => {
const health = await mcpEngine.healthCheck();
res.status(health.status === 'healthy' ? 200 : 503).json(health);
});
// Graceful shutdown
process.on('SIGTERM', async () => {
await mcpEngine.shutdown();
process.exit(0);
});
app.listen(3000);
```
## API Reference
### N8NMCPEngine
#### Constructor
```typescript
new N8NMCPEngine(options?: {
sessionTimeout?: number; // Session TTL in ms (default: 1800000 = 30min)
logLevel?: 'error' | 'warn' | 'info' | 'debug'; // Default: 'info'
})
```
#### Methods
##### `async processRequest(req, res, context?)`
Process a single MCP request with optional instance context.
**Parameters:**
- `req`: Express request object
- `res`: Express response object
- `context` (optional): InstanceContext with per-instance configuration
**Example:**
```typescript
const context: InstanceContext = {
n8nApiUrl: 'https://instance1.n8n.cloud',
n8nApiKey: 'instance1-key',
instanceId: 'tenant-123'
};
await engine.processRequest(req, res, context);
```
##### `async healthCheck()`
Get engine health status for monitoring.
**Returns:** `EngineHealth`
```typescript
{
status: 'healthy' | 'unhealthy';
uptime: number; // seconds
sessionActive: boolean;
memoryUsage: {
used: number;
total: number;
unit: string;
};
version: string;
}
```
**Example:**
```typescript
app.get('/health', async (req, res) => {
const health = await engine.healthCheck();
res.status(health.status === 'healthy' ? 200 : 503).json(health);
});
```
##### `getSessionInfo()`
Get current session information for debugging.
**Returns:**
```typescript
{
active: boolean;
sessionId?: string;
age?: number; // milliseconds
sessions?: {
total: number;
active: number;
expired: number;
max: number;
sessionIds: string[];
};
}
```
##### `async start()`
Start the engine (for standalone mode). Not needed when using `processRequest()` directly.
##### `async shutdown()`
Graceful shutdown for service lifecycle management.
**Example:**
```typescript
process.on('SIGTERM', async () => {
await engine.shutdown();
process.exit(0);
});
```
### Types
#### InstanceContext
Configuration for a specific user instance:
```typescript
interface InstanceContext {
n8nApiUrl?: string;
n8nApiKey?: string;
n8nApiTimeout?: number;
n8nApiMaxRetries?: number;
instanceId?: string;
sessionId?: string;
metadata?: Record<string, any>;
}
```
#### Validation Functions
##### `validateInstanceContext(context: InstanceContext)`
Validate and sanitize instance context.
**Returns:**
```typescript
{
valid: boolean;
errors?: string[];
}
```
**Example:**
```typescript
import { validateInstanceContext } from 'n8n-mcp';
const validation = validateInstanceContext(context);
if (!validation.valid) {
console.error('Invalid context:', validation.errors);
}
```
##### `isInstanceContext(obj: any)`
Type guard to check if an object is a valid InstanceContext.
**Example:**
```typescript
import { isInstanceContext } from 'n8n-mcp';
if (isInstanceContext(req.body.context)) {
// TypeScript knows this is InstanceContext
await engine.processRequest(req, res, req.body.context);
}
```
## Session Management
### Session Strategies
The MCP engine supports flexible session ID formats:
- **UUIDv4**: Internal n8n-mcp format (default)
- **Instance-prefixed**: `instance-{userId}-{hash}-{uuid}` for multi-tenant isolation
- **Custom formats**: Any non-empty string for mcp-remote and other proxies
Session validation happens via transport lookup, not format validation. This ensures compatibility with all MCP clients.
### Multi-Tenant Configuration
Set these environment variables for multi-tenant mode:
```bash
# Enable multi-tenant mode
ENABLE_MULTI_TENANT=true
# Session strategy: "instance" (default) or "shared"
MULTI_TENANT_SESSION_STRATEGY=instance
```
**Session Strategies:**
- **instance** (recommended): Each tenant gets isolated sessions
- Session ID: `instance-{instanceId}-{configHash}-{uuid}`
- Better isolation and security
- Easier debugging per tenant
- **shared**: Multiple tenants share sessions with context switching
- More efficient for high tenant count
- Requires careful context management
## Security Considerations
### API Key Management
Always encrypt API keys server-side:
```typescript
import { createCipheriv, createDecipheriv } from 'crypto';
// Encrypt before storing
const encryptApiKey = (apiKey: string) => {
const cipher = createCipheriv('aes-256-gcm', encryptionKey, iv);
return cipher.update(apiKey, 'utf8', 'hex') + cipher.final('hex');
};
// Decrypt before using
const decryptApiKey = (encrypted: string) => {
const decipher = createDecipheriv('aes-256-gcm', encryptionKey, iv);
return decipher.update(encrypted, 'hex', 'utf8') + decipher.final('utf8');
};
// Use decrypted key in context
const context: InstanceContext = {
n8nApiKey: await decryptApiKey(instance.encryptedApiKey),
// ...
};
```
### Input Validation
Always validate instance context before processing:
```typescript
import { validateInstanceContext } from 'n8n-mcp';
const validation = validateInstanceContext(context);
if (!validation.valid) {
throw new Error(`Invalid context: ${validation.errors?.join(', ')}`);
}
```
### Rate Limiting
Implement rate limiting per tenant:
```typescript
import rateLimit from 'express-rate-limit';
const limiter = rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: 100, // limit each IP to 100 requests per windowMs
keyGenerator: (req) => req.user?.id || req.ip
});
app.post('/api/instances/:instanceId/mcp', authenticate, limiter, async (req, res) => {
// ...
});
```
## Error Handling
Always wrap MCP requests in try-catch blocks:
```typescript
app.post('/api/instances/:instanceId/mcp', authenticate, async (req, res) => {
try {
const context = await getInstanceConfig(req.params.instanceId, req.user.id);
await mcpEngine.processRequest(req, res, context);
} catch (error) {
console.error('MCP error:', error);
// Don't leak internal errors to clients
if (error.message.includes('not found')) {
return res.status(404).json({ error: 'Instance not found' });
}
res.status(500).json({ error: 'Internal server error' });
}
});
```
## Monitoring
### Health Checks
Set up periodic health checks:
```typescript
setInterval(async () => {
const health = await mcpEngine.healthCheck();
if (health.status === 'unhealthy') {
console.error('MCP engine unhealthy:', health);
// Alert your monitoring system
}
// Log metrics
console.log('MCP engine metrics:', {
uptime: health.uptime,
memory: health.memoryUsage,
sessionActive: health.sessionActive
});
}, 60000); // Every minute
```
### Session Monitoring
Track active sessions:
```typescript
app.get('/admin/sessions', authenticate, async (req, res) => {
if (!req.user.isAdmin) {
return res.status(403).json({ error: 'Forbidden' });
}
const sessionInfo = mcpEngine.getSessionInfo();
res.json(sessionInfo);
});
```
## Testing
### Unit Testing
```typescript
import { N8NMCPEngine, InstanceContext } from 'n8n-mcp';
describe('MCP Engine', () => {
let engine: N8NMCPEngine;
beforeEach(() => {
engine = new N8NMCPEngine({ logLevel: 'error' });
});
afterEach(async () => {
await engine.shutdown();
});
it('should process request with context', async () => {
const context: InstanceContext = {
n8nApiUrl: 'https://test.n8n.io',
n8nApiKey: 'test-key',
instanceId: 'test-instance'
};
const mockReq = createMockRequest();
const mockRes = createMockResponse();
await engine.processRequest(mockReq, mockRes, context);
expect(mockRes.status).toBe(200);
});
});
```
### Integration Testing
```typescript
import request from 'supertest';
import { createApp } from './app';
describe('Multi-tenant MCP API', () => {
let app;
let authToken;
beforeAll(async () => {
app = await createApp();
authToken = await getTestAuthToken();
});
it('should handle MCP request for instance', async () => {
const response = await request(app)
.post('/api/instances/test-instance/mcp')
.set('Authorization', `Bearer ${authToken}`)
.send({
jsonrpc: '2.0',
method: 'initialize',
params: {
protocolVersion: '2024-11-05',
capabilities: {}
},
id: 1
});
expect(response.status).toBe(200);
expect(response.body.result).toBeDefined();
});
});
```
## Deployment Considerations
### Environment Variables
```bash
# Required for multi-tenant mode
ENABLE_MULTI_TENANT=true
MULTI_TENANT_SESSION_STRATEGY=instance
# Optional: Logging
LOG_LEVEL=info
DISABLE_CONSOLE_OUTPUT=false
# Optional: Session configuration
SESSION_TIMEOUT=1800000 # 30 minutes in milliseconds
MAX_SESSIONS=100
# Optional: Performance
NODE_ENV=production
```
### Docker Deployment
```dockerfile
FROM node:20-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
ENV NODE_ENV=production
ENV ENABLE_MULTI_TENANT=true
ENV LOG_LEVEL=info
EXPOSE 3000
CMD ["node", "dist/server.js"]
```
### Kubernetes Deployment
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: n8n-mcp-backend
spec:
replicas: 3
selector:
matchLabels:
app: n8n-mcp-backend
template:
metadata:
labels:
app: n8n-mcp-backend
spec:
containers:
- name: backend
image: your-registry/n8n-mcp-backend:latest
ports:
- containerPort: 3000
env:
- name: ENABLE_MULTI_TENANT
value: "true"
- name: LOG_LEVEL
value: "info"
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
memory: "512Mi"
cpu: "500m"
livenessProbe:
httpGet:
path: /health
port: 3000
initialDelaySeconds: 10
periodSeconds: 30
readinessProbe:
httpGet:
path: /health
port: 3000
initialDelaySeconds: 5
periodSeconds: 10
```
## Examples
### Complete Multi-Tenant SaaS Example
For a complete implementation example, see:
- [n8n-mcp-backend](https://github.com/czlonkowski/n8n-mcp-backend) - Full hosted service implementation
### Migration from Single-Player
If you're migrating from single-player (CLI/Docker) to multi-tenant:
1. **Keep backward compatibility** - Use environment fallback:
```typescript
const context: InstanceContext = {
n8nApiUrl: instanceUrl || process.env.N8N_API_URL,
n8nApiKey: instanceKey || process.env.N8N_API_KEY,
instanceId: instanceId || 'default'
};
```
2. **Gradual rollout** - Start with a feature flag:
```typescript
const isMultiTenant = process.env.ENABLE_MULTI_TENANT === 'true';
if (isMultiTenant) {
const context = await getInstanceConfig(req.params.instanceId);
await engine.processRequest(req, res, context);
} else {
// Legacy single-player mode
await engine.processRequest(req, res);
}
```
## Troubleshooting
### Common Issues
#### Module Resolution Errors
If you see `Cannot find module 'n8n-mcp'`:
```bash
# Clear node_modules and reinstall
rm -rf node_modules package-lock.json
npm install
# Verify package has types field
npm info n8n-mcp
# Check TypeScript can resolve it
npx tsc --noEmit
```
#### Session ID Validation Errors
If you see `Invalid session ID format` errors:
- Ensure you're using n8n-mcp v2.18.9 or later
- Session IDs can be any non-empty string
- No need to generate UUIDs - use your own format
#### Memory Leaks
If memory usage grows over time:
```typescript
// Ensure proper cleanup
process.on('SIGTERM', async () => {
await engine.shutdown();
process.exit(0);
});
// Monitor session count
const sessionInfo = engine.getSessionInfo();
console.log('Active sessions:', sessionInfo.sessions?.active);
```
## Further Reading
- [MCP Protocol Specification](https://modelcontextprotocol.io/docs)
- [n8n API Documentation](https://docs.n8n.io/api/)
- [Express.js Guide](https://expressjs.com/en/guide/routing.html)
- [n8n-mcp Main README](../README.md)
## Support
- **Issues**: [GitHub Issues](https://github.com/czlonkowski/n8n-mcp/issues)
- **Discussions**: [GitHub Discussions](https://github.com/czlonkowski/n8n-mcp/discussions)
- **Security**: For security issues, see [SECURITY.md](../SECURITY.md)

View File

@@ -0,0 +1,62 @@
# PR #104 Test Suite Improvements Summary
## Overview
Based on comprehensive review feedback from PR #104, we've significantly improved the test suite quality, organization, and coverage.
## Test Results
- **Before:** 78 failing tests
- **After:** 0 failing tests (1,356 passed, 19 skipped)
- **Coverage:** 85.34% statements, 85.3% branches
## Key Improvements
### 1. Fixed All Test Failures
- Fixed logger test spy issues by properly handling DEBUG environment variable
- Fixed MSW configuration test by restoring environment variables
- Fixed workflow validator tests by adding proper node connections
- Fixed mock setup issues in edge case tests
### 2. Improved Test Organization
- Split large config-validator.test.ts (1,075 lines) into 4 focused files:
- config-validator-basic.test.ts
- config-validator-node-specific.test.ts
- config-validator-security.test.ts
- config-validator-edge-cases.test.ts
### 3. Enhanced Test Coverage
- Added comprehensive edge case tests for all major validators
- Added null/undefined handling tests
- Added boundary value tests
- Added performance tests with CI-aware timeouts
- Added security validation tests
### 4. Improved Test Quality
- Fixed test naming conventions (100% compliance with "should X when Y" pattern)
- Added JSDoc comments to test utilities and factories
- Created comprehensive test documentation (tests/README.md)
- Improved test isolation to prevent cross-test pollution
### 5. New Features
- Implemented validateBatch method for ConfigValidator
- Added test factories for better test data management
- Created test utilities for common scenarios
## Files Modified
- 7 existing test files fixed
- 8 new test files created
- 1 source file enhanced (ConfigValidator)
- 4 debug files removed before commit
## Skipped Tests
19 tests remain skipped with documented reasons:
- FTS5 search sync test (database corruption in CI)
- Template clearing (not implemented)
- Mock API configuration tests
- Duplicate edge case tests with mocking issues (working versions exist)
## Next Steps
The only remaining task from the improvement plan is:
- Add performance regression tests and boundaries (low priority, future sprint)
## Conclusion
The test suite is now robust, well-organized, and provides excellent coverage. All critical issues have been resolved, and the codebase is ready for merge.

314
docs/TEMPLATE_METADATA.md Normal file
View File

@@ -0,0 +1,314 @@
# Template Metadata Generation
This document describes the template metadata generation system introduced in n8n-MCP v2.10.0, which uses OpenAI's batch API to automatically analyze and categorize workflow templates.
## Overview
The template metadata system analyzes n8n workflow templates to extract structured information about their purpose, complexity, requirements, and target audience. This enables intelligent template discovery through advanced filtering capabilities.
## Architecture
### Components
1. **MetadataGenerator** (`src/templates/metadata-generator.ts`)
- Interfaces with OpenAI API
- Generates structured metadata using JSON schemas
- Provides fallback defaults for error cases
2. **BatchProcessor** (`src/templates/batch-processor.ts`)
- Manages OpenAI batch API operations
- Handles parallel batch submission
- Monitors batch status and retrieves results
3. **Template Repository** (`src/templates/template-repository.ts`)
- Stores metadata in SQLite database
- Provides advanced search capabilities
- Supports JSON extraction queries
## Metadata Schema
Each template's metadata contains:
```typescript
{
categories: string[] // Max 5 categories (e.g., "automation", "integration")
complexity: "simple" | "medium" | "complex"
use_cases: string[] // Max 5 primary use cases
estimated_setup_minutes: number // 5-480 minutes
required_services: string[] // External services needed
key_features: string[] // Max 5 main capabilities
target_audience: string[] // Max 3 target user types
}
```
## Generation Process
### 1. Initial Setup
```bash
# Set OpenAI API key in .env
OPENAI_API_KEY=your-api-key-here
```
### 2. Generate Metadata for Existing Templates
```bash
# Generate metadata only (no template fetching)
npm run fetch:templates -- --metadata-only
# Generate metadata during update
npm run fetch:templates -- --mode=update --generate-metadata
```
### 3. Batch Processing
The system uses OpenAI's batch API for cost-effective processing:
- **50% cost reduction** compared to synchronous API calls
- **24-hour processing window** for batch completion
- **Parallel batch submission** for faster processing
- **Automatic retry** for failed items
### Configuration Options
Environment variables:
- `OPENAI_API_KEY`: Required for metadata generation
- `OPENAI_MODEL`: Model to use (default: "gpt-4o-mini")
- `OPENAI_BATCH_SIZE`: Templates per batch (default: 100, max: 500)
- `METADATA_LIMIT`: Limit templates to process (for testing)
## How It Works
### 1. Template Analysis
For each template, the generator analyzes:
- Template name and description
- Node types and their frequency
- Workflow structure and connections
- Overall complexity
### 2. Node Summarization
Nodes are grouped into categories:
- HTTP/Webhooks
- Database operations
- Communication (Slack, Email)
- AI/ML operations
- Spreadsheets
- Service-specific nodes
### 3. Metadata Generation
The AI model receives:
```
Template: [name]
Description: [description]
Nodes Used (X): [summarized node list]
Workflow has X nodes with Y connections
```
And generates structured metadata following the JSON schema.
### 4. Storage and Indexing
Metadata is stored as JSON in SQLite and indexed for fast querying:
```sql
-- Example query for simple automation templates
SELECT * FROM templates
WHERE json_extract(metadata, '$.complexity') = 'simple'
AND json_extract(metadata, '$.categories') LIKE '%automation%'
```
## MCP Tool Integration
### search_templates_by_metadata
Advanced filtering tool with multiple parameters:
```typescript
search_templates_by_metadata({
category: "automation", // Filter by category
complexity: "simple", // Skill level
maxSetupMinutes: 30, // Time constraint
targetAudience: "marketers", // Role-based
requiredService: "slack" // Service dependency
})
```
### list_templates
Enhanced to include metadata:
```typescript
list_templates({
includeMetadata: true, // Include full metadata
limit: 20,
offset: 0
})
```
## Usage Examples
### Finding Beginner-Friendly Templates
```typescript
const templates = await search_templates_by_metadata({
complexity: "simple",
maxSetupMinutes: 15
});
```
### Role-Specific Templates
```typescript
const marketingTemplates = await search_templates_by_metadata({
targetAudience: "marketers",
category: "communication"
});
```
### Service Integration Templates
```typescript
const openaiTemplates = await search_templates_by_metadata({
requiredService: "openai",
complexity: "medium"
});
```
## Performance Metrics
- **Coverage**: 97.5% of templates have metadata (2,534/2,598)
- **Generation Time**: ~2-4 hours for full database (using batch API)
- **Query Performance**: <100ms for metadata searches
- **Storage Overhead**: ~2MB additional database size
## Troubleshooting
### Common Issues
1. **Batch Processing Stuck**
- Check batch status: The API provides status updates
- Batches auto-expire after 24 hours
- Monitor using the batch ID in logs
2. **Missing Metadata**
- ~2.5% of templates may fail metadata generation
- Fallback defaults are provided
- Can regenerate with `--metadata-only` flag
3. **API Rate Limits**
- Batch API has generous limits (50,000 requests/batch)
- Cost is 50% of synchronous API
- Processing happens within 24-hour window
### Monitoring Batch Status
```bash
# Check current batch status (if logged)
curl https://api.openai.com/v1/batches/[batch-id] \
-H "Authorization: Bearer $OPENAI_API_KEY"
```
## Cost Analysis
### Batch API Pricing (gpt-4o-mini)
- Input: $0.075 per 1M tokens (50% of standard)
- Output: $0.30 per 1M tokens (50% of standard)
- Average template: ~300 input tokens, ~200 output tokens
- Total cost for 2,500 templates: ~$0.50
### Comparison with Synchronous API
- Synchronous cost: ~$1.00 for same volume
- Time saved: Parallel processing vs sequential
- Reliability: Automatic retries included
## Future Enhancements
### Planned Improvements
1. **Incremental Updates**
- Only generate metadata for new templates
- Track metadata version for updates
2. **Enhanced Analysis**
- Workflow complexity scoring
- Dependency graph analysis
- Performance impact estimates
3. **User Feedback Loop**
- Collect accuracy feedback
- Refine categorization over time
- Community-driven corrections
4. **Alternative Models**
- Support for local LLMs
- Claude API integration
- Configurable model selection
## Implementation Details
### Database Schema
```sql
-- Metadata stored as JSON column
ALTER TABLE templates ADD COLUMN metadata TEXT;
-- Indexes for common queries
CREATE INDEX idx_templates_complexity ON templates(
json_extract(metadata, '$.complexity')
);
CREATE INDEX idx_templates_setup_time ON templates(
json_extract(metadata, '$.estimated_setup_minutes')
);
```
### Error Handling
The system provides robust error handling:
1. **API Failures**: Fallback to default metadata
2. **Parsing Errors**: Logged with template ID
3. **Batch Failures**: Individual item retry
4. **Validation Errors**: Zod schema enforcement
## Maintenance
### Regenerating Metadata
```bash
# Full regeneration (caution: costs ~$0.50)
npm run fetch:templates -- --mode=rebuild --generate-metadata
# Partial regeneration (templates without metadata)
npm run fetch:templates -- --metadata-only
```
### Database Backup
```bash
# Backup before regeneration
cp data/nodes.db data/nodes.db.backup
# Restore if needed
cp data/nodes.db.backup data/nodes.db
```
## Security Considerations
1. **API Key Management**
- Store in `.env` file (gitignored)
- Never commit API keys
- Use environment variables in CI/CD
2. **Data Privacy**
- Only template structure is sent to API
- No user data or credentials included
- Processing happens in OpenAI's secure environment
## Conclusion
The template metadata system transforms template discovery from simple text search to intelligent, multi-dimensional filtering. By leveraging OpenAI's batch API, we achieve cost-effective, scalable metadata generation that significantly improves the user experience for finding relevant workflow templates.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 430 KiB

162
docs/issue-90-findings.md Normal file
View File

@@ -0,0 +1,162 @@
# Issue #90: "propertyValues[itemName] is not iterable" Error - Research Findings
## Executive Summary
The error "propertyValues[itemName] is not iterable" occurs when AI agents create workflows with incorrect data structures for n8n nodes that use `fixedCollection` properties. This primarily affects Switch Node v2, If Node, and Filter Node. The error prevents workflows from loading in the n8n UI, resulting in empty canvases.
## Root Cause Analysis
### 1. Data Structure Mismatch
The error occurs when n8n's validation engine expects an iterable array but encounters a non-iterable object. This happens with nodes using `fixedCollection` type properties.
**Incorrect Structure (causes error):**
```json
{
"rules": {
"conditions": {
"values": [
{
"value1": "={{$json.status}}",
"operation": "equals",
"value2": "active"
}
]
}
}
}
```
**Correct Structure:**
```json
{
"rules": {
"conditions": [
{
"value1": "={{$json.status}}",
"operation": "equals",
"value2": "active"
}
]
}
}
```
### 2. Affected Nodes
Based on the research and issue comments, the following nodes are affected:
1. **Switch Node v2** (`n8n-nodes-base.switch` with typeVersion: 2)
- Uses `rules` parameter with `conditions` fixedCollection
- v3 doesn't have this issue due to restructured schema
2. **If Node** (`n8n-nodes-base.if` with typeVersion: 1)
- Uses `conditions` parameter with nested conditions array
- Similar structure to Switch v2
3. **Filter Node** (`n8n-nodes-base.filter`)
- Uses `conditions` parameter
- Same fixedCollection pattern
### 3. Why AI Agents Create Incorrect Structures
1. **Training Data Issues**: AI models may have been trained on outdated or incorrect n8n workflow examples
2. **Nested Object Inference**: AI tends to create unnecessarily nested structures when it sees collection-type parameters
3. **Legacy Format Confusion**: Mixing v2 and v3 Switch node formats
4. **Schema Misinterpretation**: The term "fixedCollection" may lead AI to create object wrappers
## Current Impact
From issue #90 comments:
- Multiple users experiencing the issue
- Workflows fail to load completely (empty canvas)
- Users resort to using Switch Node v3 or direct API calls
- The issue appears in "most MCPs" according to user feedback
## Recommended Actions
### 1. Immediate Validation Enhancement
Add specific validation for fixedCollection properties in the workflow validator:
```typescript
// In workflow-validator.ts or enhanced-config-validator.ts
function validateFixedCollectionParameters(node, result) {
const problematicNodes = {
'n8n-nodes-base.switch': { version: 2, fields: ['rules'] },
'n8n-nodes-base.if': { version: 1, fields: ['conditions'] },
'n8n-nodes-base.filter': { version: 1, fields: ['conditions'] }
};
const nodeConfig = problematicNodes[node.type];
if (nodeConfig && node.typeVersion === nodeConfig.version) {
// Validate structure
}
}
```
### 2. Enhanced MCP Tool Validation
Update the validation tools to detect and prevent this specific error pattern:
1. **In `validate_node_operation` tool**: Add checks for fixedCollection structures
2. **In `validate_workflow` tool**: Include specific validation for Switch/If nodes
3. **In `n8n_create_workflow` tool**: Pre-validate parameters before submission
### 3. AI-Friendly Examples
Update workflow examples to show correct structures:
```typescript
// In workflow-examples.ts
export const SWITCH_NODE_EXAMPLE = {
name: "Switch",
type: "n8n-nodes-base.switch",
typeVersion: 3, // Prefer v3 over v2
parameters: {
// Correct v3 structure
}
};
```
### 4. Migration Strategy
For existing workflows with Switch v2:
1. Detect Switch v2 nodes in validation
2. Suggest migration to v3
3. Provide automatic conversion utility
### 5. Documentation Updates
1. Add warnings about fixedCollection structures in tool documentation
2. Include specific examples of correct vs incorrect structures
3. Document the Switch v2 to v3 migration path
## Proposed Implementation Priority
1. **High Priority**: Add validation to prevent creation of invalid structures
2. **High Priority**: Update existing validation tools to catch this error
3. **Medium Priority**: Add auto-fix capabilities to correct structures
4. **Medium Priority**: Update examples and documentation
5. **Low Priority**: Create migration utilities for v2 to v3
## Testing Strategy
1. Create test cases for each affected node type
2. Test both correct and incorrect structures
3. Verify validation catches all variants of the error
4. Test auto-fix suggestions work correctly
## Success Metrics
- Zero instances of "propertyValues[itemName] is not iterable" in newly created workflows
- Clear error messages that guide users to correct structures
- Successful validation of all Switch/If node configurations before workflow creation
## Next Steps
1. Implement validation enhancements in the workflow validator
2. Update MCP tools to include these validations
3. Add comprehensive tests
4. Update documentation with clear examples
5. Consider adding a migration tool for existing workflows

View File

@@ -0,0 +1,712 @@
# MCP Tools Documentation for LLMs
This document provides comprehensive documentation for the most commonly used MCP tools in the n8n-mcp server. Each tool includes parameters, return formats, examples, and best practices.
## Table of Contents
1. [search_nodes](#search_nodes)
2. [get_node_essentials](#get_node_essentials)
3. [list_nodes](#list_nodes)
4. [validate_node_minimal](#validate_node_minimal)
5. [validate_node_operation](#validate_node_operation)
6. [get_node_for_task](#get_node_for_task)
7. [n8n_create_workflow](#n8n_create_workflow)
8. [n8n_update_partial_workflow](#n8n_update_partial_workflow)
---
## search_nodes
**Brief Description**: Search for n8n nodes by keywords in names and descriptions.
### Parameters
- `query` (string, required): Search term - single word recommended for best results
- `limit` (number, optional): Maximum results to return (default: 20)
### Return Format
```json
{
"nodes": [
{
"nodeType": "nodes-base.slack",
"displayName": "Slack",
"description": "Send messages to Slack channels"
}
],
"totalFound": 5
}
```
### Common Use Cases
1. **Finding integration nodes**: `search_nodes("slack")` to find Slack integration
2. **Finding HTTP nodes**: `search_nodes("http")` for HTTP/webhook nodes
3. **Finding database nodes**: `search_nodes("postgres")` for PostgreSQL nodes
### Examples
```json
// Search for Slack-related nodes
{
"query": "slack",
"limit": 10
}
// Search for webhook nodes
{
"query": "webhook",
"limit": 20
}
```
### Performance Notes
- Fast operation (cached results)
- Single-word queries are more precise
- Returns results with OR logic (any word matches)
### Best Practices
- Use single words for precise results: "slack" not "send slack message"
- Try shorter terms if no results: "sheet" instead of "spreadsheet"
- Search is case-insensitive
- Common searches: "http", "webhook", "email", "database", "slack"
### Common Pitfalls
- Multi-word searches return too many results (OR logic)
- Searching for exact phrases doesn't work
- Node types aren't searchable here (use exact type with get_node_info)
### Related Tools
- `list_nodes` - Browse nodes by category
- `get_node_essentials` - Get node configuration after finding it
- `list_ai_tools` - Find AI-capable nodes specifically
---
## get_node_essentials
**Brief Description**: Get only the 10-20 most important properties for a node with working examples.
### Parameters
- `nodeType` (string, required): Full node type with prefix (e.g., "nodes-base.httpRequest")
### Return Format
```json
{
"nodeType": "nodes-base.httpRequest",
"displayName": "HTTP Request",
"essentialProperties": [
{
"name": "method",
"type": "options",
"default": "GET",
"options": ["GET", "POST", "PUT", "DELETE"],
"required": true
},
{
"name": "url",
"type": "string",
"required": true,
"placeholder": "https://api.example.com/endpoint"
}
],
"examples": [
{
"name": "Simple GET Request",
"configuration": {
"method": "GET",
"url": "https://api.example.com/users"
}
}
],
"tips": [
"Use expressions like {{$json.url}} to make URLs dynamic",
"Enable 'Split Into Items' for array responses"
]
}
```
### Common Use Cases
1. **Quick node configuration**: Get just what you need without parsing 100KB+ of data
2. **Learning node basics**: Understand essential properties with examples
3. **Building workflows efficiently**: 95% smaller responses than get_node_info
### Examples
```json
// Get essentials for HTTP Request node
{
"nodeType": "nodes-base.httpRequest"
}
// Get essentials for Slack node
{
"nodeType": "nodes-base.slack"
}
// Get essentials for OpenAI node
{
"nodeType": "nodes-langchain.openAi"
}
```
### Performance Notes
- Very fast (<5KB responses vs 100KB+ for full info)
- Curated for 20+ common nodes
- Automatic fallback for unconfigured nodes
### Best Practices
- Always use this before get_node_info
- Node type must include prefix: "nodes-base.slack" not "slack"
- Check examples section for working configurations
- Use tips section for common patterns
### Common Pitfalls
- Forgetting the prefix in node type
- Using wrong package name (n8n-nodes-base vs @n8n/n8n-nodes-langchain)
- Case sensitivity in node types
### Related Tools
- `get_node_info` - Full schema when essentials aren't enough
- `search_node_properties` - Find specific properties
- `get_node_for_task` - Pre-configured for common tasks
---
## list_nodes
**Brief Description**: List available n8n nodes with optional filtering by package, category, or capabilities.
### Parameters
- `package` (string, optional): Filter by exact package name
- `category` (string, optional): Filter by category (trigger, transform, output, input)
- `developmentStyle` (string, optional): Filter by implementation style
- `isAITool` (boolean, optional): Filter for AI-capable nodes
- `limit` (number, optional): Maximum results (default: 50, max: 500)
### Return Format
```json
{
"nodes": [
{
"nodeType": "nodes-base.webhook",
"displayName": "Webhook",
"description": "Receive HTTP requests",
"categories": ["trigger"],
"version": 2
}
],
"total": 104,
"hasMore": false
}
```
### Common Use Cases
1. **Browse all triggers**: `list_nodes({category: "trigger", limit: 200})`
2. **List all nodes**: `list_nodes({limit: 500})`
3. **Find AI nodes**: `list_nodes({isAITool: true})`
4. **Browse core nodes**: `list_nodes({package: "n8n-nodes-base"})`
### Examples
```json
// List all trigger nodes
{
"category": "trigger",
"limit": 200
}
// List all AI-capable nodes
{
"isAITool": true,
"limit": 100
}
// List nodes from core package
{
"package": "n8n-nodes-base",
"limit": 200
}
```
### Performance Notes
- Fast operation (cached results)
- Default limit of 50 may miss nodes - use 200+
- Returns metadata only, not full schemas
### Best Practices
- Always set limit to 200+ for complete results
- Use exact package names: "n8n-nodes-base" not "@n8n/n8n-nodes-base"
- Categories are singular: "trigger" not "triggers"
- Common categories: trigger (104), transform, output, input
### Common Pitfalls
- Default limit (50) misses many nodes
- Using wrong package name format
- Multiple filters may return empty results
### Related Tools
- `search_nodes` - Search by keywords
- `list_ai_tools` - Specifically for AI nodes
- `get_database_statistics` - Overview of all nodes
---
## validate_node_minimal
**Brief Description**: Quick validation checking only for missing required fields.
### Parameters
- `nodeType` (string, required): Node type to validate (e.g., "nodes-base.slack")
- `config` (object, required): Node configuration to check
### Return Format
```json
{
"valid": false,
"missingRequired": ["channel", "messageType"],
"message": "Missing 2 required fields"
}
```
### Common Use Cases
1. **Quick validation**: Check if all required fields are present
2. **Pre-flight check**: Validate before creating workflow
3. **Minimal overhead**: Fastest validation option
### Examples
```json
// Validate Slack message configuration
{
"nodeType": "nodes-base.slack",
"config": {
"resource": "message",
"operation": "send",
"text": "Hello World"
// Missing: channel
}
}
// Validate HTTP Request
{
"nodeType": "nodes-base.httpRequest",
"config": {
"method": "POST"
// Missing: url
}
}
```
### Performance Notes
- Fastest validation option
- No schema loading overhead
- Returns only missing fields
### Best Practices
- Use for quick checks during workflow building
- Follow up with validate_node_operation for complex nodes
- Check operation-specific requirements
### Common Pitfalls
- Doesn't validate field values or types
- Doesn't check operation-specific requirements
- Won't catch configuration errors beyond missing fields
### Related Tools
- `validate_node_operation` - Comprehensive validation
- `validate_workflow` - Full workflow validation
---
## validate_node_operation
**Brief Description**: Comprehensive node configuration validation with operation awareness and helpful error messages.
### Parameters
- `nodeType` (string, required): Node type to validate
- `config` (object, required): Complete node configuration including operation fields
- `profile` (string, optional): Validation profile (minimal, runtime, ai-friendly, strict)
### Return Format
```json
{
"valid": false,
"errors": [
{
"field": "channel",
"message": "Channel is required to send Slack message",
"suggestion": "Add channel: '#general' or '@username'"
}
],
"warnings": [
{
"field": "unfurl_links",
"message": "Consider setting unfurl_links: false for better performance"
}
],
"examples": {
"minimal": {
"resource": "message",
"operation": "send",
"channel": "#general",
"text": "Hello World"
}
}
}
```
### Common Use Cases
1. **Complex node validation**: Slack, Google Sheets, databases
2. **Operation-specific checks**: Different rules per operation
3. **Getting fix suggestions**: Helpful error messages with solutions
### Examples
```json
// Validate Slack configuration
{
"nodeType": "nodes-base.slack",
"config": {
"resource": "message",
"operation": "send",
"text": "Hello team!"
},
"profile": "ai-friendly"
}
// Validate Google Sheets operation
{
"nodeType": "nodes-base.googleSheets",
"config": {
"operation": "append",
"sheetId": "1234567890",
"range": "Sheet1!A:Z"
},
"profile": "runtime"
}
```
### Performance Notes
- Slower than minimal validation
- Loads full node schema
- Operation-aware validation rules
### Best Practices
- Use "ai-friendly" profile for balanced validation
- Check examples in response for working configurations
- Follow suggestions to fix errors
- Essential for complex nodes (Slack, databases, APIs)
### Common Pitfalls
- Forgetting operation fields (resource, operation, action)
- Using wrong profile (too strict or too lenient)
- Ignoring warnings that could cause runtime issues
### Related Tools
- `validate_node_minimal` - Quick required field check
- `get_property_dependencies` - Understand field relationships
- `validate_workflow` - Validate entire workflow
---
## get_node_for_task
**Brief Description**: Get pre-configured node settings for common automation tasks.
### Parameters
- `task` (string, required): Task identifier (e.g., "post_json_request", "receive_webhook")
### Return Format
```json
{
"task": "post_json_request",
"nodeType": "nodes-base.httpRequest",
"displayName": "HTTP Request",
"configuration": {
"method": "POST",
"url": "={{ $json.api_endpoint }}",
"responseFormat": "json",
"options": {
"bodyContentType": "json"
},
"bodyParametersJson": "={{ JSON.stringify($json) }}"
},
"userMustProvide": [
"url - The API endpoint URL",
"bodyParametersJson - The JSON data to send"
],
"tips": [
"Use expressions to make values dynamic",
"Enable 'Split Into Items' for batch processing"
]
}
```
### Common Use Cases
1. **Quick task setup**: Configure nodes for specific tasks instantly
2. **Learning patterns**: See how to configure nodes properly
3. **Common workflows**: Standard patterns like webhooks, API calls, database queries
### Examples
```json
// Get configuration for JSON POST request
{
"task": "post_json_request"
}
// Get webhook receiver configuration
{
"task": "receive_webhook"
}
// Get AI chat configuration
{
"task": "chat_with_ai"
}
```
### Performance Notes
- Instant response (pre-configured templates)
- No database lookups required
- Includes working examples
### Best Practices
- Use list_tasks first to see available options
- Check userMustProvide section
- Follow tips for best results
- Common tasks: API calls, webhooks, database queries, AI chat
### Common Pitfalls
- Not all tasks available (use list_tasks)
- Configuration needs customization
- Some fields still need user input
### Related Tools
- `list_tasks` - See all available tasks
- `get_node_essentials` - Alternative approach
- `search_templates` - Find complete workflow templates
---
## n8n_create_workflow
**Brief Description**: Create a new workflow in n8n with nodes and connections.
### Parameters
- `name` (string, required): Workflow name
- `nodes` (array, required): Array of node definitions
- `connections` (object, required): Node connections mapping
- `settings` (object, optional): Workflow settings
### Return Format
```json
{
"id": "workflow-uuid",
"name": "My Workflow",
"active": false,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"nodes": [...],
"connections": {...}
}
```
### Common Use Cases
1. **Automated workflow creation**: Build workflows programmatically
2. **Template deployment**: Deploy pre-built workflow patterns
3. **Multi-workflow systems**: Create interconnected workflows
### Examples
```json
// Create simple webhook → HTTP request workflow
{
"name": "Webhook to API",
"nodes": [
{
"id": "webhook-1",
"name": "Webhook",
"type": "n8n-nodes-base.webhook",
"typeVersion": 2,
"position": [250, 300],
"parameters": {
"path": "/my-webhook",
"httpMethod": "POST"
}
},
{
"id": "http-1",
"name": "HTTP Request",
"type": "n8n-nodes-base.httpRequest",
"typeVersion": 4.2,
"position": [450, 300],
"parameters": {
"method": "POST",
"url": "https://api.example.com/process",
"responseFormat": "json"
}
}
],
"connections": {
"Webhook": {
"main": [[{"node": "HTTP Request", "type": "main", "index": 0}]]
}
}
}
```
### Performance Notes
- API call to n8n instance required
- Workflow created in inactive state
- Must be manually activated in UI
### Best Practices
- Always include typeVersion for nodes
- Use node names (not IDs) in connections
- Position nodes logically ([x, y] coordinates)
- Test with validate_workflow first
- Start simple, add complexity gradually
### Common Pitfalls
- Missing typeVersion causes errors
- Using node IDs instead of names in connections
- Forgetting required node properties
- Creating cycles in connections
- Workflow can't be activated via API
### Related Tools
- `validate_workflow` - Validate before creating
- `n8n_update_partial_workflow` - Modify existing workflows
- `n8n_trigger_webhook_workflow` - Execute workflows
---
## n8n_update_partial_workflow
**Brief Description**: Update workflows using diff operations for precise, incremental changes without sending the entire workflow.
### Parameters
- `id` (string, required): Workflow ID to update
- `operations` (array, required): Array of diff operations (max 5)
- `validateOnly` (boolean, optional): Test without applying changes
### Return Format
```json
{
"success": true,
"workflow": {
"id": "workflow-uuid",
"name": "Updated Workflow",
"nodes": [...],
"connections": {...}
},
"appliedOperations": 3
}
```
### Common Use Cases
1. **Add nodes to existing workflows**: Insert new functionality
2. **Update node configurations**: Change parameters without full replacement
3. **Manage connections**: Add/remove node connections
4. **Quick edits**: Rename, enable/disable nodes, update settings
### Examples
```json
// Add a new node and connect it
{
"id": "workflow-123",
"operations": [
{
"type": "addNode",
"node": {
"id": "set-1",
"name": "Set Data",
"type": "n8n-nodes-base.set",
"typeVersion": 3,
"position": [600, 300],
"parameters": {
"values": {
"string": [{
"name": "status",
"value": "processed"
}]
}
}
}
},
{
"type": "addConnection",
"source": "HTTP Request",
"target": "Set Data"
}
]
}
// Update multiple properties
{
"id": "workflow-123",
"operations": [
{
"type": "updateName",
"name": "Production Workflow v2"
},
{
"type": "updateNode",
"nodeName": "Webhook",
"changes": {
"parameters.path": "/v2/webhook"
}
},
{
"type": "addTag",
"tag": "production"
}
]
}
```
### Performance Notes
- 80-90% token savings vs full updates
- Maximum 5 operations per request
- Two-pass processing handles dependencies
- Transactional: all or nothing
### Best Practices
- Use validateOnly: true to test first
- Keep operations under 5 for reliability
- Operations can be in any order (v2.7.0+)
- Use node names, not IDs in operations
- For updateNode, use dot notation for nested paths
### Common Pitfalls
- Exceeding 5 operations limit
- Using node IDs instead of names
- Forgetting required node properties in addNode
- Not testing with validateOnly first
### Related Tools
- `n8n_update_full_workflow` - Complete workflow replacement
- `n8n_get_workflow` - Fetch current workflow state
- `validate_workflow` - Validate changes before applying
---
## Quick Reference
### Workflow Building Process
1. **Discovery**: `search_nodes` `list_nodes`
2. **Configuration**: `get_node_essentials` `get_node_for_task`
3. **Validation**: `validate_node_minimal` `validate_node_operation`
4. **Creation**: `validate_workflow` `n8n_create_workflow`
5. **Updates**: `n8n_update_partial_workflow`
### Performance Tips
- Use `get_node_essentials` instead of `get_node_info` (95% smaller)
- Set high limits on `list_nodes` (200+)
- Use single words in `search_nodes`
- Validate incrementally while building
### Common Node Types
- **Triggers**: webhook, schedule, emailReadImap, slackTrigger
- **Core**: httpRequest, code, set, if, merge, splitInBatches
- **Integrations**: slack, gmail, googleSheets, postgres, mongodb
- **AI**: agent, openAi, chainLlm, documentLoader
### Error Prevention
- Always include node type prefixes: "nodes-base.slack"
- Use node names (not IDs) in connections
- Include typeVersion in all nodes
- Test with validateOnly before applying changes
- Check userMustProvide sections in templates

View File

@@ -0,0 +1,514 @@
# n8n MCP Client Tool Integration - Implementation Plan (Simplified)
## Overview
This document provides a **simplified** implementation plan for making n8n-mcp compatible with n8n's MCP Client Tool (v1.1). Based on expert review, we're taking a minimal approach that extends the existing single-session server rather than creating new architecture.
## Key Design Principles
1. **Minimal Changes**: Extend existing single-session server with n8n compatibility mode
2. **No Overengineering**: No complex session management or multi-session architecture
3. **Docker-Native**: Separate Docker image for n8n deployment
4. **Remote Deployment**: Designed to run alongside n8n in production
5. **Backward Compatible**: Existing functionality remains unchanged
## Prerequisites
- Docker and Docker Compose
- n8n version 1.104.2 or higher (with MCP Client Tool v1.1)
- Basic understanding of Docker networking
## Implementation Approach
Instead of creating new multi-session architecture, we'll extend the existing single-session server with an n8n compatibility mode. This approach was recommended by all three expert reviewers as simpler and more maintainable.
## Architecture Changes
```
src/
├── http-server-single-session.ts # MODIFY: Add n8n mode flag
└── mcp/
└── server.ts # NO CHANGES NEEDED
Docker/
├── Dockerfile.n8n # NEW: n8n-specific image
├── docker-compose.n8n.yml # NEW: Simplified stack
└── .github/workflows/
└── docker-build-n8n.yml # NEW: Build workflow
```
## Implementation Steps
### Step 1: Modify Existing Single-Session Server
#### 1.1 Update `src/http-server-single-session.ts`
Add n8n compatibility mode to the existing server with minimal changes:
```typescript
// Add these constants at the top (after imports)
const PROTOCOL_VERSION = "2024-11-05";
const N8N_MODE = process.env.N8N_MODE === 'true';
// In the constructor or start method, add logging
if (N8N_MODE) {
logger.info('Running in n8n compatibility mode');
}
// In setupRoutes method, add the protocol version endpoint
if (N8N_MODE) {
app.get('/mcp', (req, res) => {
res.json({
protocolVersion: PROTOCOL_VERSION,
serverInfo: {
name: "n8n-mcp",
version: PROJECT_VERSION,
capabilities: {
tools: true,
resources: false,
prompts: false,
},
},
});
});
}
// In handleMCPRequest method, add session header
if (N8N_MODE && this.session) {
res.setHeader('Mcp-Session-Id', this.session.sessionId);
}
// Update error handling to use JSON-RPC format
catch (error) {
logger.error('MCP request error:', error);
if (N8N_MODE) {
res.status(500).json({
jsonrpc: '2.0',
error: {
code: -32603,
message: 'Internal error',
data: error instanceof Error ? error.message : 'Unknown error',
},
id: null,
});
} else {
// Keep existing error handling for backward compatibility
res.status(500).json({
error: 'Internal server error',
details: error instanceof Error ? error.message : 'Unknown error'
});
}
}
```
That's it! No new files, no complex session management. Just a few lines of code.
### Step 2: Update Package Scripts
#### 2.1 Update `package.json`
Add a simple script for n8n mode:
```json
{
"scripts": {
"start:n8n": "N8N_MODE=true MCP_MODE=http node dist/mcp/index.js"
}
}
```
### Step 3: Create Docker Infrastructure for n8n
#### 3.1 Create `Dockerfile.n8n`
```dockerfile
# Dockerfile.n8n - Optimized for n8n integration
FROM node:22-alpine AS builder
WORKDIR /app
# Install build dependencies
RUN apk add --no-cache python3 make g++
# Copy package files
COPY package*.json tsconfig*.json ./
# Install ALL dependencies
RUN npm ci --no-audit --no-fund
# Copy source and build
COPY src ./src
RUN npm run build && npm run rebuild
# Runtime stage
FROM node:22-alpine
WORKDIR /app
# Install runtime dependencies
RUN apk add --no-cache curl dumb-init
# Create non-root user
RUN addgroup -g 1001 -S nodejs && adduser -S nodejs -u 1001
# Copy application from builder
COPY --from=builder --chown=nodejs:nodejs /app/dist ./dist
COPY --from=builder --chown=nodejs:nodejs /app/data ./data
COPY --from=builder --chown=nodejs:nodejs /app/node_modules ./node_modules
COPY --chown=nodejs:nodejs package.json ./
USER nodejs
EXPOSE 3001
HEALTHCHECK CMD curl -f http://localhost:3001/health || exit 1
ENTRYPOINT ["dumb-init", "--"]
CMD ["node", "dist/mcp/index.js"]
```
#### 3.2 Create `docker-compose.n8n.yml`
```yaml
# docker-compose.n8n.yml - Simple stack for n8n + n8n-mcp
version: '3.8'
services:
n8n:
image: n8nio/n8n:latest
container_name: n8n
restart: unless-stopped
ports:
- "5678:5678"
environment:
- N8N_BASIC_AUTH_ACTIVE=${N8N_BASIC_AUTH_ACTIVE:-true}
- N8N_BASIC_AUTH_USER=${N8N_USER:-admin}
- N8N_BASIC_AUTH_PASSWORD=${N8N_PASSWORD:-changeme}
- N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
volumes:
- n8n_data:/home/node/.n8n
networks:
- n8n-net
depends_on:
n8n-mcp:
condition: service_healthy
n8n-mcp:
image: ghcr.io/${GITHUB_USER:-czlonkowski}/n8n-mcp-n8n:latest
build:
context: .
dockerfile: Dockerfile.n8n
container_name: n8n-mcp
restart: unless-stopped
environment:
- MCP_MODE=http
- N8N_MODE=true
- AUTH_TOKEN=${MCP_AUTH_TOKEN}
- NODE_ENV=production
- HTTP_PORT=3001
networks:
- n8n-net
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:3001/health"]
interval: 30s
timeout: 10s
retries: 3
networks:
n8n-net:
driver: bridge
volumes:
n8n_data:
```
#### 3.3 Create `.env.n8n.example`
```bash
# .env.n8n.example - Copy to .env and configure
# n8n Configuration
N8N_USER=admin
N8N_PASSWORD=changeme
N8N_BASIC_AUTH_ACTIVE=true
# MCP Configuration
# Generate with: openssl rand -base64 32
MCP_AUTH_TOKEN=your-secure-token-minimum-32-characters
# GitHub username for image registry
GITHUB_USER=czlonkowski
```
### Step 4: Create GitHub Actions Workflow
#### 4.1 Create `.github/workflows/docker-build-n8n.yml`
```yaml
name: Build n8n Docker Image
on:
push:
branches: [main]
tags: ['v*']
paths:
- 'src/**'
- 'package*.json'
- 'Dockerfile.n8n'
workflow_dispatch:
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}-n8n
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- uses: docker/setup-buildx-action@v3
- uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- uses: docker/metadata-action@v5
id: meta
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch
type=semver,pattern={{version}}
type=raw,value=latest,enable={{is_default_branch}}
- uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile.n8n
push: true
tags: ${{ steps.meta.outputs.tags }}
cache-from: type=gha
cache-to: type=gha,mode=max
```
### Step 5: Testing
#### 5.1 Unit Tests for n8n Mode
Create `tests/unit/http-server-n8n-mode.test.ts`:
```typescript
import { describe, it, expect, vi } from 'vitest';
import request from 'supertest';
describe('n8n Mode', () => {
it('should return protocol version on GET /mcp', async () => {
process.env.N8N_MODE = 'true';
const app = await createTestApp();
const response = await request(app)
.get('/mcp')
.expect(200);
expect(response.body.protocolVersion).toBe('2024-11-05');
expect(response.body.serverInfo.capabilities.tools).toBe(true);
});
it('should include session ID in response headers', async () => {
process.env.N8N_MODE = 'true';
const app = await createTestApp();
const response = await request(app)
.post('/mcp')
.set('Authorization', 'Bearer test-token')
.send({ jsonrpc: '2.0', method: 'initialize', id: 1 });
expect(response.headers['mcp-session-id']).toBeDefined();
});
it('should format errors as JSON-RPC', async () => {
process.env.N8N_MODE = 'true';
const app = await createTestApp();
const response = await request(app)
.post('/mcp')
.send({ invalid: 'request' })
.expect(500);
expect(response.body.jsonrpc).toBe('2.0');
expect(response.body.error.code).toBe(-32603);
});
});
```
#### 5.2 Quick Deployment Script
Create `deploy/quick-deploy-n8n.sh`:
```bash
#!/bin/bash
set -e
echo "🚀 Quick Deploy n8n + n8n-mcp"
# Check prerequisites
command -v docker >/dev/null 2>&1 || { echo "Docker required"; exit 1; }
command -v docker-compose >/dev/null 2>&1 || { echo "Docker Compose required"; exit 1; }
# Generate auth token if not exists
if [ ! -f .env ]; then
cp .env.n8n.example .env
TOKEN=$(openssl rand -base64 32)
sed -i "s/your-secure-token-minimum-32-characters/$TOKEN/" .env
echo "Generated MCP_AUTH_TOKEN: $TOKEN"
fi
# Deploy
docker-compose -f docker-compose.n8n.yml up -d
echo ""
echo "✅ Deployment complete!"
echo ""
echo "📋 Next steps:"
echo "1. Access n8n at http://localhost:5678"
echo " Username: admin (or check .env)"
echo " Password: changeme (or check .env)"
echo ""
echo "2. Create a workflow with MCP Client Tool:"
echo " - Server URL: http://n8n-mcp:3001/mcp"
echo " - Authentication: Bearer Token"
echo " - Token: Check .env file for MCP_AUTH_TOKEN"
echo ""
echo "📊 View logs: docker-compose -f docker-compose.n8n.yml logs -f"
echo "🛑 Stop: docker-compose -f docker-compose.n8n.yml down"
```
## Implementation Checklist (Simplified)
### Code Changes
- [ ] Add N8N_MODE flag to `http-server-single-session.ts`
- [ ] Add protocol version endpoint (GET /mcp) when N8N_MODE=true
- [ ] Add Mcp-Session-Id header to responses
- [ ] Update error responses to JSON-RPC format when N8N_MODE=true
- [ ] Add npm script `start:n8n` to package.json
### Docker Infrastructure
- [ ] Create `Dockerfile.n8n` for n8n-specific image
- [ ] Create `docker-compose.n8n.yml` for simple deployment
- [ ] Create `.env.n8n.example` template
- [ ] Create GitHub Actions workflow `docker-build-n8n.yml`
- [ ] Create `deploy/quick-deploy-n8n.sh` script
### Testing
- [ ] Write unit tests for n8n mode functionality
- [ ] Test with actual n8n MCP Client Tool
- [ ] Verify protocol version endpoint
- [ ] Test authentication flow
- [ ] Validate error formatting
### Documentation
- [ ] Update README with n8n deployment section
- [ ] Document N8N_MODE environment variable
- [ ] Add troubleshooting guide for common issues
## Quick Start Guide
### 1. One-Command Deployment
```bash
# Clone and deploy
git clone https://github.com/czlonkowski/n8n-mcp.git
cd n8n-mcp
./deploy/quick-deploy-n8n.sh
```
### 2. Manual Configuration in n8n
After deployment, configure the MCP Client Tool in n8n:
1. Open n8n at `http://localhost:5678`
2. Create a new workflow
3. Add "MCP Client Tool" node (under AI category)
4. Configure:
- **Server URL**: `http://n8n-mcp:3001/mcp`
- **Authentication**: Bearer Token
- **Token**: Check your `.env` file for MCP_AUTH_TOKEN
5. Select a tool (e.g., `list_nodes`)
6. Execute the workflow
### 3. Production Deployment
For production with SSL, use a reverse proxy:
```nginx
# nginx configuration
server {
listen 443 ssl;
server_name n8n.yourdomain.com;
location / {
proxy_pass http://localhost:5678;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
}
```
The MCP server should remain internal only - n8n connects via Docker network.
## Success Criteria
The implementation is successful when:
1. **Minimal Code Changes**: Only ~20 lines added to existing server
2. **Protocol Compliance**: GET /mcp returns correct protocol version
3. **n8n Connection**: MCP Client Tool connects successfully
4. **Tool Execution**: Tools work without modification
5. **Backward Compatible**: Existing Claude Desktop usage unaffected
## Troubleshooting
### Common Issues
1. **"Protocol version mismatch"**
- Ensure N8N_MODE=true is set
- Check GET /mcp returns "2024-11-05"
2. **"Authentication failed"**
- Verify AUTH_TOKEN matches in .env and n8n
- Token must be 32+ characters
- Use "Bearer Token" auth type in n8n
3. **"Connection refused"**
- Check containers are on same network
- Use internal hostname: `http://n8n-mcp:3001/mcp`
- Verify health check passes
4. **Testing the Setup**
```bash
# Check protocol version
docker exec n8n-mcp curl http://localhost:3001/mcp
# View logs
docker-compose -f docker-compose.n8n.yml logs -f n8n-mcp
```
## Summary
This simplified approach:
- **Extends existing code** rather than creating new architecture
- **Adds n8n compatibility** with minimal changes
- **Uses separate Docker image** for clean deployment
- **Maintains backward compatibility** for existing users
- **Avoids overengineering** with simple, practical solutions
Total implementation effort: ~2-3 hours (vs. 2-3 days for multi-session approach)

146
docs/test-artifacts.md Normal file
View File

@@ -0,0 +1,146 @@
# Test Artifacts Documentation
This document describes the comprehensive test result artifact storage system implemented in the n8n-mcp project.
## Overview
The test artifact system captures, stores, and presents test results in multiple formats to facilitate debugging, analysis, and historical tracking of test performance.
## Artifact Types
### 1. Test Results
- **JUnit XML** (`test-results/junit.xml`): Standard format for CI integration
- **JSON Results** (`test-results/results.json`): Detailed test data for analysis
- **HTML Report** (`test-results/html/index.html`): Interactive test report
- **Test Summary** (`test-summary.md`): Markdown summary for PR comments
### 2. Coverage Reports
- **LCOV** (`coverage/lcov.info`): Standard coverage format
- **HTML Coverage** (`coverage/html/index.html`): Interactive coverage browser
- **Coverage Summary** (`coverage/coverage-summary.json`): JSON coverage data
### 3. Benchmark Results
- **Benchmark JSON** (`benchmark-results.json`): Raw benchmark data
- **Comparison Reports** (`benchmark-comparison.md`): PR benchmark comparisons
### 4. Detailed Reports
- **HTML Report** (`test-reports/report.html`): Comprehensive styled report
- **Markdown Report** (`test-reports/report.md`): Full markdown report
- **JSON Report** (`test-reports/report.json`): Complete test data
## GitHub Actions Integration
### Test Workflow (`test.yml`)
The main test workflow:
1. Runs tests with coverage using multiple reporters
2. Generates test summaries and detailed reports
3. Uploads artifacts with metadata
4. Posts summaries to PRs
5. Creates a combined artifact index
### Benchmark PR Workflow (`benchmark-pr.yml`)
For pull requests:
1. Runs benchmarks on PR branch
2. Runs benchmarks on base branch
3. Compares results
4. Posts comparison to PR
5. Sets status checks for regressions
## Artifact Retention
- **Test Results**: 30 days
- **Coverage Reports**: 30 days
- **Benchmark Results**: 30 days
- **Combined Results**: 90 days
- **Test Metadata**: 30 days
## PR Comment Integration
The system automatically:
- Posts test summaries to PR comments
- Updates existing comments instead of creating duplicates
- Includes links to full artifacts
- Shows coverage and benchmark changes
## Job Summary
Each workflow run includes a job summary with:
- Test results overview
- Coverage summary
- Benchmark results
- Direct links to download artifacts
## Local Development
### Running Tests with Reports
```bash
# Run tests with all reporters
CI=true npm run test:coverage
# Generate detailed reports
node scripts/generate-detailed-reports.js
# Generate test summary
node scripts/generate-test-summary.js
# Compare benchmarks
node scripts/compare-benchmarks.js benchmark-results.json benchmark-baseline.json
```
### Report Locations
When running locally, reports are generated in:
- `test-results/` - Vitest outputs
- `test-reports/` - Detailed reports
- `coverage/` - Coverage reports
- Root directory - Summary files
## Report Formats
### HTML Report Features
- Responsive design
- Test suite breakdown
- Failed test details with error messages
- Coverage visualization with progress bars
- Benchmark performance metrics
- Sortable tables
### Markdown Report Features
- GitHub-compatible formatting
- Summary statistics
- Failed test listings
- Coverage breakdown
- Benchmark comparisons
### JSON Report Features
- Complete test data
- Programmatic access
- Historical comparison
- CI/CD integration
## Best Practices
1. **Always Check Artifacts**: When tests fail in CI, download and review the HTML report
2. **Monitor Coverage**: Use the coverage reports to identify untested code
3. **Track Benchmarks**: Review benchmark comparisons on performance-critical PRs
4. **Archive Important Runs**: Download artifacts from significant releases
## Troubleshooting
### Missing Artifacts
- Check if tests ran to completion
- Verify artifact upload steps executed
- Check retention period hasn't expired
### Report Generation Failures
- Ensure all dependencies are installed
- Check for valid test/coverage output files
- Review workflow logs for errors
### PR Comment Issues
- Verify GitHub Actions permissions
- Check bot authentication
- Review comment posting logs

View File

@@ -0,0 +1,935 @@
# n8n-MCP Testing Architecture
## Overview
This document describes the comprehensive testing infrastructure implemented for the n8n-MCP project. The testing suite includes 3,336 tests split between unit and integration tests, benchmarks, and a complete CI/CD pipeline ensuring code quality and reliability.
### Test Suite Statistics (October 2025)
- **Total Tests**: 3,336 tests
- **Unit Tests**: 2,766 tests - Isolated component testing with mocks
- **Integration Tests**: 570 tests - Full system behavior validation
- n8n API Integration: 172 tests (all 18 MCP handler tools)
- MCP Protocol: 119 tests (protocol compliance, session management)
- Database: 226 tests (repository operations, transactions, FTS5)
- Templates: 35 tests (fetching, storage, metadata)
- Docker: 18 tests (configuration, security)
- **Test Files**:
- 106 unit test files
- 41 integration test files
- Total: 147 test files
- **Test Execution Time**:
- Unit tests: ~2 minutes with coverage
- Integration tests: ~30 seconds
- Total CI time: ~3 minutes
- **Success Rate**: 100% (all tests passing in CI)
- **CI/CD Pipeline**: Fully automated with GitHub Actions
- **Test Artifacts**: JUnit XML, coverage reports, benchmark results
- **Parallel Execution**: Configurable with thread pool
## Testing Framework: Vitest
We use **Vitest** as our primary testing framework, chosen for its:
- **Speed**: Native ESM support and fast execution
- **TypeScript Integration**: First-class TypeScript support
- **Watch Mode**: Instant feedback during development
- **Jest Compatibility**: Easy migration from Jest
- **Built-in Mocking**: Powerful mocking capabilities
- **Coverage**: Integrated code coverage with v8
### Configuration
```typescript
// vitest.config.ts
export default defineConfig({
test: {
globals: true,
environment: 'node',
setupFiles: ['./tests/setup/global-setup.ts'],
pool: 'threads',
poolOptions: {
threads: {
singleThread: process.env.TEST_PARALLEL !== 'true',
maxThreads: parseInt(process.env.TEST_MAX_WORKERS || '4', 10)
}
},
coverage: {
provider: 'v8',
reporter: ['lcov', 'html', 'text-summary'],
exclude: ['node_modules/', 'tests/', '**/*.test.ts', 'scripts/']
}
},
resolve: {
alias: {
'@': path.resolve(__dirname, './src'),
'@tests': path.resolve(__dirname, './tests')
}
}
});
```
## Directory Structure
```
tests/
├── unit/ # Unit tests with mocks (2,766 tests, 106 files)
│ ├── __mocks__/ # Mock implementations
│ │ └── n8n-nodes-base.test.ts
│ ├── database/ # Database layer tests
│ │ ├── database-adapter-unit.test.ts
│ │ ├── node-repository-core.test.ts
│ │ └── template-repository-core.test.ts
│ ├── docker/ # Docker configuration tests
│ │ ├── config-security.test.ts
│ │ ├── edge-cases.test.ts
│ │ ├── parse-config.test.ts
│ │ └── serve-command.test.ts
│ ├── http-server/ # HTTP server tests
│ │ └── multi-tenant-support.test.ts
│ ├── loaders/ # Node loader tests
│ │ └── node-loader.test.ts
│ ├── mappers/ # Data mapper tests
│ │ └── docs-mapper.test.ts
│ ├── mcp/ # MCP server and tools tests
│ │ ├── handlers-n8n-manager.test.ts
│ │ ├── handlers-workflow-diff.test.ts
│ │ ├── tools-documentation.test.ts
│ │ └── tools.test.ts
│ ├── parsers/ # Parser tests
│ │ ├── node-parser.test.ts
│ │ ├── property-extractor.test.ts
│ │ └── simple-parser.test.ts
│ ├── scripts/ # Script tests
│ │ └── fetch-templates-extraction.test.ts
│ ├── services/ # Service layer tests (largest test suite)
│ │ ├── config-validator.test.ts
│ │ ├── enhanced-config-validator.test.ts
│ │ ├── example-generator.test.ts
│ │ ├── expression-validator.test.ts
│ │ ├── n8n-api-client.test.ts
│ │ ├── n8n-validation.test.ts
│ │ ├── node-specific-validators.test.ts
│ │ ├── property-dependencies.test.ts
│ │ ├── property-filter.test.ts
│ │ ├── task-templates.test.ts
│ │ ├── workflow-diff-engine.test.ts
│ │ ├── workflow-validator-comprehensive.test.ts
│ │ └── workflow-validator.test.ts
│ ├── telemetry/ # Telemetry tests
│ │ └── telemetry-manager.test.ts
│ └── utils/ # Utility function tests
│ ├── cache-utils.test.ts
│ └── database-utils.test.ts
├── integration/ # Integration tests (570 tests, 41 files)
│ ├── n8n-api/ # n8n API integration tests (172 tests, 18 files)
│ │ ├── executions/ # Execution management tests
│ │ │ ├── get-execution.test.ts
│ │ │ └── list-executions.test.ts
│ │ ├── system/ # System tool tests
│ │ │ ├── diagnostic.test.ts
│ │ │ ├── health-check.test.ts
│ │ │ └── list-tools.test.ts
│ │ ├── utils/ # Test utilities
│ │ │ ├── mcp-context.ts
│ │ │ └── response-types.ts
│ │ └── workflows/ # Workflow management tests
│ │ ├── autofix-workflow.test.ts
│ │ ├── create-workflow.test.ts
│ │ ├── delete-workflow.test.ts
│ │ ├── get-workflow-details.test.ts
│ │ ├── get-workflow-minimal.test.ts
│ │ ├── get-workflow-structure.test.ts
│ │ ├── get-workflow.test.ts
│ │ ├── list-workflows.test.ts
│ │ ├── update-full-workflow.test.ts
│ │ ├── update-partial-workflow.test.ts
│ │ └── validate-workflow.test.ts
│ ├── database/ # Database integration tests (226 tests)
│ │ ├── connection-management.test.ts
│ │ ├── fts5-search.test.ts
│ │ ├── node-repository.test.ts
│ │ ├── performance.test.ts
│ │ ├── template-node-configs.test.ts
│ │ ├── template-repository.test.ts
│ │ └── transactions.test.ts
│ ├── docker/ # Docker integration tests (18 tests)
│ │ ├── docker-config.test.ts
│ │ └── docker-entrypoint.test.ts
│ ├── mcp-protocol/ # MCP protocol tests (119 tests)
│ │ ├── basic-connection.test.ts
│ │ ├── error-handling.test.ts
│ │ ├── performance.test.ts
│ │ ├── protocol-compliance.test.ts
│ │ ├── session-management.test.ts
│ │ ├── tool-invocation.test.ts
│ │ └── workflow-error-validation.test.ts
│ ├── templates/ # Template tests (35 tests)
│ │ └── metadata-operations.test.ts
│ └── setup/ # Integration test setup
│ ├── integration-setup.ts
│ └── msw-test-server.ts
├── benchmarks/ # Performance benchmarks
│ ├── database-queries.bench.ts
│ └── sample.bench.ts
├── setup/ # Global test configuration
│ ├── global-setup.ts # Global test setup
│ ├── msw-setup.ts # Mock Service Worker setup
│ └── test-env.ts # Test environment configuration
├── utils/ # Test utilities
│ ├── assertions.ts # Custom assertions
│ ├── builders/ # Test data builders
│ │ └── workflow.builder.ts
│ ├── data-generators.ts # Test data generators
│ ├── database-utils.ts # Database test utilities
│ └── test-helpers.ts # General test helpers
├── mocks/ # Mock implementations
│ └── n8n-api/ # n8n API mocks
│ ├── handlers.ts # MSW request handlers
│ └── data/ # Mock data
└── fixtures/ # Test fixtures
├── database/ # Database fixtures
├── factories/ # Data factories
└── workflows/ # Workflow fixtures
```
## Mock Strategy
### 1. Mock Service Worker (MSW) for API Mocking
We use MSW for intercepting and mocking HTTP requests:
```typescript
// tests/mocks/n8n-api/handlers.ts
import { http, HttpResponse } from 'msw';
export const handlers = [
// Workflow endpoints
http.get('*/workflows/:id', ({ params }) => {
const workflow = mockWorkflows.find(w => w.id === params.id);
if (!workflow) {
return new HttpResponse(null, { status: 404 });
}
return HttpResponse.json(workflow);
}),
// Execution endpoints
http.post('*/workflows/:id/run', async ({ params, request }) => {
const body = await request.json();
return HttpResponse.json({
executionId: generateExecutionId(),
status: 'running'
});
})
];
```
### 2. Database Mocking
For unit tests, we mock the database layer:
```typescript
// tests/unit/__mocks__/better-sqlite3.ts
import { vi } from 'vitest';
export default vi.fn(() => ({
prepare: vi.fn(() => ({
all: vi.fn().mockReturnValue([]),
get: vi.fn().mockReturnValue(undefined),
run: vi.fn().mockReturnValue({ changes: 1 }),
finalize: vi.fn()
})),
exec: vi.fn(),
close: vi.fn(),
pragma: vi.fn()
}));
```
### 3. MCP SDK Mocking
For testing MCP protocol interactions:
```typescript
// tests/integration/mcp-protocol/test-helpers.ts
export class TestableN8NMCPServer extends N8NMCPServer {
private transports = new Set<Transport>();
async connectToTransport(transport: Transport): Promise<void> {
this.transports.add(transport);
await this.connect(transport);
}
async close(): Promise<void> {
for (const transport of this.transports) {
await transport.close();
}
this.transports.clear();
}
}
```
## Test Patterns and Utilities
### 1. Database Test Utilities
```typescript
// tests/utils/database-utils.ts
export class TestDatabase {
constructor(options: TestDatabaseOptions = {}) {
this.options = {
mode: 'memory',
enableFTS5: true,
...options
};
}
async initialize(): Promise<Database.Database> {
const db = this.options.mode === 'memory'
? new Database(':memory:')
: new Database(this.dbPath);
if (this.options.enableFTS5) {
await this.enableFTS5(db);
}
return db;
}
}
```
### 2. Data Generators
```typescript
// tests/utils/data-generators.ts
export class TestDataGenerator {
static generateNode(overrides: Partial<ParsedNode> = {}): ParsedNode {
return {
nodeType: `test.node${faker.number.int()}`,
displayName: faker.commerce.productName(),
description: faker.lorem.sentence(),
properties: this.generateProperties(5),
...overrides
};
}
static generateWorkflow(nodeCount = 3): any {
const nodes = Array.from({ length: nodeCount }, (_, i) => ({
id: `node_${i}`,
type: 'test.node',
position: [i * 100, 0],
parameters: {}
}));
return { nodes, connections: {} };
}
}
```
### 3. Custom Assertions
```typescript
// tests/utils/assertions.ts
export function expectValidMCPResponse(response: any): void {
expect(response).toBeDefined();
expect(response.content).toBeDefined();
expect(Array.isArray(response.content)).toBe(true);
expect(response.content[0]).toHaveProperty('type', 'text');
expect(response.content[0]).toHaveProperty('text');
}
export function expectNodeStructure(node: any): void {
expect(node).toHaveProperty('nodeType');
expect(node).toHaveProperty('displayName');
expect(node).toHaveProperty('properties');
expect(Array.isArray(node.properties)).toBe(true);
}
```
## Unit Testing
Our unit tests focus on testing individual components in isolation with mocked dependencies:
### Service Layer Tests
The bulk of our unit tests (400+ tests) are in the services layer:
```typescript
// tests/unit/services/workflow-validator-comprehensive.test.ts
describe('WorkflowValidator Comprehensive Tests', () => {
it('should validate complex workflow with AI nodes', () => {
const workflow = {
nodes: [
{
id: 'ai_agent',
type: '@n8n/n8n-nodes-langchain.agent',
parameters: { prompt: 'Analyze data' }
}
],
connections: {}
};
const result = validator.validateWorkflow(workflow);
expect(result.valid).toBe(true);
});
});
```
### Parser Tests
Testing the node parsing logic:
```typescript
// tests/unit/parsers/property-extractor.test.ts
describe('PropertyExtractor', () => {
it('should extract nested properties correctly', () => {
const node = {
properties: [
{
displayName: 'Options',
name: 'options',
type: 'collection',
options: [
{ name: 'timeout', type: 'number' }
]
}
]
};
const extracted = extractor.extractProperties(node);
expect(extracted).toHaveProperty('options.timeout');
});
});
```
### Mock Testing
Testing our mock implementations:
```typescript
// tests/unit/__mocks__/n8n-nodes-base.test.ts
describe('n8n-nodes-base mock', () => {
it('should provide mocked node definitions', () => {
const httpNode = mockNodes['n8n-nodes-base.httpRequest'];
expect(httpNode).toBeDefined();
expect(httpNode.description.displayName).toBe('HTTP Request');
});
});
```
## Integration Testing
Our integration tests verify the complete system behavior across 570 tests in four major categories:
### n8n API Integration Testing (172 tests)
The n8n API integration tests verify all 18 MCP handler tools against a real n8n instance. These tests ensure our product layer (MCP handlers) work correctly end-to-end, not just the raw API client.
**Test Organization:**
- **Workflows** (11 handlers): Create, read, update (full/partial), delete, list, validate, autofix
- **Executions** (2 handlers): Get execution details, list executions
- **System** (3 handlers): Health check, list available tools, diagnostics
**Example:**
```typescript
// tests/integration/n8n-api/workflows/create-workflow.test.ts
describe('Integration: handleCreateWorkflow', () => {
it('should create a simple two-node workflow', async () => {
const response = await handleCreateWorkflow(
{
params: {
arguments: {
name: 'Test Workflow',
nodes: [webhook, setNode],
connections: { Webhook: { main: [[{ node: 'Set', type: 'main', index: 0 }]] } }
}
}
},
mcpContext
);
expect(response.success).toBe(true);
const workflow = response.data as WorkflowData;
expect(workflow.id).toBeDefined();
expect(workflow.nodes).toHaveLength(2);
// Cleanup
await handleDeleteWorkflow({ params: { arguments: { id: workflow.id } } }, mcpContext);
});
});
```
**Key Features Tested:**
- Real workflow creation, modification, deletion with cleanup
- TypeScript type safety with response interfaces
- Complete coverage of all 18 n8n API tools
- Proper error handling and edge cases
- Response format validation
### MCP Protocol Testing (119 tests)
```typescript
// tests/integration/mcp-protocol/tool-invocation.test.ts
describe('MCP Tool Invocation', () => {
let mcpServer: TestableN8NMCPServer;
let client: Client;
beforeEach(async () => {
mcpServer = new TestableN8NMCPServer();
await mcpServer.initialize();
const [serverTransport, clientTransport] = InMemoryTransport.createLinkedPair();
await mcpServer.connectToTransport(serverTransport);
client = new Client({ name: 'test-client', version: '1.0.0' }, {});
await client.connect(clientTransport);
});
it('should list nodes with filtering', async () => {
const response = await client.callTool({
name: 'list_nodes',
arguments: { category: 'trigger', limit: 10 }
});
expectValidMCPResponse(response);
const result = JSON.parse(response.content[0].text);
expect(result.nodes).toHaveLength(10);
expect(result.nodes.every(n => n.category === 'trigger')).toBe(true);
});
});
```
### Database Integration Testing (226 tests)
```typescript
// tests/integration/database/fts5-search.test.ts
describe('FTS5 Search Integration', () => {
it('should perform fuzzy search', async () => {
const results = await nodeRepo.searchNodes('HTT', 'FUZZY');
expect(results.some(n => n.nodeType.includes('httpRequest'))).toBe(true);
expect(results.some(n => n.displayName.includes('HTTP'))).toBe(true);
});
it('should handle complex boolean queries', async () => {
const results = await nodeRepo.searchNodes('webhook OR http', 'OR');
expect(results.length).toBeGreaterThan(0);
expect(results.some(n =>
n.description?.includes('webhook') ||
n.description?.includes('http')
)).toBe(true);
});
});
```
### Template Integration Testing (35 tests)
Tests template fetching, storage, and metadata operations against the n8n.io API and local database.
### Docker Integration Testing (18 tests)
Tests Docker configuration parsing, entrypoint script, and security validation.
## Test Distribution and Coverage
### Test Distribution by Component
Based on our 3,336 tests:
**Integration Tests (570 tests):**
1. **n8n API Integration** (172 tests)
- Workflow management handlers: 11 tools with comprehensive scenarios
- Execution management handlers: 2 tools
- System tool handlers: 3 tools
- TypeScript type safety with response interfaces
2. **Database Integration** (226 tests)
- Repository operations and transactions
- FTS5 full-text search with fuzzy matching
- Performance and concurrent access tests
- Template node configurations
3. **MCP Protocol** (119 tests)
- Protocol compliance and session management
- Tool invocation and error handling
- Performance and stress testing
- Workflow error validation
4. **Templates & Docker** (53 tests)
- Template fetching and metadata operations
- Docker configuration and security validation
**Unit Tests (2,766 tests):**
1. **Services Layer** (largest suite)
- `workflow-validator-comprehensive.test.ts`: 150+ tests
- `enhanced-config-validator.test.ts`: 120+ tests
- `node-specific-validators.test.ts`: 100+ tests
- `n8n-api-client.test.ts`: 80+ tests
- Config validation, property filtering, workflow diff engine
2. **Parsers** (~200 tests)
- Node parsing with version support
- Property extraction and documentation mapping
- Simple parser for basic node information
3. **Database Layer** (~150 tests)
- Repository core functionality with mocks
- Database adapter unit tests
- Template repository operations
4. **MCP Tools & HTTP Server** (~300 tests)
- Tool definitions and documentation system
- Multi-tenant support and security
- Configuration validation
5. **Utils, Docker, Scripts, Telemetry** (remaining tests)
- Cache utilities, database helpers
- Docker config security and parsing
- Template extraction scripts
- Telemetry tracking
### Test Execution Performance
From our CI runs:
- **Fastest tests**: Unit tests with mocks (<1ms each)
- **Slowest tests**: Integration tests with real database and n8n API (100-5000ms)
- **Average test time**: ~20ms per test
- **Total suite execution**: ~3 minutes in CI (with coverage)
- **Parallel execution**: Configurable thread pool for optimal performance
## CI/CD Pipeline
Our GitHub Actions workflow runs all tests automatically:
```yaml
# .github/workflows/test.yml
name: Test Suite
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Run unit tests with coverage
run: npm run test:unit -- --coverage
- name: Run integration tests
run: npm run test:integration
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
```
### Test Execution Scripts
```json
// package.json
{
"scripts": {
"test": "vitest",
"test:unit": "vitest run tests/unit",
"test:integration": "vitest run tests/integration --config vitest.config.integration.ts",
"test:coverage": "vitest run --coverage",
"test:watch": "vitest watch",
"test:bench": "vitest bench --config vitest.config.benchmark.ts",
"benchmark:ci": "CI=true node scripts/run-benchmarks-ci.js"
}
}
```
### CI Test Results Summary
From our latest CI run (#41):
```
UNIT TESTS:
Test Files 30 passed (30)
Tests 932 passed | 1 skipped (933)
INTEGRATION TESTS:
Test Files 14 passed (14)
Tests 245 passed | 4 skipped (249)
TOTAL: 1,177 passed | 5 skipped | 0 failed
```
## Performance Testing
We use Vitest's built-in benchmark functionality:
```typescript
// tests/benchmarks/database-queries.bench.ts
import { bench, describe } from 'vitest';
describe('Database Query Performance', () => {
bench('search nodes by category', async () => {
await nodeRepo.getNodesByCategory('trigger');
});
bench('FTS5 search performance', async () => {
await nodeRepo.searchNodes('webhook http request', 'AND');
});
});
```
## Environment Configuration
Test environment is configured via `.env.test`:
```bash
# Test Environment Configuration
NODE_ENV=test
TEST_DB_PATH=:memory:
TEST_PARALLEL=false
TEST_MAX_WORKERS=4
FEATURE_TEST_COVERAGE=true
MSW_ENABLED=true
```
## Key Patterns and Lessons Learned
### 1. Response Structure Consistency
All MCP responses follow a specific structure that must be handled correctly:
```typescript
// Common pattern for handling MCP responses
const response = await client.callTool({ name: 'list_nodes', arguments: {} });
// MCP responses have content array with text objects
expect(response.content).toBeDefined();
expect(response.content[0].type).toBe('text');
// Parse the actual data
const data = JSON.parse(response.content[0].text);
```
### 2. MSW Integration Setup
Proper MSW setup is crucial for integration tests:
```typescript
// tests/integration/setup/integration-setup.ts
import { setupServer } from 'msw/node';
import { handlers } from '@tests/mocks/n8n-api/handlers';
// Create server but don't start it globally
const server = setupServer(...handlers);
beforeAll(async () => {
// Only start MSW for integration tests
if (process.env.MSW_ENABLED === 'true') {
server.listen({ onUnhandledRequest: 'bypass' });
}
});
afterAll(async () => {
server.close();
});
```
### 3. Database Isolation for Parallel Tests
Each test gets its own database to enable parallel execution:
```typescript
// tests/utils/database-utils.ts
export function createTestDatabaseAdapter(
db?: Database.Database,
options: TestDatabaseOptions = {}
): DatabaseAdapter {
const database = db || new Database(':memory:');
// Enable FTS5 if needed
if (options.enableFTS5) {
database.exec('PRAGMA main.compile_options;');
}
return new DatabaseAdapter(database);
}
```
### 4. Environment-Aware Performance Thresholds
CI environments are slower, so we adjust expectations:
```typescript
// Environment-aware thresholds
const getThreshold = (local: number, ci: number) =>
process.env.CI ? ci : local;
it('should respond quickly', async () => {
const start = performance.now();
await someOperation();
const duration = performance.now() - start;
expect(duration).toBeLessThan(getThreshold(50, 200));
});
```
## Best Practices
### 1. Test Isolation
- Each test creates its own database instance
- Tests clean up after themselves
- No shared state between tests
### 2. Proper Cleanup Order
```typescript
afterEach(async () => {
// Close client first to ensure no pending requests
await client.close();
// Give time for client to fully close
await new Promise(resolve => setTimeout(resolve, 50));
// Then close server
await mcpServer.close();
// Finally cleanup database
await testDb.cleanup();
});
```
### 3. Handle Async Operations Carefully
```typescript
// Avoid race conditions in cleanup
it('should handle disconnection', async () => {
// ... test code ...
// Ensure operations complete before cleanup
await transport.close();
await new Promise(resolve => setTimeout(resolve, 100));
});
```
### 4. Meaningful Test Organization
- Group related tests using `describe` blocks
- Use descriptive test names that explain the behavior
- Follow AAA pattern: Arrange, Act, Assert
- Keep tests focused on single behaviors
## Debugging Tests
### Running Specific Tests
```bash
# Run a single test file
npm test tests/integration/mcp-protocol/tool-invocation.test.ts
# Run tests matching a pattern
npm test -- --grep "should list nodes"
# Run with debugging output
DEBUG=* npm test
```
### VSCode Integration
```json
// .vscode/launch.json
{
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Debug Tests",
"program": "${workspaceFolder}/node_modules/vitest/vitest.mjs",
"args": ["run", "${file}"],
"console": "integratedTerminal"
}
]
}
```
## Test Coverage
While we don't enforce strict coverage thresholds yet, the infrastructure is in place:
- Coverage reports generated in `lcov`, `html`, and `text` formats
- Integration with Codecov for tracking coverage over time
- Per-file coverage visible in VSCode with extensions
## Future Improvements
1. **E2E Testing**: Add Playwright for testing the full MCP server interaction
2. **Load Testing**: Implement k6 or Artillery for stress testing
3. **Contract Testing**: Add Pact for ensuring API compatibility
4. **Visual Regression**: For any UI components that may be added
5. **Mutation Testing**: Use Stryker to ensure test quality
## Common Issues and Solutions
### 1. Tests Hanging in CI
**Problem**: Tests would hang indefinitely in CI due to `process.exit()` calls.
**Solution**: Remove all `process.exit()` calls from test code and use proper cleanup:
```typescript
// Bad
afterAll(() => {
process.exit(0); // This causes Vitest to hang
});
// Good
afterAll(async () => {
await cleanup();
// Let Vitest handle process termination
});
```
### 2. MCP Response Structure
**Problem**: Tests expecting wrong response format from MCP tools.
**Solution**: Always access responses through `content[0].text`:
```typescript
// Wrong
const data = response[0].text;
// Correct
const data = JSON.parse(response.content[0].text);
```
### 3. Database Not Found Errors
**Problem**: Tests failing with "node not found" when database is empty.
**Solution**: Check for empty databases before assertions:
```typescript
const stats = await server.executeTool('get_database_statistics', {});
if (stats.totalNodes > 0) {
expect(result.nodes.length).toBeGreaterThan(0);
} else {
expect(result.nodes).toHaveLength(0);
}
```
### 4. MSW Loading Globally
**Problem**: MSW interfering with unit tests when loaded globally.
**Solution**: Only load MSW in integration test setup:
```typescript
// vitest.config.integration.ts
setupFiles: [
'./tests/setup/global-setup.ts',
'./tests/integration/setup/integration-setup.ts' // MSW only here
]
```
## Resources
- [Vitest Documentation](https://vitest.dev/)
- [MSW Documentation](https://mswjs.io/)
- [Testing Best Practices](https://github.com/goldbergyoni/javascript-testing-best-practices)
- [MCP SDK Documentation](https://modelcontextprotocol.io/)

276
docs/testing-checklist.md Normal file
View File

@@ -0,0 +1,276 @@
# n8n-MCP Testing Implementation Checklist
## Test Suite Development Status
### Context
- **Situation**: Building comprehensive test suite from scratch
- **Branch**: feat/comprehensive-testing-suite (separate from main)
- **Main Branch Status**: Working in production without tests
- **Goal**: Add test coverage without disrupting development
## Immediate Actions (Day 1)
- [x] ~~Fix failing tests (Phase 0)~~ ✅ COMPLETED
- [x] ~~Create GitHub Actions workflow file~~ ✅ COMPLETED
- [x] ~~Install Vitest and remove Jest~~ ✅ COMPLETED
- [x] ~~Create vitest.config.ts~~ ✅ COMPLETED
- [x] ~~Setup global test configuration~~ ✅ COMPLETED
- [x] ~~Migrate existing tests to Vitest syntax~~ ✅ COMPLETED
- [x] ~~Setup coverage reporting with Codecov~~ ✅ COMPLETED
## Phase 1: Vitest Migration ✅ COMPLETED
All tests have been successfully migrated from Jest to Vitest:
- ✅ Removed Jest and installed Vitest
- ✅ Created vitest.config.ts with path aliases
- ✅ Set up global test configuration
- ✅ Migrated all 6 test files (68 tests passing)
- ✅ Updated TypeScript configuration
- ✅ Cleaned up Jest configuration files
## Week 1: Foundation
### Testing Infrastructure ✅ COMPLETED (Phase 2)
- [x] ~~Create test directory structure~~ ✅ COMPLETED
- [x] ~~Setup mock infrastructure for better-sqlite3~~ ✅ COMPLETED
- [x] ~~Create mock for n8n-nodes-base package~~ ✅ COMPLETED
- [x] ~~Setup test database utilities~~ ✅ COMPLETED
- [x] ~~Create factory pattern for nodes~~ ✅ COMPLETED
- [x] ~~Create builder pattern for workflows~~ ✅ COMPLETED
- [x] ~~Setup global test utilities~~ ✅ COMPLETED
- [x] ~~Configure test environment variables~~ ✅ COMPLETED
### CI/CD Pipeline ✅ COMPLETED (Phase 3.8)
- [x] ~~GitHub Actions for test execution~~ ✅ COMPLETED & VERIFIED
- Successfully running with Vitest
- 1021 tests passing in CI
- Build time: ~2 minutes
- [x] ~~Coverage reporting integration~~ ✅ COMPLETED (Codecov setup)
- [x] ~~Performance benchmark tracking~~ ✅ COMPLETED
- [x] ~~Test result artifacts~~ ✅ COMPLETED
- [ ] Branch protection rules
- [ ] Required status checks
## Week 2: Mock Infrastructure
### Database Mocking
- [ ] Complete better-sqlite3 mock implementation
- [ ] Mock prepared statements
- [ ] Mock transactions
- [ ] Mock FTS5 search functionality
- [ ] Test data seeding utilities
### External Dependencies
- [ ] Mock axios for API calls
- [ ] Mock file system operations
- [ ] Mock MCP SDK
- [ ] Mock Express server
- [ ] Mock WebSocket connections
## Week 3-4: Unit Tests ✅ COMPLETED (Phase 3)
### Core Services (Priority 1) ✅ COMPLETED
- [x] ~~`config-validator.ts` - 95% coverage~~ ✅ 96.9%
- [x] ~~`enhanced-config-validator.ts` - 95% coverage~~ ✅ 94.55%
- [x] ~~`workflow-validator.ts` - 90% coverage~~ ✅ 97.59%
- [x] ~~`expression-validator.ts` - 90% coverage~~ ✅ 97.22%
- [x] ~~`property-filter.ts` - 90% coverage~~ ✅ 95.25%
- [x] ~~`example-generator.ts` - 85% coverage~~ ✅ 94.34%
### Parsers (Priority 2) ✅ COMPLETED
- [x] ~~`node-parser.ts` - 90% coverage~~ ✅ 97.42%
- [x] ~~`property-extractor.ts` - 90% coverage~~ ✅ 95.49%
### MCP Layer (Priority 3) ✅ COMPLETED
- [x] ~~`tools.ts` - 90% coverage~~ ✅ 94.11%
- [x] ~~`handlers-n8n-manager.ts` - 85% coverage~~ ✅ 92.71%
- [x] ~~`handlers-workflow-diff.ts` - 85% coverage~~ ✅ 96.34%
- [x] ~~`tools-documentation.ts` - 80% coverage~~ ✅ 94.12%
### Database Layer (Priority 4) ✅ COMPLETED
- [x] ~~`node-repository.ts` - 85% coverage~~ ✅ 91.48%
- [x] ~~`database-adapter.ts` - 85% coverage~~ ✅ 89.29%
- [x] ~~`template-repository.ts` - 80% coverage~~ ✅ 86.78%
### Loaders and Mappers (Priority 5) ✅ COMPLETED
- [x] ~~`node-loader.ts` - 85% coverage~~ ✅ 91.89%
- [x] ~~`docs-mapper.ts` - 80% coverage~~ ✅ 95.45%
### Additional Critical Services Tested ✅ COMPLETED (Phase 3.5)
- [x] ~~`n8n-api-client.ts`~~ ✅ 83.87%
- [x] ~~`workflow-diff-engine.ts`~~ ✅ 90.06%
- [x] ~~`n8n-validation.ts`~~ ✅ 97.14%
- [x] ~~`node-specific-validators.ts`~~ ✅ 98.7%
## Week 5-6: Integration Tests 🚧 IN PROGRESS
### Real Status (July 29, 2025)
**Context**: Building test suite from scratch on testing branch. Main branch has no tests.
**Overall Status**: 187/246 tests passing (76% pass rate)
**Critical Issue**: CI shows green despite 58 failing tests due to `|| true` in workflow
### MCP Protocol Tests 🔄 MIXED STATUS
- [x] ~~Full MCP server initialization~~ ✅ COMPLETED
- [x] ~~Tool invocation flow~~ ✅ FIXED (30 tests in tool-invocation.test.ts)
- [ ] Error handling and recovery ⚠️ 16 FAILING (error-handling.test.ts)
- [x] ~~Concurrent request handling~~ ✅ COMPLETED
- [ ] Session management ⚠️ 5 FAILING (timeout issues)
### n8n API Integration 🔄 PENDING
- [ ] Workflow CRUD operations (MSW mocks ready)
- [ ] Webhook triggering
- [ ] Execution monitoring
- [ ] Authentication handling
- [ ] Error scenarios
### Database Integration ⚠️ ISSUES FOUND
- [x] ~~SQLite operations with real DB~~ ✅ BASIC TESTS PASS
- [ ] FTS5 search functionality ⚠️ 7 FAILING (syntax errors)
- [ ] Transaction handling ⚠️ 1 FAILING (isolation issues)
- [ ] Migration testing 🔄 NOT STARTED
- [ ] Performance under load ⚠️ 4 FAILING (slower than thresholds)
## Week 7-8: E2E & Performance
### End-to-End Scenarios
- [ ] Complete workflow creation flow
- [ ] AI agent workflow setup
- [ ] Template import and validation
- [ ] Workflow execution monitoring
- [ ] Error recovery scenarios
### Performance Benchmarks
- [ ] Node loading speed (< 50ms per node)
- [ ] Search performance (< 100ms for 1000 nodes)
- [ ] Validation speed (< 10ms simple, < 100ms complex)
- [ ] Database query performance
- [ ] Memory usage profiling
- [ ] Concurrent request handling
### Load Testing
- [ ] 100 concurrent MCP requests
- [ ] 10,000 nodes in database
- [ ] 1,000 workflow validations/minute
- [ ] Memory leak detection
- [ ] Resource cleanup verification
## Testing Quality Gates
### Coverage Requirements
- [ ] Overall: 80%+ (Currently: 62.67%)
- [x] ~~Core services: 90%+~~ COMPLETED
- [x] ~~MCP tools: 90%+~~ COMPLETED
- [x] ~~Critical paths: 95%+~~ COMPLETED
- [x] ~~New code: 90%+~~ COMPLETED
### Performance Requirements
- [x] ~~All unit tests < 10ms~~ COMPLETED
- [ ] Integration tests < 1s
- [ ] E2E tests < 10s
- [x] ~~Full suite < 5 minutes~~ COMPLETED (~2 minutes)
- [x] ~~No memory leaks~~ COMPLETED
### Code Quality
- [x] ~~No ESLint errors~~ COMPLETED
- [x] ~~No TypeScript errors~~ COMPLETED
- [x] ~~No console.log in tests~~ COMPLETED
- [x] ~~All tests have descriptions~~ COMPLETED
- [x] ~~No hardcoded values~~ COMPLETED
## Monitoring & Maintenance
### Daily
- [ ] Check CI pipeline status
- [ ] Review failed tests
- [ ] Monitor flaky tests
### Weekly
- [ ] Review coverage reports
- [ ] Update test documentation
- [ ] Performance benchmark review
- [ ] Team sync on testing progress
### Monthly
- [ ] Update baseline benchmarks
- [ ] Review and refactor tests
- [ ] Update testing strategy
- [ ] Training/knowledge sharing
## Risk Mitigation
### Technical Risks
- [ ] Mock complexity - Use simple, maintainable mocks
- [ ] Test brittleness - Focus on behavior, not implementation
- [ ] Performance impact - Run heavy tests in parallel
- [ ] Flaky tests - Proper async handling and isolation
### Process Risks
- [ ] Slow adoption - Provide training and examples
- [ ] Coverage gaming - Review test quality, not just numbers
- [ ] Maintenance burden - Automate what's possible
- [ ] Integration complexity - Use test containers
## Success Criteria
### Current Reality Check
- **Unit Tests**: SOLID (932 passing, 87.8% coverage)
- **Integration Tests**: NEEDS WORK (58 failing, 76% pass rate)
- **E2E Tests**: 🔄 NOT STARTED
- **CI/CD**: BROKEN (hiding failures with || true)
### Revised Technical Metrics
- Coverage: Currently 87.8% for unit tests
- Integration test pass rate: Target 100% (currently 76%)
- Performance: Adjust thresholds based on reality
- Reliability: Fix flaky tests during repair
- Speed: CI pipeline < 5 minutes (~2 minutes)
### Team Metrics
- All developers writing tests
- Tests reviewed in PRs
- No production bugs from tested code
- Improved development velocity
## Phases Completed
- **Phase 0**: Immediate Fixes COMPLETED
- **Phase 1**: Vitest Migration COMPLETED
- **Phase 2**: Test Infrastructure COMPLETED
- **Phase 3**: Unit Tests (All 943 tests) COMPLETED
- **Phase 3.5**: Critical Service Testing COMPLETED
- **Phase 3.8**: CI/CD & Infrastructure COMPLETED
- **Phase 4**: Integration Tests 🚧 IN PROGRESS
- **Status**: 58 out of 246 tests failing (23.6% failure rate)
- **CI Issue**: Tests appear green due to `|| true` error suppression
- **Categories of Failures**:
- Database: 9 tests (state isolation, FTS5 syntax)
- MCP Protocol: 16 tests (response structure in error-handling.test.ts)
- MSW: 6 tests (not initialized properly)
- FTS5 Search: 7 tests (query syntax issues)
- Session Management: 5 tests (async cleanup)
- Performance: 15 tests (threshold mismatches)
- **Next Steps**:
1. Get team buy-in for "red" CI
2. Remove `|| true` from workflow
3. Fix tests systematically by category
- **Phase 5**: E2E Tests 🔄 PENDING
## Resources & Tools
### Documentation
- Vitest: https://vitest.dev/
- Testing Library: https://testing-library.com/
- MSW: https://mswjs.io/
- Testcontainers: https://www.testcontainers.com/
### Monitoring
- Codecov: https://codecov.io/
- GitHub Actions: https://github.com/features/actions
- Benchmark Action: https://github.com/benchmark-action/github-action-benchmark
### Team Resources
- Testing best practices guide
- Example test implementations
- Mock usage patterns
- Performance optimization tips

View File

@@ -0,0 +1,472 @@
# n8n-MCP Testing Implementation Guide
## Phase 1: Foundation Setup (Week 1-2)
### 1.1 Install Vitest and Dependencies
```bash
# Remove Jest
npm uninstall jest ts-jest @types/jest
# Install Vitest and related packages
npm install -D vitest @vitest/ui @vitest/coverage-v8
npm install -D @testing-library/jest-dom
npm install -D msw # For API mocking
npm install -D @faker-js/faker # For test data
npm install -D fishery # For factories
```
### 1.2 Update package.json Scripts
```json
{
"scripts": {
// Testing
"test": "vitest",
"test:ui": "vitest --ui",
"test:unit": "vitest run tests/unit",
"test:integration": "vitest run tests/integration",
"test:e2e": "vitest run tests/e2e",
"test:watch": "vitest watch",
"test:coverage": "vitest run --coverage",
"test:coverage:check": "vitest run --coverage --coverage.thresholdAutoUpdate=false",
// Benchmarks
"bench": "vitest bench",
"bench:compare": "vitest bench --compare",
// CI specific
"test:ci": "vitest run --reporter=junit --reporter=default",
"test:ci:coverage": "vitest run --coverage --reporter=junit --reporter=default"
}
}
```
### 1.3 Migrate Existing Tests
```typescript
// Before (Jest)
import { describe, test, expect } from '@jest/globals';
// After (Vitest)
import { describe, it, expect, vi } from 'vitest';
// Update mock syntax
// Jest: jest.mock('module')
// Vitest: vi.mock('module')
// Update timer mocks
// Jest: jest.useFakeTimers()
// Vitest: vi.useFakeTimers()
```
### 1.4 Create Test Database Setup
```typescript
// tests/setup/test-database.ts
import Database from 'better-sqlite3';
import { readFileSync } from 'fs';
import { join } from 'path';
export class TestDatabase {
private db: Database.Database;
constructor() {
this.db = new Database(':memory:');
this.initialize();
}
private initialize() {
const schema = readFileSync(
join(__dirname, '../../src/database/schema.sql'),
'utf8'
);
this.db.exec(schema);
}
seedNodes(nodes: any[]) {
const stmt = this.db.prepare(`
INSERT INTO nodes (type, displayName, name, group, version, description, properties)
VALUES (?, ?, ?, ?, ?, ?, ?)
`);
const insertMany = this.db.transaction((nodes) => {
for (const node of nodes) {
stmt.run(
node.type,
node.displayName,
node.name,
node.group,
node.version,
node.description,
JSON.stringify(node.properties)
);
}
});
insertMany(nodes);
}
close() {
this.db.close();
}
getDb() {
return this.db;
}
}
```
## Phase 2: Core Unit Tests (Week 3-4)
### 2.1 Test Organization Template
```typescript
// tests/unit/services/[service-name].test.ts
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { ServiceName } from '@/services/service-name';
describe('ServiceName', () => {
let service: ServiceName;
let mockDependency: any;
beforeEach(() => {
// Setup mocks
mockDependency = {
method: vi.fn()
};
// Create service instance
service = new ServiceName(mockDependency);
});
afterEach(() => {
vi.clearAllMocks();
});
describe('methodName', () => {
it('should handle happy path', async () => {
// Arrange
const input = { /* test data */ };
mockDependency.method.mockResolvedValue({ /* mock response */ });
// Act
const result = await service.methodName(input);
// Assert
expect(result).toEqual(/* expected output */);
expect(mockDependency.method).toHaveBeenCalledWith(/* expected args */);
});
it('should handle errors gracefully', async () => {
// Arrange
mockDependency.method.mockRejectedValue(new Error('Test error'));
// Act & Assert
await expect(service.methodName({})).rejects.toThrow('Expected error message');
});
});
});
```
### 2.2 Mock Strategies by Layer
#### Database Layer
```typescript
// tests/unit/database/node-repository.test.ts
import { vi } from 'vitest';
vi.mock('better-sqlite3', () => ({
default: vi.fn(() => ({
prepare: vi.fn(() => ({
all: vi.fn(() => mockData),
get: vi.fn((id) => mockData.find(d => d.id === id)),
run: vi.fn(() => ({ changes: 1 }))
})),
exec: vi.fn(),
close: vi.fn()
}))
}));
```
#### External APIs
```typescript
// tests/unit/services/__mocks__/axios.ts
export default {
create: vi.fn(() => ({
get: vi.fn(() => Promise.resolve({ data: {} })),
post: vi.fn(() => Promise.resolve({ data: { id: '123' } })),
put: vi.fn(() => Promise.resolve({ data: {} })),
delete: vi.fn(() => Promise.resolve({ data: {} }))
}))
};
```
#### File System
```typescript
// Use memfs for file system mocking
import { vol } from 'memfs';
vi.mock('fs', () => vol);
beforeEach(() => {
vol.reset();
vol.fromJSON({
'/test/file.json': JSON.stringify({ test: 'data' })
});
});
```
### 2.3 Critical Path Tests
```typescript
// Priority 1: Node Loading and Parsing
// tests/unit/loaders/node-loader.test.ts
// Priority 2: Configuration Validation
// tests/unit/services/config-validator.test.ts
// Priority 3: MCP Tools
// tests/unit/mcp/tools.test.ts
// Priority 4: Database Operations
// tests/unit/database/node-repository.test.ts
// Priority 5: Workflow Validation
// tests/unit/services/workflow-validator.test.ts
```
## Phase 3: Integration Tests (Week 5-6)
### 3.1 Test Container Setup
```typescript
// tests/setup/test-containers.ts
import { GenericContainer, StartedTestContainer } from 'testcontainers';
export class N8nTestContainer {
private container: StartedTestContainer;
async start() {
this.container = await new GenericContainer('n8nio/n8n:latest')
.withExposedPorts(5678)
.withEnv('N8N_BASIC_AUTH_ACTIVE', 'false')
.withEnv('N8N_ENCRYPTION_KEY', 'test-key')
.start();
return {
url: `http://localhost:${this.container.getMappedPort(5678)}`,
stop: () => this.container.stop()
};
}
}
```
### 3.2 Integration Test Pattern
```typescript
// tests/integration/n8n-api/workflow-crud.test.ts
import { N8nTestContainer } from '@tests/setup/test-containers';
import { N8nAPIClient } from '@/services/n8n-api-client';
describe('n8n API Integration', () => {
let container: any;
let apiClient: N8nAPIClient;
beforeAll(async () => {
container = await new N8nTestContainer().start();
apiClient = new N8nAPIClient(container.url);
}, 30000);
afterAll(async () => {
await container.stop();
});
it('should create and retrieve workflow', async () => {
// Create workflow
const workflow = createTestWorkflow();
const created = await apiClient.createWorkflow(workflow);
expect(created.id).toBeDefined();
// Retrieve workflow
const retrieved = await apiClient.getWorkflow(created.id);
expect(retrieved.name).toBe(workflow.name);
});
});
```
## Phase 4: E2E & Performance (Week 7-8)
### 4.1 E2E Test Setup
```typescript
// tests/e2e/workflows/complete-workflow.test.ts
import { MCPClient } from '@tests/utils/mcp-client';
import { N8nTestContainer } from '@tests/setup/test-containers';
describe('Complete Workflow E2E', () => {
let mcpServer: any;
let n8nContainer: any;
let mcpClient: MCPClient;
beforeAll(async () => {
// Start n8n
n8nContainer = await new N8nTestContainer().start();
// Start MCP server
mcpServer = await startMCPServer({
n8nUrl: n8nContainer.url
});
// Create MCP client
mcpClient = new MCPClient(mcpServer.url);
}, 60000);
it('should execute complete workflow creation flow', async () => {
// 1. Search for nodes
const searchResult = await mcpClient.call('search_nodes', {
query: 'webhook http slack'
});
// 2. Get node details
const webhookInfo = await mcpClient.call('get_node_info', {
nodeType: 'nodes-base.webhook'
});
// 3. Create workflow
const workflow = new WorkflowBuilder('E2E Test')
.addWebhookNode()
.addHttpRequestNode()
.addSlackNode()
.connectSequentially()
.build();
// 4. Validate workflow
const validation = await mcpClient.call('validate_workflow', {
workflow
});
expect(validation.isValid).toBe(true);
// 5. Deploy to n8n
const deployed = await mcpClient.call('n8n_create_workflow', {
...workflow
});
expect(deployed.id).toBeDefined();
expect(deployed.active).toBe(false);
});
});
```
### 4.2 Performance Benchmarks
```typescript
// vitest.benchmark.config.ts
export default {
test: {
benchmark: {
// Output benchmark results
outputFile: './benchmark-results.json',
// Compare with baseline
compare: './benchmark-baseline.json',
// Fail if performance degrades by more than 10%
threshold: {
p95: 1.1, // 110% of baseline
p99: 1.2 // 120% of baseline
}
}
}
};
```
## Testing Best Practices
### 1. Test Naming Convention
```typescript
// Format: should [expected behavior] when [condition]
it('should return user data when valid ID is provided')
it('should throw ValidationError when email is invalid')
it('should retry 3 times when network fails')
```
### 2. Test Data Builders
```typescript
// Use builders for complex test data
const user = new UserBuilder()
.withEmail('test@example.com')
.withRole('admin')
.build();
```
### 3. Custom Matchers
```typescript
// tests/utils/matchers.ts
export const toBeValidNode = (received: any) => {
const pass =
received.type &&
received.displayName &&
received.properties &&
Array.isArray(received.properties);
return {
pass,
message: () => `expected ${received} to be a valid node`
};
};
// Usage
expect(node).toBeValidNode();
```
### 4. Snapshot Testing
```typescript
// For complex structures
it('should generate correct node schema', () => {
const schema = generateNodeSchema(node);
expect(schema).toMatchSnapshot();
});
```
### 5. Test Isolation
```typescript
// Always clean up after tests
afterEach(async () => {
await cleanup();
vi.clearAllMocks();
vi.restoreAllMocks();
});
```
## Coverage Goals by Module
| Module | Target | Priority | Notes |
|--------|--------|----------|-------|
| services/config-validator | 95% | High | Critical for reliability |
| services/workflow-validator | 90% | High | Core functionality |
| mcp/tools | 90% | High | User-facing API |
| database/node-repository | 85% | Medium | Well-tested DB layer |
| loaders/node-loader | 85% | Medium | External dependencies |
| parsers/* | 90% | High | Data transformation |
| utils/* | 80% | Low | Helper functions |
| scripts/* | 50% | Low | One-time scripts |
## Continuous Improvement
1. **Weekly Reviews**: Review test coverage and identify gaps
2. **Performance Baselines**: Update benchmarks monthly
3. **Flaky Test Detection**: Monitor and fix within 48 hours
4. **Test Documentation**: Keep examples updated
5. **Developer Training**: Pair programming on tests
## Success Metrics
- [ ] All tests pass in CI (0 failures)
- [ ] Coverage > 80% overall
- [ ] No flaky tests
- [ ] CI runs < 5 minutes
- [ ] Performance benchmarks stable
- [ ] Zero production bugs from tested code

File diff suppressed because it is too large Load Diff

1227
docs/testing-strategy.md Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,66 @@
# Token Efficiency Improvements Summary
## Overview
Made all MCP tool descriptions concise and token-efficient while preserving essential information.
## Key Improvements
### Before vs After Examples
1. **search_nodes**
- Before: ~350 chars with verbose explanation
- After: 165 chars
- `Search nodes by keywords. Modes: OR (any word), AND (all words), FUZZY (typos OK). Primary nodes ranked first. Examples: "webhook"→Webhook, "http call"→HTTP Request.`
2. **get_node_info**
- Before: ~450 chars with warnings about size
- After: 174 chars
- `Get FULL node schema (100KB+). TIP: Use get_node_essentials first! Returns all properties/operations/credentials. Prefix required: "nodes-base.httpRequest" not "httpRequest".`
3. **validate_node_minimal**
- Before: ~350 chars explaining what it doesn't do
- After: 102 chars
- `Fast check for missing required fields only. No warnings/suggestions. Returns: list of missing fields.`
4. **get_property_dependencies**
- Before: ~400 chars with full example
- After: 131 chars
- `Shows property dependencies and visibility rules. Example: sendBody=true reveals body fields. Test visibility with optional config.`
## Statistics
### Documentation Tools (22 tools)
- Average description length: **129 characters**
- Total characters: 2,836
- Tools over 200 chars: 1 (list_nodes at 204)
### Management Tools (17 tools)
- Average description length: **93 characters**
- Total characters: 1,578
- Tools over 200 chars: 1 (n8n_update_partial_workflow at 284)
## Strategy Used
1. **Remove redundancy**: Eliminated repeated information available in parameter descriptions
2. **Use abbreviations**: "vs" instead of "versus", "&" instead of "and" where appropriate
3. **Compact examples**: `"webhook"→Webhook` instead of verbose explanations
4. **Direct language**: "Fast check" instead of "Quick validation that only checks"
5. **Move details to documentation**: Complex tools reference `tools_documentation()` for full details
6. **Essential info only**: Focus on what the tool does, not how it works internally
## Special Cases
### n8n_update_partial_workflow
This tool's description is necessarily longer (284 chars) because:
- Lists all 13 operation types
- Critical for users to know available operations
- Directs to full documentation for details
### Complex Documentation Preserved
For tools like `n8n_update_partial_workflow`, detailed documentation was moved to `tools-documentation.ts` rather than deleted, ensuring users can still access comprehensive information when needed.
## Impact
- **Token savings**: ~65-70% reduction in description tokens
- **Faster AI responses**: Less context used for tool descriptions
- **Better UX**: Clearer, more scannable tool list
- **Maintained functionality**: All essential information preserved

View File

@@ -0,0 +1,118 @@
# Transactional Updates Example
This example demonstrates the new transactional update capabilities in v2.7.0.
## Before (v2.6.x and earlier)
Previously, you had to carefully order operations to ensure nodes existed before connecting them:
```json
{
"id": "workflow-123",
"operations": [
// 1. First add all nodes
{ "type": "addNode", "node": { "name": "Process", "type": "n8n-nodes-base.set", ... }},
{ "type": "addNode", "node": { "name": "Notify", "type": "n8n-nodes-base.slack", ... }},
// 2. Then add connections (would fail if done before nodes)
{ "type": "addConnection", "source": "Webhook", "target": "Process" },
{ "type": "addConnection", "source": "Process", "target": "Notify" }
]
}
```
## After (v2.7.0+)
Now you can write operations in any order - the engine automatically handles dependencies:
```json
{
"id": "workflow-123",
"operations": [
// Connections can come first!
{ "type": "addConnection", "source": "Webhook", "target": "Process" },
{ "type": "addConnection", "source": "Process", "target": "Notify" },
// Nodes added later - still works!
{ "type": "addNode", "node": { "name": "Process", "type": "n8n-nodes-base.set", "position": [400, 300] }},
{ "type": "addNode", "node": { "name": "Notify", "type": "n8n-nodes-base.slack", "position": [600, 300] }}
]
}
```
## How It Works
1. **Two-Pass Processing**:
- Pass 1: All node operations (add, remove, update, move, enable, disable)
- Pass 2: All other operations (connections, settings, metadata)
2. **Operation Limit**: Maximum 5 operations per request keeps complexity manageable
3. **Atomic Updates**: All operations succeed or all fail - no partial updates
## Benefits for AI Agents
- **Intuitive**: Write operations in the order that makes sense logically
- **Reliable**: No need to track dependencies manually
- **Simple**: Focus on what to change, not how to order changes
- **Safe**: Built-in limits prevent overly complex operations
## Complete Example
Here's a real-world example of adding error handling to a workflow:
```json
{
"id": "workflow-123",
"operations": [
// Define the flow first (makes logical sense)
{
"type": "removeConnection",
"source": "HTTP Request",
"target": "Save to DB"
},
{
"type": "addConnection",
"source": "HTTP Request",
"target": "Error Handler"
},
{
"type": "addConnection",
"source": "Error Handler",
"target": "Send Alert"
},
// Then add the nodes
{
"type": "addNode",
"node": {
"name": "Error Handler",
"type": "n8n-nodes-base.if",
"position": [500, 400],
"parameters": {
"conditions": {
"boolean": [{
"value1": "={{$json.error}}",
"value2": true
}]
}
}
}
},
{
"type": "addNode",
"node": {
"name": "Send Alert",
"type": "n8n-nodes-base.emailSend",
"position": [700, 400],
"parameters": {
"to": "alerts@company.com",
"subject": "Workflow Error Alert"
}
}
}
]
}
```
All operations will be processed correctly, even though connections reference nodes that don't exist yet!

View File

@@ -0,0 +1,92 @@
# Validation Improvements v2.4.2
Based on AI agent feedback, we've implemented several improvements to the `validate_node_operation` tool:
## 🎯 Issues Addressed
### 1. **@version Warnings** ✅ FIXED
- **Issue**: Showed confusing warnings about `@version` property not being used
- **Fix**: Filter out internal properties starting with `@` or `_`
- **Result**: No more false warnings about internal n8n properties
### 2. **Duplicate Errors** ✅ FIXED
- **Issue**: Same error shown multiple times (e.g., missing `ts` field)
- **Fix**: Implemented deduplication that keeps the most specific error message
- **Result**: Each error shown only once with the best description
### 3. **Basic Code Validation** ✅ ADDED
- **Issue**: No syntax validation for Code node
- **Fix**: Added basic syntax checks for JavaScript and Python
- **Features**:
- Unbalanced braces/parentheses detection
- Python indentation consistency check
- n8n-specific patterns (return statement, input access)
- Security warnings (eval/exec usage)
## 📊 Before & After
### Before (v2.4.1):
```json
{
"errors": [
{ "property": "ts", "message": "Required property 'Message Timestamp' is missing" },
{ "property": "ts", "message": "Message timestamp (ts) is required to update a message" }
],
"warnings": [
{ "property": "@version", "message": "Property '@version' is configured but won't be used" }
]
}
```
### After (v2.4.2):
```json
{
"errors": [
{ "property": "ts", "message": "Message timestamp (ts) is required to update a message",
"fix": "Provide the timestamp of the message to update" }
],
"warnings": [] // No @version warning
}
```
## 🆕 Code Validation Examples
### JavaScript Syntax Check:
```javascript
// Missing closing brace
if (true) {
return items;
// Error: "Unbalanced braces detected"
```
### Python Indentation Check:
```python
def process():
if True: # Tab
return items # Spaces
# Error: "Mixed tabs and spaces in indentation"
```
### n8n Pattern Check:
```javascript
const result = items.map(item => item.json);
// Warning: "No return statement found"
// Suggestion: "Add: return items;"
```
## 🚀 Impact
- **Cleaner validation results** - No more noise from internal properties
- **Clearer error messages** - Each issue reported once with best description
- **Better code quality** - Basic syntax validation catches common mistakes
- **n8n best practices** - Warns about missing return statements and input handling
## 📝 Summary
The `validate_node_operation` tool is now even more helpful for AI agents and developers:
- 95% reduction in false positives (operation-aware)
- No duplicate or confusing warnings
- Basic code validation for common syntax errors
- n8n-specific pattern checking
**Rating improved from 9/10 to 9.5/10!** 🎉

28
eslint.config.js Normal file
View File

@@ -0,0 +1,28 @@
import tseslint from '@typescript-eslint/eslint-plugin';
import tsparser from '@typescript-eslint/parser';
export default [
{
files: ['src/**/*.ts'],
languageOptions: {
parser: tsparser,
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
project: './tsconfig.json'
}
},
plugins: {
'@typescript-eslint': tseslint
},
rules: {
'no-restricted-syntax': [
'error',
{
selector: 'CallExpression[callee.property.name="exec"] TemplateLiteral',
message: 'SECURITY: Template literals in db.exec() can lead to SQL injection. Use parameterized queries with db.prepare().all() instead. See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-01)'
}
]
}
}
];

View File

7044
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,16 +1,8 @@
{
"name": "n8n-mcp",
"version": "2.20.8",
"version": "2.16.3",
"description": "Integration between n8n workflow automation and Model Context Protocol (MCP)",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"require": "./dist/index.js",
"import": "./dist/index.js"
}
},
"bin": {
"n8n-mcp": "./dist/mcp/index.js"
},
@@ -43,6 +35,7 @@
"test:cleanup:orphans": "tsx tests/integration/n8n-api/scripts/cleanup-orphans.ts",
"test:e2e": "vitest run tests/e2e",
"lint": "tsc --noEmit",
"lint:eslint": "eslint 'src/**/*.ts'",
"typecheck": "tsc --noEmit",
"update:n8n": "node scripts/update-n8n-deps.js",
"update:n8n:check": "node scripts/update-n8n-deps.js --dry-run",
@@ -126,11 +119,14 @@
"@types/express": "^5.0.3",
"@types/node": "^22.15.30",
"@types/ws": "^8.18.1",
"@typescript-eslint/eslint-plugin": "^8.45.0",
"@typescript-eslint/parser": "^8.45.0",
"@vitest/coverage-v8": "^3.2.4",
"@vitest/runner": "^3.2.4",
"@vitest/ui": "^3.2.4",
"axios": "^1.11.0",
"axios-mock-adapter": "^2.1.0",
"eslint": "^9.37.0",
"fishery": "^2.3.1",
"msw": "^2.10.4",
"nodemon": "^3.1.10",
@@ -139,19 +135,19 @@
"vitest": "^3.2.4"
},
"dependencies": {
"@modelcontextprotocol/sdk": "^1.20.1",
"@n8n/n8n-nodes-langchain": "^1.115.1",
"@modelcontextprotocol/sdk": "^1.13.2",
"@n8n/n8n-nodes-langchain": "^1.112.2",
"@supabase/supabase-js": "^2.57.4",
"dotenv": "^16.5.0",
"express": "^5.1.0",
"express-rate-limit": "^7.1.5",
"helmet": "^8.1.0",
"lru-cache": "^11.2.1",
"n8n": "^1.116.2",
"n8n-core": "^1.115.1",
"n8n-workflow": "^1.113.0",
"n8n": "^1.113.3",
"n8n-core": "^1.112.1",
"n8n-workflow": "^1.110.0",
"openai": "^4.77.0",
"sql.js": "^1.13.0",
"tslib": "^2.6.2",
"uuid": "^10.0.0",
"zod": "^3.24.1"
},

View File

@@ -1,6 +1,6 @@
{
"name": "n8n-mcp-runtime",
"version": "2.20.7",
"version": "2.16.3",
"description": "n8n MCP Server Runtime Dependencies Only",
"private": true,
"dependencies": {
@@ -11,7 +11,6 @@
"dotenv": "^16.5.0",
"lru-cache": "^11.2.1",
"sql.js": "^1.13.0",
"tslib": "^2.6.2",
"uuid": "^10.0.0",
"axios": "^1.7.7"
},

60
release-notes-v2.7.0.md Normal file
View File

@@ -0,0 +1,60 @@
# n8n-MCP v2.7.0 Release Notes
## 🎉 What's New
### 🔧 File Refactoring & Version Management
- **Renamed core MCP files** to remove unnecessary suffixes for cleaner codebase:
- `tools-update.ts``tools.ts`
- `server-update.ts``server.ts`
- `http-server-fixed.ts``http-server.ts`
- **Fixed version management** - Now reads from package.json as single source of truth (fixes #5)
- **Updated imports** across 21+ files to use the new file names
### 🔍 New Diagnostic Tool
- **Added `n8n_diagnostic` tool** - Helps troubleshoot why n8n management tools might not be appearing
- Shows environment variable status, API connectivity, and tool availability
- Provides step-by-step troubleshooting guidance
- Includes verbose mode for additional debug information
### 🧹 Code Cleanup
- Removed legacy HTTP server implementation with known issues
- Removed unused legacy API client
- Added version utility for consistent version handling
- Added script to sync runtime package version
## 📦 Installation
### Docker (Recommended)
```bash
docker pull ghcr.io/czlonkowski/n8n-mcp:2.7.0
```
### Claude Desktop
Update your configuration to use the latest version:
```json
{
"mcpServers": {
"n8n-mcp": {
"command": "docker",
"args": ["run", "-i", "--rm", "ghcr.io/czlonkowski/n8n-mcp:2.7.0"]
}
}
}
```
## 🐛 Bug Fixes
- Fixed version mismatch where version was hardcoded as 2.4.1 instead of reading from package.json
- Improved error messages for better debugging
## 📚 Documentation Updates
- Condensed version history in CLAUDE.md
- Updated documentation structure in README.md
- Removed outdated documentation files
- Added n8n_diagnostic tool to documentation
## 🙏 Acknowledgments
Thanks to all contributors and users who reported issues!
---
**Full Changelog**: https://github.com/czlonkowski/n8n-mcp/blob/main/CHANGELOG.md

View File

@@ -1,78 +0,0 @@
/**
* Database Schema Coverage Audit Script
*
* Audits the database to determine how many nodes have complete schema information
* for resourceLocator mode validation. This helps assess the coverage of our
* schema-driven validation approach.
*/
import Database from 'better-sqlite3';
import path from 'path';
const dbPath = path.join(__dirname, '../data/nodes.db');
const db = new Database(dbPath, { readonly: true });
console.log('=== Schema Coverage Audit ===\n');
// Query 1: How many nodes have resourceLocator properties?
const totalResourceLocator = db.prepare(`
SELECT COUNT(*) as count FROM nodes
WHERE properties_schema LIKE '%resourceLocator%'
`).get() as { count: number };
console.log(`Nodes with resourceLocator properties: ${totalResourceLocator.count}`);
// Query 2: Of those, how many have modes defined?
const withModes = db.prepare(`
SELECT COUNT(*) as count FROM nodes
WHERE properties_schema LIKE '%resourceLocator%'
AND properties_schema LIKE '%modes%'
`).get() as { count: number };
console.log(`Nodes with modes defined: ${withModes.count}`);
// Query 3: Which nodes have resourceLocator but NO modes?
const withoutModes = db.prepare(`
SELECT node_type, display_name
FROM nodes
WHERE properties_schema LIKE '%resourceLocator%'
AND properties_schema NOT LIKE '%modes%'
LIMIT 10
`).all() as Array<{ node_type: string; display_name: string }>;
console.log(`\nSample nodes WITHOUT modes (showing 10):`);
withoutModes.forEach(node => {
console.log(` - ${node.display_name} (${node.node_type})`);
});
// Calculate coverage percentage
const coverage = totalResourceLocator.count > 0
? (withModes.count / totalResourceLocator.count) * 100
: 0;
console.log(`\nSchema coverage: ${coverage.toFixed(1)}% of resourceLocator nodes have modes defined`);
// Query 4: Get some examples of nodes WITH modes for verification
console.log('\nSample nodes WITH modes (showing 5):');
const withModesExamples = db.prepare(`
SELECT node_type, display_name
FROM nodes
WHERE properties_schema LIKE '%resourceLocator%'
AND properties_schema LIKE '%modes%'
LIMIT 5
`).all() as Array<{ node_type: string; display_name: string }>;
withModesExamples.forEach(node => {
console.log(` - ${node.display_name} (${node.node_type})`);
});
// Summary
console.log('\n=== Summary ===');
console.log(`Total nodes in database: ${db.prepare('SELECT COUNT(*) as count FROM nodes').get() as any as { count: number }.count}`);
console.log(`Nodes with resourceLocator: ${totalResourceLocator.count}`);
console.log(`Nodes with complete mode schemas: ${withModes.count}`);
console.log(`Nodes without mode schemas: ${totalResourceLocator.count - withModes.count}`);
console.log(`\nImplication: Schema-driven validation will apply to ${withModes.count} nodes.`);
console.log(`For the remaining ${totalResourceLocator.count - withModes.count} nodes, validation will be skipped (graceful degradation).`);
db.close();

View File

@@ -11,8 +11,29 @@ NC='\033[0m' # No Color
echo "🚀 Preparing n8n-mcp for npm publish..."
# Skip tests - they already run in CI before merge/publish
echo "⏭️ Skipping tests (already verified in CI)"
# Run tests first to ensure quality
echo "🧪 Running tests..."
TEST_OUTPUT=$(npm test 2>&1)
TEST_EXIT_CODE=$?
# Check test results - look for actual test failures vs coverage issues
if echo "$TEST_OUTPUT" | grep -q "Tests.*failed"; then
# Extract failed count using sed (portable)
FAILED_COUNT=$(echo "$TEST_OUTPUT" | sed -n 's/.*Tests.*\([0-9]*\) failed.*/\1/p' | head -1)
if [ "$FAILED_COUNT" != "0" ] && [ "$FAILED_COUNT" != "" ]; then
echo -e "${RED}$FAILED_COUNT test(s) failed. Aborting publish.${NC}"
echo "$TEST_OUTPUT" | tail -20
exit 1
fi
fi
# If we got here, tests passed - check coverage
if echo "$TEST_OUTPUT" | grep -q "Coverage.*does not meet global threshold"; then
echo -e "${YELLOW}⚠️ All tests passed but coverage is below threshold${NC}"
echo -e "${YELLOW} Consider improving test coverage before next release${NC}"
else
echo -e "${GREEN}✅ All tests passed with good coverage!${NC}"
fi
# Sync version to runtime package first
echo "🔄 Syncing version to package.runtime.json..."
@@ -59,15 +80,6 @@ node -e "
const pkg = require('./package.json');
pkg.name = 'n8n-mcp';
pkg.description = 'Integration between n8n workflow automation and Model Context Protocol (MCP)';
pkg.main = 'dist/index.js';
pkg.types = 'dist/index.d.ts';
pkg.exports = {
'.': {
types: './dist/index.d.ts',
require: './dist/index.js',
import: './dist/index.js'
}
};
pkg.bin = { 'n8n-mcp': './dist/mcp/index.js' };
pkg.repository = { type: 'git', url: 'git+https://github.com/czlonkowski/n8n-mcp.git' };
pkg.keywords = ['n8n', 'mcp', 'model-context-protocol', 'ai', 'workflow', 'automation'];

View File

@@ -1,189 +0,0 @@
#!/usr/bin/env node
/**
* Debug test for AI validation issues
* Reproduces the bugs found by n8n-mcp-tester
*/
import { validateAISpecificNodes, buildReverseConnectionMap } from '../src/services/ai-node-validator';
import type { WorkflowJson } from '../src/services/ai-tool-validators';
import { NodeTypeNormalizer } from '../src/utils/node-type-normalizer';
console.log('=== AI Validation Debug Tests ===\n');
// Test 1: AI Agent with NO language model connection
console.log('Test 1: Missing Language Model Detection');
const workflow1: WorkflowJson = {
name: 'Test Missing LM',
nodes: [
{
id: 'ai-agent-1',
name: 'AI Agent',
type: '@n8n/n8n-nodes-langchain.agent',
position: [500, 300],
parameters: {
promptType: 'define',
text: 'You are a helpful assistant'
},
typeVersion: 1.7
}
],
connections: {
// NO connections - AI Agent is isolated
}
};
console.log('Workflow:', JSON.stringify(workflow1, null, 2));
const reverseMap1 = buildReverseConnectionMap(workflow1);
console.log('\nReverse connection map for AI Agent:');
console.log('Entries:', Array.from(reverseMap1.entries()));
console.log('AI Agent connections:', reverseMap1.get('AI Agent'));
// Check node normalization
const normalizedType1 = NodeTypeNormalizer.normalizeToFullForm(workflow1.nodes[0].type);
console.log(`\nNode type: ${workflow1.nodes[0].type}`);
console.log(`Normalized type: ${normalizedType1}`);
console.log(`Match check: ${normalizedType1 === '@n8n/n8n-nodes-langchain.agent'}`);
const issues1 = validateAISpecificNodes(workflow1);
console.log('\nValidation issues:');
console.log(JSON.stringify(issues1, null, 2));
const hasMissingLMError = issues1.some(
i => i.severity === 'error' && i.code === 'MISSING_LANGUAGE_MODEL'
);
console.log(`\n✓ Has MISSING_LANGUAGE_MODEL error: ${hasMissingLMError}`);
console.log(`✗ Expected: true, Got: ${hasMissingLMError}`);
// Test 2: AI Agent WITH language model connection
console.log('\n\n' + '='.repeat(60));
console.log('Test 2: AI Agent WITH Language Model (Should be valid)');
const workflow2: WorkflowJson = {
name: 'Test With LM',
nodes: [
{
id: 'openai-1',
name: 'OpenAI Chat Model',
type: '@n8n/n8n-nodes-langchain.lmChatOpenAi',
position: [200, 300],
parameters: {
modelName: 'gpt-4'
},
typeVersion: 1
},
{
id: 'ai-agent-1',
name: 'AI Agent',
type: '@n8n/n8n-nodes-langchain.agent',
position: [500, 300],
parameters: {
promptType: 'define',
text: 'You are a helpful assistant'
},
typeVersion: 1.7
}
],
connections: {
'OpenAI Chat Model': {
ai_languageModel: [
[
{
node: 'AI Agent',
type: 'ai_languageModel',
index: 0
}
]
]
}
}
};
console.log('\nConnections:', JSON.stringify(workflow2.connections, null, 2));
const reverseMap2 = buildReverseConnectionMap(workflow2);
console.log('\nReverse connection map for AI Agent:');
console.log('AI Agent connections:', reverseMap2.get('AI Agent'));
const issues2 = validateAISpecificNodes(workflow2);
console.log('\nValidation issues:');
console.log(JSON.stringify(issues2, null, 2));
const hasMissingLMError2 = issues2.some(
i => i.severity === 'error' && i.code === 'MISSING_LANGUAGE_MODEL'
);
console.log(`\n✓ Should NOT have MISSING_LANGUAGE_MODEL error: ${!hasMissingLMError2}`);
console.log(`Expected: false, Got: ${hasMissingLMError2}`);
// Test 3: AI Agent with tools but no language model
console.log('\n\n' + '='.repeat(60));
console.log('Test 3: AI Agent with Tools but NO Language Model');
const workflow3: WorkflowJson = {
name: 'Test Tools No LM',
nodes: [
{
id: 'http-tool-1',
name: 'HTTP Request Tool',
type: '@n8n/n8n-nodes-langchain.toolHttpRequest',
position: [200, 300],
parameters: {
toolDescription: 'Calls an API',
url: 'https://api.example.com'
},
typeVersion: 1.1
},
{
id: 'ai-agent-1',
name: 'AI Agent',
type: '@n8n/n8n-nodes-langchain.agent',
position: [500, 300],
parameters: {
promptType: 'define',
text: 'You are a helpful assistant'
},
typeVersion: 1.7
}
],
connections: {
'HTTP Request Tool': {
ai_tool: [
[
{
node: 'AI Agent',
type: 'ai_tool',
index: 0
}
]
]
}
}
};
console.log('\nConnections:', JSON.stringify(workflow3.connections, null, 2));
const reverseMap3 = buildReverseConnectionMap(workflow3);
console.log('\nReverse connection map for AI Agent:');
const aiAgentConns = reverseMap3.get('AI Agent');
console.log('AI Agent connections:', aiAgentConns);
console.log('Connection types:', aiAgentConns?.map(c => c.type));
const issues3 = validateAISpecificNodes(workflow3);
console.log('\nValidation issues:');
console.log(JSON.stringify(issues3, null, 2));
const hasMissingLMError3 = issues3.some(
i => i.severity === 'error' && i.code === 'MISSING_LANGUAGE_MODEL'
);
const hasNoToolsInfo3 = issues3.some(
i => i.severity === 'info' && i.message.includes('no ai_tool connections')
);
console.log(`\n✓ Should have MISSING_LANGUAGE_MODEL error: ${hasMissingLMError3}`);
console.log(`Expected: true, Got: ${hasMissingLMError3}`);
console.log(`✗ Should NOT have "no tools" info: ${!hasNoToolsInfo3}`);
console.log(`Expected: false, Got: ${hasNoToolsInfo3}`);
console.log('\n' + '='.repeat(60));
console.log('Summary:');
console.log(`Test 1 (No LM): ${hasMissingLMError ? 'PASS ✓' : 'FAIL ✗'}`);
console.log(`Test 2 (With LM): ${!hasMissingLMError2 ? 'PASS ✓' : 'FAIL ✗'}`);
console.log(`Test 3 (Tools, No LM): ${hasMissingLMError3 && !hasNoToolsInfo3 ? 'PASS ✓' : 'FAIL ✗'}`);

View File

@@ -1,163 +0,0 @@
/**
* Test Docker Host Fingerprinting
* Verifies that host machine characteristics are stable across container recreations
*/
import { existsSync, readFileSync } from 'fs';
import { platform, arch } from 'os';
import { createHash } from 'crypto';
console.log('=== Docker Host Fingerprinting Test ===\n');
function generateHostFingerprint(): string {
try {
const signals: string[] = [];
console.log('Collecting host signals...\n');
// CPU info (stable across container recreations)
if (existsSync('/proc/cpuinfo')) {
const cpuinfo = readFileSync('/proc/cpuinfo', 'utf-8');
const modelMatch = cpuinfo.match(/model name\s*:\s*(.+)/);
const coresMatch = cpuinfo.match(/processor\s*:/g);
if (modelMatch) {
const cpuModel = modelMatch[1].trim();
signals.push(cpuModel);
console.log('✓ CPU Model:', cpuModel);
}
if (coresMatch) {
const cores = `cores:${coresMatch.length}`;
signals.push(cores);
console.log('✓ CPU Cores:', coresMatch.length);
}
} else {
console.log('✗ /proc/cpuinfo not available (Windows/Mac Docker)');
}
// Memory (stable)
if (existsSync('/proc/meminfo')) {
const meminfo = readFileSync('/proc/meminfo', 'utf-8');
const totalMatch = meminfo.match(/MemTotal:\s+(\d+)/);
if (totalMatch) {
const memory = `mem:${totalMatch[1]}`;
signals.push(memory);
console.log('✓ Total Memory:', totalMatch[1], 'kB');
}
} else {
console.log('✗ /proc/meminfo not available (Windows/Mac Docker)');
}
// Docker network subnet
const networkInfo = getDockerNetworkInfo();
if (networkInfo) {
signals.push(networkInfo);
console.log('✓ Network Info:', networkInfo);
} else {
console.log('✗ Network info not available');
}
// Platform basics (stable)
signals.push(platform(), arch());
console.log('✓ Platform:', platform());
console.log('✓ Architecture:', arch());
// Generate stable ID from all signals
console.log('\nCombined signals:', signals.join(' | '));
const fingerprint = signals.join('-');
const userId = createHash('sha256').update(fingerprint).digest('hex').substring(0, 16);
return userId;
} catch (error) {
console.error('Error generating fingerprint:', error);
// Fallback
return createHash('sha256')
.update(`${platform()}-${arch()}-docker`)
.digest('hex')
.substring(0, 16);
}
}
function getDockerNetworkInfo(): string | null {
try {
// Read routing table to get bridge network
if (existsSync('/proc/net/route')) {
const routes = readFileSync('/proc/net/route', 'utf-8');
const lines = routes.split('\n');
for (const line of lines) {
if (line.includes('eth0')) {
const parts = line.split(/\s+/);
if (parts[2]) {
const gateway = parseInt(parts[2], 16).toString(16);
return `net:${gateway}`;
}
}
}
}
} catch {
// Ignore errors
}
return null;
}
// Test environment detection
console.log('\n=== Environment Detection ===\n');
const isDocker = process.env.IS_DOCKER === 'true';
const isCloudEnvironment = !!(
process.env.RAILWAY_ENVIRONMENT ||
process.env.RENDER ||
process.env.FLY_APP_NAME ||
process.env.HEROKU_APP_NAME ||
process.env.AWS_EXECUTION_ENV ||
process.env.KUBERNETES_SERVICE_HOST
);
console.log('IS_DOCKER env:', process.env.IS_DOCKER);
console.log('Docker detected:', isDocker);
console.log('Cloud environment:', isCloudEnvironment);
// Generate fingerprints
console.log('\n=== Fingerprint Generation ===\n');
const fingerprint1 = generateHostFingerprint();
const fingerprint2 = generateHostFingerprint();
const fingerprint3 = generateHostFingerprint();
console.log('\nFingerprint 1:', fingerprint1);
console.log('Fingerprint 2:', fingerprint2);
console.log('Fingerprint 3:', fingerprint3);
const consistent = fingerprint1 === fingerprint2 && fingerprint2 === fingerprint3;
console.log('\nConsistent:', consistent ? '✓ YES' : '✗ NO');
// Test explicit ID override
console.log('\n=== Environment Variable Override Test ===\n');
if (process.env.N8N_MCP_USER_ID) {
console.log('Explicit user ID:', process.env.N8N_MCP_USER_ID);
console.log('This would override the fingerprint');
} else {
console.log('No explicit user ID set');
console.log('To test: N8N_MCP_USER_ID=my-custom-id npx tsx ' + process.argv[1]);
}
// Stability estimate
console.log('\n=== Stability Analysis ===\n');
const hasStableSignals = existsSync('/proc/cpuinfo') || existsSync('/proc/meminfo');
if (hasStableSignals) {
console.log('✓ Host-based signals available');
console.log('✓ Fingerprint should be stable across container recreations');
console.log('✓ Different fingerprints on different physical hosts');
} else {
console.log('⚠️ Limited host signals (Windows/Mac Docker Desktop)');
console.log('⚠️ Fingerprint may not be fully stable');
console.log('💡 Recommendation: Use N8N_MCP_USER_ID env var for stability');
}
console.log('\n');

View File

@@ -1,119 +0,0 @@
/**
* Test User ID Persistence
* Verifies that user IDs are consistent across sessions and modes
*/
import { TelemetryConfigManager } from '../src/telemetry/config-manager';
import { hostname, platform, arch, homedir } from 'os';
import { createHash } from 'crypto';
console.log('=== User ID Persistence Test ===\n');
// Test 1: Verify deterministic ID generation
console.log('Test 1: Deterministic ID Generation');
console.log('-----------------------------------');
const machineId = `${hostname()}-${platform()}-${arch()}-${homedir()}`;
const expectedUserId = createHash('sha256')
.update(machineId)
.digest('hex')
.substring(0, 16);
console.log('Machine characteristics:');
console.log(' hostname:', hostname());
console.log(' platform:', platform());
console.log(' arch:', arch());
console.log(' homedir:', homedir());
console.log('\nGenerated machine ID:', machineId);
console.log('Expected user ID:', expectedUserId);
// Test 2: Load actual config
console.log('\n\nTest 2: Actual Config Manager');
console.log('-----------------------------------');
const configManager = TelemetryConfigManager.getInstance();
const actualUserId = configManager.getUserId();
const config = configManager.loadConfig();
console.log('Actual user ID:', actualUserId);
console.log('Config first run:', config.firstRun || 'Unknown');
console.log('Config version:', config.version || 'Unknown');
console.log('Telemetry enabled:', config.enabled);
// Test 3: Verify consistency
console.log('\n\nTest 3: Consistency Check');
console.log('-----------------------------------');
const match = actualUserId === expectedUserId;
console.log('User IDs match:', match ? '✓ YES' : '✗ NO');
if (!match) {
console.log('WARNING: User ID mismatch detected!');
console.log('This could indicate an implementation issue.');
}
// Test 4: Multiple loads (simulate multiple sessions)
console.log('\n\nTest 4: Multiple Session Simulation');
console.log('-----------------------------------');
const userId1 = configManager.getUserId();
const userId2 = TelemetryConfigManager.getInstance().getUserId();
const userId3 = configManager.getUserId();
console.log('Session 1 user ID:', userId1);
console.log('Session 2 user ID:', userId2);
console.log('Session 3 user ID:', userId3);
const consistent = userId1 === userId2 && userId2 === userId3;
console.log('All sessions consistent:', consistent ? '✓ YES' : '✗ NO');
// Test 5: Docker environment simulation
console.log('\n\nTest 5: Docker Environment Check');
console.log('-----------------------------------');
const isDocker = process.env.IS_DOCKER === 'true';
console.log('Running in Docker:', isDocker);
if (isDocker) {
console.log('\n⚠ DOCKER MODE DETECTED');
console.log('In Docker, user IDs may change across container recreations because:');
console.log(' 1. Container hostname changes each time');
console.log(' 2. Config file is not persisted (no volume mount)');
console.log(' 3. Each container gets a new ephemeral filesystem');
console.log('\nRecommendation: Mount ~/.n8n-mcp as a volume for persistent user IDs');
}
// Test 6: Environment variable override check
console.log('\n\nTest 6: Environment Variable Override');
console.log('-----------------------------------');
const telemetryDisabledVars = [
'N8N_MCP_TELEMETRY_DISABLED',
'TELEMETRY_DISABLED',
'DISABLE_TELEMETRY'
];
telemetryDisabledVars.forEach(varName => {
const value = process.env[varName];
if (value !== undefined) {
console.log(`${varName}:`, value);
}
});
console.log('\nTelemetry status:', configManager.isEnabled() ? 'ENABLED' : 'DISABLED');
// Summary
console.log('\n\n=== SUMMARY ===');
console.log('User ID:', actualUserId);
console.log('Deterministic:', match ? 'YES ✓' : 'NO ✗');
console.log('Persistent across sessions:', consistent ? 'YES ✓' : 'NO ✗');
console.log('Telemetry enabled:', config.enabled ? 'YES' : 'NO');
console.log('Docker mode:', isDocker ? 'YES' : 'NO');
if (isDocker && !process.env.N8N_MCP_CONFIG_VOLUME) {
console.log('\n⚠ WARNING: Running in Docker without persistent volume!');
console.log('User IDs will change on container recreation.');
console.log('Mount /home/nodejs/.n8n-mcp to persist telemetry config.');
}
console.log('\n');

View File

@@ -1,310 +0,0 @@
{
"description": "Canonical configuration examples for critical AI tools based on FINAL_AI_VALIDATION_SPEC.md",
"version": "1.0.0",
"examples": [
{
"node_type": "@n8n/n8n-nodes-langchain.toolHttpRequest",
"display_name": "HTTP Request Tool",
"examples": [
{
"name": "Weather API Tool",
"use_case": "Fetch current weather data for AI Agent",
"complexity": "simple",
"parameters": {
"method": "GET",
"url": "https://api.weatherapi.com/v1/current.json?key={{$credentials.weatherApiKey}}&q={city}",
"toolDescription": "Get current weather conditions for a city. Provide the city name (e.g., 'London', 'New York') and receive temperature, humidity, wind speed, and conditions.",
"placeholderDefinitions": {
"values": [
{
"name": "city",
"description": "Name of the city to get weather for",
"type": "string"
}
]
},
"authentication": "predefinedCredentialType",
"nodeCredentialType": "weatherApiApi"
},
"credentials": {
"weatherApiApi": {
"id": "1",
"name": "Weather API account"
}
},
"notes": "Example shows proper toolDescription, URL with placeholder, and credential configuration"
},
{
"name": "GitHub Issues Tool",
"use_case": "Create GitHub issues from AI Agent conversations",
"complexity": "medium",
"parameters": {
"method": "POST",
"url": "https://api.github.com/repos/{owner}/{repo}/issues",
"toolDescription": "Create a new GitHub issue. Requires owner (repo owner username), repo (repository name), title, and body. Returns the created issue URL and number.",
"placeholderDefinitions": {
"values": [
{
"name": "owner",
"description": "GitHub repository owner username",
"type": "string"
},
{
"name": "repo",
"description": "Repository name",
"type": "string"
},
{
"name": "title",
"description": "Issue title",
"type": "string"
},
{
"name": "body",
"description": "Issue description and details",
"type": "string"
}
]
},
"sendBody": true,
"specifyBody": "json",
"jsonBody": "={{ { \"title\": $json.title, \"body\": $json.body } }}",
"authentication": "predefinedCredentialType",
"nodeCredentialType": "githubApi"
},
"credentials": {
"githubApi": {
"id": "2",
"name": "GitHub credentials"
}
},
"notes": "Example shows POST request with JSON body, multiple placeholders, and expressions"
},
{
"name": "Slack Message Tool",
"use_case": "Send Slack messages from AI Agent",
"complexity": "simple",
"parameters": {
"method": "POST",
"url": "https://slack.com/api/chat.postMessage",
"toolDescription": "Send a message to a Slack channel. Provide channel ID or name (e.g., '#general', 'C1234567890') and message text.",
"placeholderDefinitions": {
"values": [
{
"name": "channel",
"description": "Channel ID or name (e.g., #general)",
"type": "string"
},
{
"name": "text",
"description": "Message text to send",
"type": "string"
}
]
},
"sendHeaders": true,
"headerParameters": {
"parameters": [
{
"name": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"name": "Authorization",
"value": "=Bearer {{$credentials.slackApi.accessToken}}"
}
]
},
"sendBody": true,
"specifyBody": "json",
"jsonBody": "={{ { \"channel\": $json.channel, \"text\": $json.text } }}",
"authentication": "predefinedCredentialType",
"nodeCredentialType": "slackApi"
},
"credentials": {
"slackApi": {
"id": "3",
"name": "Slack account"
}
},
"notes": "Example shows headers with credential expressions and JSON body construction"
}
]
},
{
"node_type": "@n8n/n8n-nodes-langchain.toolCode",
"display_name": "Code Tool",
"examples": [
{
"name": "Calculate Shipping Cost",
"use_case": "Calculate shipping costs based on weight and distance",
"complexity": "simple",
"parameters": {
"name": "calculate_shipping_cost",
"description": "Calculate shipping cost based on package weight (in kg) and distance (in km). Returns the cost in USD.",
"language": "javaScript",
"code": "const baseRate = 5;\nconst perKgRate = 2;\nconst perKmRate = 0.1;\n\nconst weight = $input.weight || 0;\nconst distance = $input.distance || 0;\n\nconst cost = baseRate + (weight * perKgRate) + (distance * perKmRate);\n\nreturn { cost: parseFloat(cost.toFixed(2)), currency: 'USD' };",
"specifyInputSchema": true,
"schemaType": "manual",
"inputSchema": "{\n \"type\": \"object\",\n \"properties\": {\n \"weight\": {\n \"type\": \"number\",\n \"description\": \"Package weight in kilograms\"\n },\n \"distance\": {\n \"type\": \"number\",\n \"description\": \"Shipping distance in kilometers\"\n }\n },\n \"required\": [\"weight\", \"distance\"]\n}"
},
"notes": "Example shows proper function naming, detailed description, input schema, and return value"
},
{
"name": "Format Customer Data",
"use_case": "Transform and validate customer information",
"complexity": "medium",
"parameters": {
"name": "format_customer_data",
"description": "Format and validate customer data. Takes raw customer info (name, email, phone) and returns formatted object with validation status.",
"language": "javaScript",
"code": "const { name, email, phone } = $input;\n\n// Validation\nconst emailRegex = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\nconst phoneRegex = /^\\+?[1-9]\\d{1,14}$/;\n\nconst errors = [];\nif (!emailRegex.test(email)) errors.push('Invalid email format');\nif (!phoneRegex.test(phone)) errors.push('Invalid phone format');\n\n// Formatting\nconst formatted = {\n name: name.trim(),\n email: email.toLowerCase().trim(),\n phone: phone.replace(/\\s/g, ''),\n valid: errors.length === 0,\n errors: errors\n};\n\nreturn formatted;",
"specifyInputSchema": true,
"schemaType": "manual",
"inputSchema": "{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Customer full name\"\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"Customer email address\"\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Customer phone number\"\n }\n },\n \"required\": [\"name\", \"email\", \"phone\"]\n}"
},
"notes": "Example shows data validation, formatting, and structured error handling"
},
{
"name": "Parse Date Range",
"use_case": "Convert natural language date ranges to ISO format",
"complexity": "medium",
"parameters": {
"name": "parse_date_range",
"description": "Parse natural language date ranges (e.g., 'last 7 days', 'this month', 'Q1 2024') into start and end dates in ISO format.",
"language": "javaScript",
"code": "const input = $input.dateRange || '';\nconst now = new Date();\nlet start, end;\n\nif (input.includes('last') && input.includes('days')) {\n const days = parseInt(input.match(/\\d+/)[0]);\n start = new Date(now.getTime() - (days * 24 * 60 * 60 * 1000));\n end = now;\n} else if (input === 'this month') {\n start = new Date(now.getFullYear(), now.getMonth(), 1);\n end = new Date(now.getFullYear(), now.getMonth() + 1, 0);\n} else if (input === 'this year') {\n start = new Date(now.getFullYear(), 0, 1);\n end = new Date(now.getFullYear(), 11, 31);\n} else {\n throw new Error('Unsupported date range format');\n}\n\nreturn {\n startDate: start.toISOString().split('T')[0],\n endDate: end.toISOString().split('T')[0],\n daysCount: Math.ceil((end - start) / (24 * 60 * 60 * 1000))\n};",
"specifyInputSchema": true,
"schemaType": "manual",
"inputSchema": "{\n \"type\": \"object\",\n \"properties\": {\n \"dateRange\": {\n \"type\": \"string\",\n \"description\": \"Natural language date range (e.g., 'last 7 days', 'this month')\"\n }\n },\n \"required\": [\"dateRange\"]\n}"
},
"notes": "Example shows complex logic, error handling, and date manipulation"
}
]
},
{
"node_type": "@n8n/n8n-nodes-langchain.agentTool",
"display_name": "AI Agent Tool",
"examples": [
{
"name": "Research Specialist Agent",
"use_case": "Specialized sub-agent for in-depth research tasks",
"complexity": "medium",
"parameters": {
"name": "research_specialist",
"description": "Expert research agent that can search multiple sources, synthesize information, and provide comprehensive analysis on any topic. Use this when you need detailed, well-researched information.",
"promptType": "define",
"text": "You are a research specialist. Your role is to:\n1. Search for relevant information from multiple sources\n2. Synthesize findings into a coherent analysis\n3. Cite your sources\n4. Highlight key insights and patterns\n\nProvide thorough, well-structured research that answers the user's question comprehensively.",
"systemMessage": "You are a meticulous researcher focused on accuracy and completeness. Always cite sources and acknowledge limitations in available information."
},
"connections": {
"ai_languageModel": [
{
"node": "OpenAI GPT-4",
"type": "ai_languageModel",
"index": 0
}
],
"ai_tool": [
{
"node": "SerpApi Tool",
"type": "ai_tool",
"index": 0
},
{
"node": "Wikipedia Tool",
"type": "ai_tool",
"index": 0
}
]
},
"notes": "Example shows specialized sub-agent with custom prompt, specific system message, and multiple search tools"
},
{
"name": "Data Analysis Agent",
"use_case": "Sub-agent for analyzing and visualizing data",
"complexity": "complex",
"parameters": {
"name": "data_analyst",
"description": "Data analysis specialist that can process datasets, calculate statistics, identify trends, and generate insights. Use for any data analysis or statistical questions.",
"promptType": "auto",
"systemMessage": "You are a data analyst with expertise in statistics and data interpretation. Break down complex datasets into understandable insights. Use the Code Tool to perform calculations when needed.",
"maxIterations": 10
},
"connections": {
"ai_languageModel": [
{
"node": "Anthropic Claude",
"type": "ai_languageModel",
"index": 0
}
],
"ai_tool": [
{
"node": "Code Tool - Stats",
"type": "ai_tool",
"index": 0
},
{
"node": "HTTP Request Tool - Data API",
"type": "ai_tool",
"index": 0
}
]
},
"notes": "Example shows auto prompt type with specialized system message and analytical tools"
}
]
},
{
"node_type": "@n8n/n8n-nodes-langchain.mcpClientTool",
"display_name": "MCP Client Tool",
"examples": [
{
"name": "Filesystem MCP Tool",
"use_case": "Access filesystem operations via MCP protocol",
"complexity": "medium",
"parameters": {
"description": "Access file system operations through MCP. Can read files, list directories, create files, and search for content.",
"mcpServer": {
"transport": "stdio",
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/directory"]
},
"tool": "read_file"
},
"notes": "Example shows stdio transport MCP server with filesystem access tool"
},
{
"name": "Puppeteer MCP Tool",
"use_case": "Browser automation via MCP for AI Agents",
"complexity": "complex",
"parameters": {
"description": "Control a web browser to navigate pages, take screenshots, and extract content. Useful for web scraping and automated testing.",
"mcpServer": {
"transport": "stdio",
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-puppeteer"]
},
"tool": "puppeteer_navigate"
},
"notes": "Example shows Puppeteer MCP server for browser automation"
},
{
"name": "Database MCP Tool",
"use_case": "Query databases via MCP protocol",
"complexity": "complex",
"parameters": {
"description": "Execute SQL queries and retrieve data from PostgreSQL databases. Supports SELECT, INSERT, UPDATE operations with proper escaping.",
"mcpServer": {
"transport": "sse",
"url": "https://mcp-server.example.com/database"
},
"tool": "execute_query"
},
"notes": "Example shows SSE transport MCP server for remote database access"
}
]
}
]
}

View File

@@ -232,45 +232,15 @@ class BetterSQLiteAdapter implements DatabaseAdapter {
*/
class SQLJSAdapter implements DatabaseAdapter {
private saveTimer: NodeJS.Timeout | null = null;
private saveIntervalMs: number;
private closed = false; // Prevent multiple close() calls
// Default save interval: 5 seconds (balance between data safety and performance)
// Configurable via SQLJS_SAVE_INTERVAL_MS environment variable
//
// DATA LOSS WINDOW: Up to 5 seconds of database changes may be lost if process
// crashes before scheduleSave() timer fires. This is acceptable because:
// 1. close() calls saveToFile() immediately on graceful shutdown
// 2. Docker/Kubernetes SIGTERM provides 30s for cleanup (more than enough)
// 3. The alternative (100ms interval) caused 2.2GB memory leaks in production
// 4. MCP server is primarily read-heavy (writes are rare)
private static readonly DEFAULT_SAVE_INTERVAL_MS = 5000;
constructor(private db: any, private dbPath: string) {
// Read save interval from environment or use default
const envInterval = process.env.SQLJS_SAVE_INTERVAL_MS;
this.saveIntervalMs = envInterval ? parseInt(envInterval, 10) : SQLJSAdapter.DEFAULT_SAVE_INTERVAL_MS;
// Validate interval (minimum 100ms, maximum 60000ms = 1 minute)
if (isNaN(this.saveIntervalMs) || this.saveIntervalMs < 100 || this.saveIntervalMs > 60000) {
logger.warn(
`Invalid SQLJS_SAVE_INTERVAL_MS value: ${envInterval} (must be 100-60000ms), ` +
`using default ${SQLJSAdapter.DEFAULT_SAVE_INTERVAL_MS}ms`
);
this.saveIntervalMs = SQLJSAdapter.DEFAULT_SAVE_INTERVAL_MS;
}
logger.debug(`SQLJSAdapter initialized with save interval: ${this.saveIntervalMs}ms`);
// NOTE: No initial save scheduled here (optimization)
// Database is either:
// 1. Loaded from existing file (already persisted), or
// 2. New database (will be saved on first write operation)
// Set up auto-save on changes
this.scheduleSave();
}
prepare(sql: string): PreparedStatement {
const stmt = this.db.prepare(sql);
// Don't schedule save on prepare - only on actual writes (via SQLJSStatement.run())
this.scheduleSave();
return new SQLJSStatement(stmt, () => this.scheduleSave());
}
@@ -280,18 +250,11 @@ class SQLJSAdapter implements DatabaseAdapter {
}
close(): void {
if (this.closed) {
logger.debug('SQLJSAdapter already closed, skipping');
return;
}
this.saveToFile();
if (this.saveTimer) {
clearTimeout(this.saveTimer);
this.saveTimer = null;
}
this.db.close();
this.closed = true;
}
pragma(key: string, value?: any): any {
@@ -338,32 +301,19 @@ class SQLJSAdapter implements DatabaseAdapter {
if (this.saveTimer) {
clearTimeout(this.saveTimer);
}
// Save after configured interval of inactivity (default: 5000ms)
// This debouncing reduces memory churn from frequent buffer allocations
//
// NOTE: Under constant write load, saves may be delayed until writes stop.
// This is acceptable because:
// 1. MCP server is primarily read-heavy (node lookups, searches)
// 2. Writes are rare (only during database rebuilds)
// 3. close() saves immediately on shutdown, flushing any pending changes
// Save after 100ms of inactivity
this.saveTimer = setTimeout(() => {
this.saveToFile();
}, this.saveIntervalMs);
}, 100);
}
private saveToFile(): void {
try {
// Export database to Uint8Array (2-5MB typical)
const data = this.db.export();
// Write directly without Buffer.from() copy (saves 50% memory allocation)
// writeFileSync accepts Uint8Array directly, no need for Buffer conversion
fsSync.writeFileSync(this.dbPath, data);
const buffer = Buffer.from(data);
fsSync.writeFileSync(this.dbPath, buffer);
logger.debug(`Database saved to ${this.dbPath}`);
// Note: 'data' reference is automatically cleared when function exits
// V8 GC will reclaim the Uint8Array once it's no longer referenced
} catch (error) {
logger.error('Failed to save database', error);
}

View File

@@ -7,12 +7,11 @@ export class NodeRepository {
private db: DatabaseAdapter;
constructor(dbOrService: DatabaseAdapter | SQLiteStorageService) {
if (dbOrService instanceof SQLiteStorageService) {
if ('db' in dbOrService) {
this.db = dbOrService.db;
return;
} else {
this.db = dbOrService;
}
this.db = dbOrService;
}
/**
@@ -123,22 +122,10 @@ export class NodeRepository {
return rows.map(row => this.parseNodeRow(row));
}
/**
* Legacy LIKE-based search method for direct repository usage.
*
* NOTE: MCP tools do NOT use this method. They use MCPServer.searchNodes()
* which automatically detects and uses FTS5 full-text search when available.
* See src/mcp/server.ts:1135-1148 for FTS5 implementation.
*
* This method remains for:
* - Direct repository access in scripts/benchmarks
* - Fallback when FTS5 table doesn't exist
* - Legacy compatibility
*/
searchNodes(query: string, mode: 'OR' | 'AND' | 'FUZZY' = 'OR', limit: number = 20): any[] {
let sql = '';
const params: any[] = [];
if (mode === 'FUZZY') {
// Simple fuzzy search
sql = `

View File

@@ -25,40 +25,6 @@ CREATE INDEX IF NOT EXISTS idx_package ON nodes(package_name);
CREATE INDEX IF NOT EXISTS idx_ai_tool ON nodes(is_ai_tool);
CREATE INDEX IF NOT EXISTS idx_category ON nodes(category);
-- FTS5 full-text search index for nodes
CREATE VIRTUAL TABLE IF NOT EXISTS nodes_fts USING fts5(
node_type,
display_name,
description,
documentation,
operations,
content=nodes,
content_rowid=rowid
);
-- Triggers to keep FTS5 in sync with nodes table
CREATE TRIGGER IF NOT EXISTS nodes_fts_insert AFTER INSERT ON nodes
BEGIN
INSERT INTO nodes_fts(rowid, node_type, display_name, description, documentation, operations)
VALUES (new.rowid, new.node_type, new.display_name, new.description, new.documentation, new.operations);
END;
CREATE TRIGGER IF NOT EXISTS nodes_fts_update AFTER UPDATE ON nodes
BEGIN
UPDATE nodes_fts
SET node_type = new.node_type,
display_name = new.display_name,
description = new.description,
documentation = new.documentation,
operations = new.operations
WHERE rowid = new.rowid;
END;
CREATE TRIGGER IF NOT EXISTS nodes_fts_delete AFTER DELETE ON nodes
BEGIN
DELETE FROM nodes_fts WHERE rowid = old.rowid;
END;
-- Templates table for n8n workflow templates
CREATE TABLE IF NOT EXISTS templates (
id INTEGER PRIMARY KEY,
@@ -142,6 +108,5 @@ FROM template_node_configs
WHERE rank <= 5 -- Top 5 per node type
ORDER BY node_type, rank;
-- Note: Template FTS5 tables are created conditionally at runtime if FTS5 is supported
-- See template-repository.ts initializeFTS5() method
-- Node FTS5 table (nodes_fts) is created above during schema initialization
-- Note: FTS5 tables are created conditionally at runtime if FTS5 is supported
-- See template-repository.ts initializeFTS5() method

View File

@@ -6,6 +6,7 @@
*/
import express from 'express';
import rateLimit from 'express-rate-limit';
import helmet from 'helmet';
import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
import { N8NDocumentationMCPServer } from './mcp/server';
@@ -188,22 +189,11 @@ export class SingleSessionHTTPServer {
/**
* Validate session ID format
*
* Accepts any non-empty string to support various MCP clients:
* - UUIDv4 (internal n8n-mcp format)
* - instance-{userId}-{hash}-{uuid} (multi-tenant format)
* - Custom formats from mcp-remote and other proxies
*
* Security: Session validation happens via lookup in this.transports,
* not format validation. This ensures compatibility with all MCP clients.
*
* @param sessionId - Session identifier from MCP client
* @returns true if valid, false otherwise
*/
private isValidSessionId(sessionId: string): boolean {
// Accept any non-empty string as session ID
// This ensures compatibility with all MCP clients and proxies
return Boolean(sessionId && sessionId.length > 0);
// UUID v4 format validation
const uuidv4Regex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
return uuidv4Regex.test(sessionId);
}
/**
@@ -688,9 +678,11 @@ export class SingleSessionHTTPServer {
*/
async start(): Promise<void> {
const app = express();
// Create JSON parser middleware for endpoints that need it
const jsonParser = express.json({ limit: '10mb' });
// SECURITY: Limit request body size to prevent resource exhaustion
// See: https://github.com/czlonkowski/n8n-mcp/issues/265 (MEDIUM-02)
const jsonParser = express.json({ limit: '1mb' });
// Configure trust proxy for correct IP logging behind reverse proxies
const trustProxy = process.env.TRUST_PROXY ? Number(process.env.TRUST_PROXY) : 0;
@@ -701,15 +693,60 @@ export class SingleSessionHTTPServer {
// DON'T use any body parser globally - StreamableHTTPServerTransport needs raw stream
// Only use JSON parser for specific endpoints that need it
// Security headers
// SECURITY: Limit URL length to prevent buffer overflow attacks
// See: https://github.com/czlonkowski/n8n-mcp/issues/265 (MEDIUM-02)
app.use((req, res, next) => {
res.setHeader('X-Content-Type-Options', 'nosniff');
res.setHeader('X-Frame-Options', 'DENY');
res.setHeader('X-XSS-Protection', '1; mode=block');
res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains');
if (req.url.length > 2048) {
logger.warn('Request rejected: URL too long', {
urlLength: req.url.length,
ip: req.ip,
userAgent: req.get('user-agent'),
event: 'input_validation_failure'
});
return res.status(414).json({
jsonrpc: '2.0',
error: { code: -32600, message: 'URI Too Long' },
id: null
});
}
next();
});
// SECURITY: Comprehensive security headers via helmet
// See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-08)
app.use(helmet({
contentSecurityPolicy: {
directives: {
defaultSrc: ["'self'"],
scriptSrc: ["'self'"],
styleSrc: ["'self'", "'unsafe-inline'"],
imgSrc: ["'self'", "data:", "https:"],
connectSrc: ["'self'"],
fontSrc: ["'self'"],
objectSrc: ["'none'"],
mediaSrc: ["'self'"],
frameSrc: ["'none'"],
},
},
referrerPolicy: { policy: 'strict-origin-when-cross-origin' },
hsts: {
maxAge: 31536000,
includeSubDomains: true,
preload: true
},
permissionsPolicy: {
features: {
camera: ["'none'"],
microphone: ["'none'"],
geolocation: ["'none'"],
payment: ["'none'"]
}
}
}));
// Remove X-Powered-By header
app.disable('x-powered-by');
// CORS configuration
app.use((req, res, next) => {
@@ -1224,17 +1261,19 @@ export class SingleSessionHTTPServer {
});
});
// Error handler
// SECURITY: Error handler with sanitization
// See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-04)
app.use((err: any, req: express.Request, res: express.Response, next: express.NextFunction) => {
logger.error('Express error handler:', err);
if (!res.headersSent) {
res.status(500).json({
// Use sanitizeErrorForClient() to ensure no stack traces or internal details leak
const sanitized = this.sanitizeErrorForClient(err);
res.status(500).json({
jsonrpc: '2.0',
error: {
code: -32603,
message: 'Internal server error',
data: process.env.NODE_ENV === 'development' ? err.message : undefined
message: sanitized.message
},
id: null
});

View File

@@ -23,17 +23,6 @@ import {
dotenv.config();
/**
* MCP tool response format with optional structured content
*/
interface MCPToolResponse {
content: Array<{
type: 'text';
text: string;
}>;
structuredContent?: unknown;
}
let expressServer: any;
let authToken: string | null = null;
@@ -412,46 +401,19 @@ export async function startFixedHTTPServer() {
// Delegate to the MCP server
const toolName = jsonRpcRequest.params?.name;
const toolArgs = jsonRpcRequest.params?.arguments || {};
try {
const result = await mcpServer.executeTool(toolName, toolArgs);
// Convert result to JSON text for content field
let responseText = JSON.stringify(result, null, 2);
// Build MCP-compliant response with structuredContent for validation tools
const mcpResult: MCPToolResponse = {
content: [
{
type: 'text',
text: responseText
}
]
};
// Add structuredContent for validation tools (they have outputSchema)
// Apply 1MB safety limit to prevent memory issues (matches STDIO server behavior)
if (toolName.startsWith('validate_')) {
const resultSize = responseText.length;
if (resultSize > 1000000) {
// Response is too large - truncate and warn
logger.warn(
`Validation tool ${toolName} response is very large (${resultSize} chars). ` +
`Truncating for HTTP transport safety.`
);
mcpResult.content[0].text = responseText.substring(0, 999000) +
'\n\n[Response truncated due to size limits]';
// Don't include structuredContent for truncated responses
} else {
// Normal case - include structured content for MCP protocol compliance
mcpResult.structuredContent = result;
}
}
response = {
jsonrpc: '2.0',
result: mcpResult,
result: {
content: [
{
type: 'text',
text: JSON.stringify(result, null, 2)
}
]
},
id: jsonRpcRequest.id
};
} catch (error) {

View File

@@ -10,22 +10,6 @@ export { SingleSessionHTTPServer } from './http-server-single-session';
export { ConsoleManager } from './utils/console-manager';
export { N8NDocumentationMCPServer } from './mcp/server';
// Type exports for multi-tenant and library usage
export type {
InstanceContext
} from './types/instance-context';
export {
validateInstanceContext,
isInstanceContext
} from './types/instance-context';
// Re-export MCP SDK types for convenience
export type {
Tool,
CallToolResult,
ListToolsResult
} from '@modelcontextprotocol/sdk/types.js';
// Default export for convenience
import N8NMCPEngine from './mcp-engine';
export default N8NMCPEngine;

View File

@@ -62,12 +62,8 @@ export class MCPEngine {
hiddenProperties: []
};
}
// CRITICAL FIX: Extract user-provided keys before validation
// This prevents false warnings about default values
const userProvidedKeys = new Set(Object.keys(args.config || {}));
return ConfigValidator.validate(args.nodeType, args.config, node.properties || [], userProvidedKeys);
return ConfigValidator.validate(args.nodeType, args.config, node.properties || []);
}
async validateNodeMinimal(args: any) {

View File

@@ -30,7 +30,7 @@ import { NodeRepository } from '../database/node-repository';
import { InstanceContext, validateInstanceContext } from '../types/instance-context';
import { NodeTypeNormalizer } from '../utils/node-type-normalizer';
import { WorkflowAutoFixer, AutoFixConfig } from '../services/workflow-auto-fixer';
import { ExpressionFormatValidator, ExpressionFormatIssue } from '../services/expression-format-validator';
import { ExpressionFormatValidator } from '../services/expression-format-validator';
import { handleUpdatePartialWorkflow } from './handlers-workflow-diff';
import { telemetry } from '../telemetry';
import {
@@ -42,145 +42,7 @@ import {
getCacheStatistics
} from '../utils/cache-utils';
import { processExecution } from '../services/execution-processor';
import { checkNpmVersion, formatVersionMessage } from '../utils/npm-version-checker';
// ========================================================================
// TypeScript Interfaces for Type Safety
// ========================================================================
/**
* Health Check Response Data Structure
*/
interface HealthCheckResponseData {
status: string;
instanceId?: string;
n8nVersion?: string;
features?: Record<string, unknown>;
apiUrl?: string;
mcpVersion: string;
supportedN8nVersion?: string;
versionCheck: {
current: string;
latest: string | null;
upToDate: boolean;
message: string;
updateCommand?: string;
};
performance: {
responseTimeMs: number;
cacheHitRate: string;
cachedInstances: number;
};
nextSteps?: string[];
updateWarning?: string;
}
/**
* Cloud Platform Guide Structure
*/
interface CloudPlatformGuide {
name: string;
troubleshooting: string[];
}
/**
* Workflow Validation Response Data
*/
interface WorkflowValidationResponse {
valid: boolean;
workflowId?: string;
workflowName?: string;
summary: {
totalNodes: number;
enabledNodes: number;
triggerNodes: number;
validConnections: number;
invalidConnections: number;
expressionsValidated: number;
errorCount: number;
warningCount: number;
};
errors?: Array<{
node: string;
nodeName?: string;
message: string;
details?: Record<string, unknown>;
}>;
warnings?: Array<{
node: string;
nodeName?: string;
message: string;
details?: Record<string, unknown>;
}>;
suggestions?: unknown[];
}
/**
* Diagnostic Response Data Structure
*/
interface DiagnosticResponseData {
timestamp: string;
environment: {
N8N_API_URL: string | null;
N8N_API_KEY: string | null;
NODE_ENV: string;
MCP_MODE: string;
isDocker: boolean;
cloudPlatform: string | null;
nodeVersion: string;
platform: string;
};
apiConfiguration: {
configured: boolean;
status: {
configured: boolean;
connected: boolean;
error: string | null;
version: string | null;
};
config: {
baseUrl: string;
timeout: number;
maxRetries: number;
} | null;
};
versionInfo: {
current: string;
latest: string | null;
upToDate: boolean;
message: string;
updateCommand?: string;
};
toolsAvailability: {
documentationTools: {
count: number;
enabled: boolean;
description: string;
};
managementTools: {
count: number;
enabled: boolean;
description: string;
};
totalAvailable: number;
};
performance: {
diagnosticResponseTimeMs: number;
cacheHitRate: string;
cachedInstances: number;
};
modeSpecificDebug: Record<string, unknown>;
dockerDebug?: Record<string, unknown>;
cloudPlatformDebug?: CloudPlatformGuide;
nextSteps?: Record<string, unknown>;
troubleshooting?: Record<string, unknown>;
setupGuide?: Record<string, unknown>;
updateWarning?: Record<string, unknown>;
debug?: Record<string, unknown>;
[key: string]: unknown; // Allow dynamic property access for optional fields
}
// ========================================================================
// Singleton n8n API client instance (backward compatibility)
let defaultApiClient: N8nApiClient | null = null;
let lastDefaultConfigUrl: string | null = null;
@@ -869,7 +731,7 @@ export async function handleValidateWorkflow(
const validationResult = await validator.validateWorkflow(workflow, input.options);
// Format the response (same format as the regular validate_workflow tool)
const response: WorkflowValidationResponse = {
const response: any = {
valid: validationResult.valid,
workflowId: workflow.id,
workflowName: workflow.name,
@@ -888,16 +750,14 @@ export async function handleValidateWorkflow(
if (validationResult.errors.length > 0) {
response.errors = validationResult.errors.map(e => ({
node: e.nodeName || 'workflow',
nodeName: e.nodeName, // Also set nodeName for compatibility
message: e.message,
details: e.details
}));
}
if (validationResult.warnings.length > 0) {
response.warnings = validationResult.warnings.map(w => ({
node: w.nodeName || 'workflow',
nodeName: w.nodeName, // Also set nodeName for compatibility
message: w.message,
details: w.details
}));
@@ -970,7 +830,7 @@ export async function handleAutofixWorkflow(
});
// Check for expression format issues
const allFormatIssues: ExpressionFormatIssue[] = [];
const allFormatIssues: any[] = [];
for (const node of workflow.nodes) {
const formatContext = {
nodeType: node.type,
@@ -1364,86 +1224,29 @@ export async function handleDeleteExecution(args: unknown, context?: InstanceCon
// System Tools Handlers
export async function handleHealthCheck(context?: InstanceContext): Promise<McpToolResponse> {
const startTime = Date.now();
try {
const client = ensureApiConfigured(context);
const health = await client.healthCheck();
// Get MCP version from package.json
const packageJson = require('../../package.json');
const mcpVersion = packageJson.version;
const supportedN8nVersion = packageJson.dependencies?.n8n?.replace(/[^0-9.]/g, '');
// Check npm for latest version (async, non-blocking)
const versionCheck = await checkNpmVersion();
// Get cache metrics for performance monitoring
const cacheMetricsData = getInstanceCacheMetrics();
// Calculate response time
const responseTime = Date.now() - startTime;
// Build response data
const responseData: HealthCheckResponseData = {
status: health.status,
instanceId: health.instanceId,
n8nVersion: health.n8nVersion,
features: health.features,
apiUrl: getN8nApiConfig()?.baseUrl,
mcpVersion,
supportedN8nVersion,
versionCheck: {
current: versionCheck.currentVersion,
latest: versionCheck.latestVersion,
upToDate: !versionCheck.isOutdated,
message: formatVersionMessage(versionCheck),
...(versionCheck.updateCommand ? { updateCommand: versionCheck.updateCommand } : {})
},
performance: {
responseTimeMs: responseTime,
cacheHitRate: (cacheMetricsData.hits + cacheMetricsData.misses) > 0
? ((cacheMetricsData.hits / (cacheMetricsData.hits + cacheMetricsData.misses)) * 100).toFixed(2) + '%'
: 'N/A',
cachedInstances: cacheMetricsData.size
}
};
// Add next steps guidance based on telemetry insights
responseData.nextSteps = [
'• Create workflow: n8n_create_workflow',
'• List workflows: n8n_list_workflows',
'• Search nodes: search_nodes',
'• Browse templates: search_templates'
];
// Add update warning if outdated
if (versionCheck.isOutdated && versionCheck.latestVersion) {
responseData.updateWarning = `⚠️ n8n-mcp v${versionCheck.latestVersion} is available (you have v${versionCheck.currentVersion}). Update recommended.`;
}
// Track result in telemetry
telemetry.trackEvent('health_check_completed', {
success: true,
responseTimeMs: responseTime,
upToDate: !versionCheck.isOutdated,
apiConnected: true
});
return {
success: true,
data: responseData
data: {
status: health.status,
instanceId: health.instanceId,
n8nVersion: health.n8nVersion,
features: health.features,
apiUrl: getN8nApiConfig()?.baseUrl,
mcpVersion,
supportedN8nVersion,
versionNote: 'AI Agent: Please inform the user to verify their n8n instance version matches or is compatible with the supported version listed above. The n8n API currently does not expose version information, so manual verification is required.'
}
};
} catch (error) {
const responseTime = Date.now() - startTime;
// Track failure in telemetry
telemetry.trackEvent('health_check_failed', {
success: false,
responseTimeMs: responseTime,
errorType: error instanceof N8nApiError ? error.code : 'unknown'
});
if (error instanceof N8nApiError) {
return {
success: false,
@@ -1451,17 +1254,11 @@ export async function handleHealthCheck(context?: InstanceContext): Promise<McpT
code: error.code,
details: {
apiUrl: getN8nApiConfig()?.baseUrl,
hint: 'Check if n8n is running and API is enabled',
troubleshooting: [
'1. Verify n8n instance is running',
'2. Check N8N_API_URL is correct',
'3. Verify N8N_API_KEY has proper permissions',
'4. Run n8n_diagnostic for detailed analysis'
]
hint: 'Check if n8n is running and API is enabled'
}
};
}
return {
success: false,
error: error instanceof Error ? error.message : 'Unknown error occurred'
@@ -1527,208 +1324,23 @@ export async function handleListAvailableTools(context?: InstanceContext): Promi
};
}
// Environment-aware debugging helpers
/**
* Detect cloud platform from environment variables
* Returns platform name or null if not in cloud
*/
function detectCloudPlatform(): string | null {
if (process.env.RAILWAY_ENVIRONMENT) return 'railway';
if (process.env.RENDER) return 'render';
if (process.env.FLY_APP_NAME) return 'fly';
if (process.env.HEROKU_APP_NAME) return 'heroku';
if (process.env.AWS_EXECUTION_ENV) return 'aws';
if (process.env.KUBERNETES_SERVICE_HOST) return 'kubernetes';
if (process.env.GOOGLE_CLOUD_PROJECT) return 'gcp';
if (process.env.AZURE_FUNCTIONS_ENVIRONMENT) return 'azure';
return null;
}
/**
* Get mode-specific debugging suggestions
*/
function getModeSpecificDebug(mcpMode: string) {
if (mcpMode === 'http') {
const port = process.env.MCP_PORT || process.env.PORT || 3000;
return {
mode: 'HTTP Server',
port,
authTokenConfigured: !!(process.env.MCP_AUTH_TOKEN || process.env.AUTH_TOKEN),
corsEnabled: true,
serverUrl: `http://localhost:${port}`,
healthCheckUrl: `http://localhost:${port}/health`,
troubleshooting: [
`1. Test server health: curl http://localhost:${port}/health`,
'2. Check browser console for CORS errors',
'3. Verify MCP_AUTH_TOKEN or AUTH_TOKEN if authentication enabled',
`4. Ensure port ${port} is not in use: lsof -i :${port} (macOS/Linux) or netstat -ano | findstr :${port} (Windows)`,
'5. Check firewall settings for port access',
'6. Review server logs for connection errors'
],
commonIssues: [
'CORS policy blocking browser requests',
'Port already in use by another application',
'Authentication token mismatch',
'Network firewall blocking connections'
]
};
} else {
// stdio mode
const configLocation = process.platform === 'darwin'
? '~/Library/Application Support/Claude/claude_desktop_config.json'
: process.platform === 'win32'
? '%APPDATA%\\Claude\\claude_desktop_config.json'
: '~/.config/Claude/claude_desktop_config.json';
return {
mode: 'Standard I/O (Claude Desktop)',
configLocation,
troubleshooting: [
'1. Verify Claude Desktop config file exists and is valid JSON',
'2. Check MCP server entry: {"mcpServers": {"n8n": {"command": "npx", "args": ["-y", "n8n-mcp"]}}}',
'3. Restart Claude Desktop after config changes',
'4. Check Claude Desktop logs for startup errors',
'5. Test npx can run: npx -y n8n-mcp --version',
'6. Verify executable permissions if using local installation'
],
commonIssues: [
'Invalid JSON in claude_desktop_config.json',
'Incorrect command or args in MCP server config',
'Claude Desktop not restarted after config changes',
'npx unable to download or run package',
'Missing execute permissions on local binary'
]
};
}
}
/**
* Get Docker-specific debugging suggestions
*/
function getDockerDebug(isDocker: boolean) {
if (!isDocker) return null;
return {
containerDetected: true,
troubleshooting: [
'1. Verify volume mounts for data/nodes.db',
'2. Check network connectivity to n8n instance',
'3. Ensure ports are correctly mapped',
'4. Review container logs: docker logs <container-name>',
'5. Verify environment variables passed to container',
'6. Check IS_DOCKER=true is set correctly'
],
commonIssues: [
'Volume mount not persisting database',
'Network isolation preventing n8n API access',
'Port mapping conflicts',
'Missing environment variables in container'
]
};
}
/**
* Get cloud platform-specific suggestions
*/
function getCloudPlatformDebug(cloudPlatform: string | null) {
if (!cloudPlatform) return null;
const platformGuides: Record<string, CloudPlatformGuide> = {
railway: {
name: 'Railway',
troubleshooting: [
'1. Check Railway environment variables are set',
'2. Verify deployment logs in Railway dashboard',
'3. Ensure PORT matches Railway assigned port (automatic)',
'4. Check networking configuration for external access'
]
},
render: {
name: 'Render',
troubleshooting: [
'1. Verify Render environment variables',
'2. Check Render logs for startup errors',
'3. Ensure health check endpoint is responding',
'4. Verify instance type has sufficient resources'
]
},
fly: {
name: 'Fly.io',
troubleshooting: [
'1. Check Fly.io logs: flyctl logs',
'2. Verify fly.toml configuration',
'3. Ensure volumes are properly mounted',
'4. Check app status: flyctl status'
]
},
heroku: {
name: 'Heroku',
troubleshooting: [
'1. Check Heroku logs: heroku logs --tail',
'2. Verify Procfile configuration',
'3. Ensure dynos are running: heroku ps',
'4. Check environment variables: heroku config'
]
},
kubernetes: {
name: 'Kubernetes',
troubleshooting: [
'1. Check pod logs: kubectl logs <pod-name>',
'2. Verify service and ingress configuration',
'3. Check persistent volume claims',
'4. Verify resource limits and requests'
]
},
aws: {
name: 'AWS',
troubleshooting: [
'1. Check CloudWatch logs',
'2. Verify IAM roles and permissions',
'3. Check security groups and networking',
'4. Verify environment variables in service config'
]
}
};
return platformGuides[cloudPlatform] || {
name: cloudPlatform.toUpperCase(),
troubleshooting: [
'1. Check cloud platform logs',
'2. Verify environment variables are set',
'3. Check networking and port configuration',
'4. Review platform-specific documentation'
]
};
}
// Handler: n8n_diagnostic
export async function handleDiagnostic(request: any, context?: InstanceContext): Promise<McpToolResponse> {
const startTime = Date.now();
const verbose = request.params?.arguments?.verbose || false;
// Detect environment for targeted debugging
const mcpMode = process.env.MCP_MODE || 'stdio';
const isDocker = process.env.IS_DOCKER === 'true';
const cloudPlatform = detectCloudPlatform();
// Check environment variables
const envVars = {
N8N_API_URL: process.env.N8N_API_URL || null,
N8N_API_KEY: process.env.N8N_API_KEY ? '***configured***' : null,
NODE_ENV: process.env.NODE_ENV || 'production',
MCP_MODE: mcpMode,
isDocker,
cloudPlatform,
nodeVersion: process.version,
platform: process.platform
MCP_MODE: process.env.MCP_MODE || 'stdio'
};
// Check API configuration
const apiConfig = getN8nApiConfig();
const apiConfigured = apiConfig !== null;
const apiClient = getN8nApiClient(context);
// Test API connectivity if configured
let apiStatus = {
configured: apiConfigured,
@@ -1736,7 +1348,7 @@ export async function handleDiagnostic(request: any, context?: InstanceContext):
error: null as string | null,
version: null as string | null
};
if (apiClient) {
try {
const health = await apiClient.healthCheck();
@@ -1746,21 +1358,14 @@ export async function handleDiagnostic(request: any, context?: InstanceContext):
apiStatus.error = error instanceof Error ? error.message : 'Unknown error';
}
}
// Check which tools are available
const documentationTools = 22; // Base documentation tools
const managementTools = apiConfigured ? 16 : 0;
const totalTools = documentationTools + managementTools;
// Check npm version
const versionCheck = await checkNpmVersion();
// Get performance metrics
const cacheMetricsData = getInstanceCacheMetrics();
const responseTime = Date.now() - startTime;
// Build diagnostic report
const diagnostic: DiagnosticResponseData = {
const diagnostic: any = {
timestamp: new Date().toISOString(),
environment: envVars,
apiConfiguration: {
@@ -1772,13 +1377,6 @@ export async function handleDiagnostic(request: any, context?: InstanceContext):
maxRetries: apiConfig.maxRetries
} : null
},
versionInfo: {
current: versionCheck.currentVersion,
latest: versionCheck.latestVersion,
upToDate: !versionCheck.isOutdated,
message: formatVersionMessage(versionCheck),
...(versionCheck.updateCommand ? { updateCommand: versionCheck.updateCommand } : {})
},
toolsAvailability: {
documentationTools: {
count: documentationTools,
@@ -1788,175 +1386,43 @@ export async function handleDiagnostic(request: any, context?: InstanceContext):
managementTools: {
count: managementTools,
enabled: apiConfigured,
description: apiConfigured ?
'Management tools are ENABLED - create, update, execute workflows' :
description: apiConfigured ?
'Management tools are ENABLED - create, update, execute workflows' :
'Management tools are DISABLED - configure N8N_API_URL and N8N_API_KEY to enable'
},
totalAvailable: totalTools
},
performance: {
diagnosticResponseTimeMs: responseTime,
cacheHitRate: (cacheMetricsData.hits + cacheMetricsData.misses) > 0
? ((cacheMetricsData.hits / (cacheMetricsData.hits + cacheMetricsData.misses)) * 100).toFixed(2) + '%'
: 'N/A',
cachedInstances: cacheMetricsData.size
},
modeSpecificDebug: getModeSpecificDebug(mcpMode)
troubleshooting: {
steps: apiConfigured ? [
'API is configured and should work',
'If tools are not showing in Claude Desktop:',
'1. Restart Claude Desktop completely',
'2. Check if using latest Docker image',
'3. Verify environment variables are passed correctly',
'4. Try running n8n_health_check to test connectivity'
] : [
'To enable management tools:',
'1. Set N8N_API_URL environment variable (e.g., https://your-n8n-instance.com)',
'2. Set N8N_API_KEY environment variable (get from n8n API settings)',
'3. Restart the MCP server',
'4. Management tools will automatically appear'
],
documentation: 'For detailed setup instructions, see: https://github.com/czlonkowski/n8n-mcp?tab=readme-ov-file#n8n-management-tools-optional---requires-api-configuration'
}
};
// Enhanced guidance based on telemetry insights
if (apiConfigured && apiStatus.connected) {
// API is working - provide next steps
diagnostic.nextSteps = {
message: '✓ API connected! Here\'s what you can do:',
recommended: [
{
action: 'n8n_list_workflows',
description: 'See your existing workflows',
timing: 'Fast (6 seconds median)'
},
{
action: 'n8n_create_workflow',
description: 'Create a new workflow',
timing: 'Typically 6-14 minutes to build'
},
{
action: 'search_nodes',
description: 'Discover available nodes',
timing: 'Fast - explore 500+ nodes'
},
{
action: 'search_templates',
description: 'Browse pre-built workflows',
timing: 'Find examples quickly'
}
],
tips: [
'82% of users start creating workflows after diagnostics - you\'re ready to go!',
'Most common first action: n8n_update_partial_workflow (managing existing workflows)',
'Use n8n_validate_workflow before deploying to catch issues early'
]
};
} else if (apiConfigured && !apiStatus.connected) {
// API configured but not connecting - troubleshooting
diagnostic.troubleshooting = {
issue: '⚠️ API configured but connection failed',
error: apiStatus.error,
steps: [
'1. Verify n8n instance is running and accessible',
'2. Check N8N_API_URL is correct (currently: ' + apiConfig?.baseUrl + ')',
'3. Test URL in browser: ' + apiConfig?.baseUrl + '/healthz',
'4. Verify N8N_API_KEY has proper permissions',
'5. Check firewall/network settings if using remote n8n',
'6. Try running n8n_health_check again after fixes'
],
commonIssues: [
'Wrong port number in N8N_API_URL',
'API key doesn\'t have sufficient permissions',
'n8n instance not running or crashed',
'Network firewall blocking connection'
],
documentation: 'https://github.com/czlonkowski/n8n-mcp?tab=readme-ov-file#n8n-management-tools-optional---requires-api-configuration'
};
} else {
// API not configured - setup guidance
diagnostic.setupGuide = {
message: 'n8n API not configured. You can still use documentation tools!',
whatYouCanDoNow: {
documentation: [
{
tool: 'search_nodes',
description: 'Search 500+ n8n nodes',
example: 'search_nodes({query: "slack"})'
},
{
tool: 'get_node_essentials',
description: 'Get node configuration details',
example: 'get_node_essentials({nodeType: "nodes-base.httpRequest"})'
},
{
tool: 'search_templates',
description: 'Browse workflow templates',
example: 'search_templates({query: "chatbot"})'
},
{
tool: 'validate_workflow',
description: 'Validate workflow JSON',
example: 'validate_workflow({workflow: {...}})'
}
],
note: '22 documentation tools available without API configuration'
},
whatYouCannotDo: [
'✗ Create/update workflows in n8n instance',
'✗ List your workflows',
'✗ Execute workflows',
'✗ View execution results'
],
howToEnable: {
steps: [
'1. Get your n8n API key: [Your n8n instance]/settings/api',
'2. Set environment variables:',
' N8N_API_URL=https://your-n8n-instance.com',
' N8N_API_KEY=your_api_key_here',
'3. Restart the MCP server',
'4. Run n8n_diagnostic again to verify',
'5. All 38 tools will be available!'
],
documentation: 'https://github.com/czlonkowski/n8n-mcp?tab=readme-ov-file#n8n-management-tools-optional---requires-api-configuration'
}
};
}
// Add version warning if outdated
if (versionCheck.isOutdated && versionCheck.latestVersion) {
diagnostic.updateWarning = {
message: `⚠️ Update available: v${versionCheck.currentVersion} → v${versionCheck.latestVersion}`,
command: versionCheck.updateCommand,
benefits: [
'Latest bug fixes and improvements',
'New features and tools',
'Better performance and reliability'
]
};
}
// Add Docker-specific debugging if in container
const dockerDebug = getDockerDebug(isDocker);
if (dockerDebug) {
diagnostic.dockerDebug = dockerDebug;
}
// Add cloud platform-specific debugging if detected
const cloudDebug = getCloudPlatformDebug(cloudPlatform);
if (cloudDebug) {
diagnostic.cloudPlatformDebug = cloudDebug;
}
// Add verbose debug info if requested
if (verbose) {
diagnostic.debug = {
processEnv: Object.keys(process.env).filter(key =>
diagnostic['debug'] = {
processEnv: Object.keys(process.env).filter(key =>
key.startsWith('N8N_') || key.startsWith('MCP_')
),
nodeVersion: process.version,
platform: process.platform,
workingDirectory: process.cwd(),
cacheMetrics: cacheMetricsData
workingDirectory: process.cwd()
};
}
// Track diagnostic usage with result data
telemetry.trackEvent('diagnostic_completed', {
success: true,
apiConfigured,
apiConnected: apiStatus.connected,
toolsAvailable: totalTools,
responseTimeMs: responseTime,
upToDate: !versionCheck.isOutdated,
verbose
});
return {
success: true,
data: diagnostic

View File

@@ -11,7 +11,6 @@ import { getN8nApiClient } from './handlers-n8n-manager';
import { N8nApiError, getUserFriendlyErrorMessage } from '../utils/n8n-errors';
import { logger } from '../utils/logger';
import { InstanceContext } from '../types/instance-context';
import { validateWorkflowStructure } from '../services/n8n-validation';
// Zod schema for the diff request
const workflowDiffSchema = z.object({
@@ -126,87 +125,7 @@ export async function handleUpdatePartialWorkflow(args: unknown, context?: Insta
}
};
}
// Validate final workflow structure after applying all operations
// This prevents creating workflows that pass operation-level validation
// but fail workflow-level validation (e.g., UI can't render them)
//
// Validation can be skipped for specific integration tests that need to test
// n8n API behavior with edge case workflows by setting SKIP_WORKFLOW_VALIDATION=true
if (diffResult.workflow) {
const structureErrors = validateWorkflowStructure(diffResult.workflow);
if (structureErrors.length > 0) {
const skipValidation = process.env.SKIP_WORKFLOW_VALIDATION === 'true';
logger.warn('Workflow structure validation failed after applying diff operations', {
workflowId: input.id,
errors: structureErrors,
blocking: !skipValidation
});
// Analyze error types to provide targeted recovery guidance
const errorTypes = new Set<string>();
structureErrors.forEach(err => {
if (err.includes('operator') || err.includes('singleValue')) errorTypes.add('operator_issues');
if (err.includes('connection') || err.includes('referenced')) errorTypes.add('connection_issues');
if (err.includes('Missing') || err.includes('missing')) errorTypes.add('missing_metadata');
if (err.includes('branch') || err.includes('output')) errorTypes.add('branch_mismatch');
});
// Build recovery guidance based on error types
const recoverySteps = [];
if (errorTypes.has('operator_issues')) {
recoverySteps.push('Operator structure issue detected. Use validate_node_operation to check specific nodes.');
recoverySteps.push('Binary operators (equals, contains, greaterThan, etc.) must NOT have singleValue:true');
recoverySteps.push('Unary operators (isEmpty, isNotEmpty, true, false) REQUIRE singleValue:true');
}
if (errorTypes.has('connection_issues')) {
recoverySteps.push('Connection validation failed. Check all node connections reference existing nodes.');
recoverySteps.push('Use cleanStaleConnections operation to remove connections to non-existent nodes.');
}
if (errorTypes.has('missing_metadata')) {
recoverySteps.push('Missing metadata detected. Ensure filter-based nodes (IF v2.2+, Switch v3.2+) have complete conditions.options.');
recoverySteps.push('Required options: {version: 2, leftValue: "", caseSensitive: true, typeValidation: "strict"}');
}
if (errorTypes.has('branch_mismatch')) {
recoverySteps.push('Branch count mismatch. Ensure Switch nodes have outputs for all rules (e.g., 3 rules = 3 output branches).');
}
// Add generic recovery steps if no specific guidance
if (recoverySteps.length === 0) {
recoverySteps.push('Review the validation errors listed above');
recoverySteps.push('Fix issues using updateNode or cleanStaleConnections operations');
recoverySteps.push('Run validate_workflow again to verify fixes');
}
const errorMessage = structureErrors.length === 1
? `Workflow validation failed: ${structureErrors[0]}`
: `Workflow validation failed with ${structureErrors.length} structural issues`;
// If validation is not skipped, return error and block the save
if (!skipValidation) {
return {
success: false,
error: errorMessage,
details: {
errors: structureErrors,
errorCount: structureErrors.length,
operationsApplied: diffResult.operationsApplied,
applied: diffResult.applied,
recoveryGuidance: recoverySteps,
note: 'Operations were applied but created an invalid workflow structure. The workflow was NOT saved to n8n to prevent UI rendering errors.',
autoSanitizationNote: 'Auto-sanitization runs on all nodes during updates to fix operator structures and add missing metadata. However, it cannot fix all issues (e.g., broken connections, branch mismatches). Use the recovery guidance above to resolve remaining issues.'
}
};
}
// Validation skipped: log warning but continue (for specific integration tests)
logger.info('Workflow validation skipped (SKIP_WORKFLOW_VALIDATION=true): Allowing workflow with validation warnings to proceed', {
workflowId: input.id,
warningCount: structureErrors.length
});
}
}
// Update workflow via API
try {
const updatedWorkflow = await client.updateWorkflow(input.id, diffResult.workflow!);

View File

@@ -3,8 +3,6 @@
import { N8NDocumentationMCPServer } from './server';
import { logger } from '../utils/logger';
import { TelemetryConfigManager } from '../telemetry/config-manager';
import { EarlyErrorLogger } from '../telemetry/early-error-logger';
import { STARTUP_CHECKPOINTS, findFailedCheckpoint, StartupCheckpoint } from '../telemetry/startup-checkpoints';
import { existsSync } from 'fs';
// Add error details to stderr for Claude Desktop debugging
@@ -55,19 +53,8 @@ function isContainerEnvironment(): boolean {
}
async function main() {
// Initialize early error logger for pre-handshake error capture (v2.18.3)
// Now using singleton pattern with defensive initialization
const startTime = Date.now();
const earlyLogger = EarlyErrorLogger.getInstance();
const checkpoints: StartupCheckpoint[] = [];
try {
// Checkpoint: Process started (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.PROCESS_STARTED);
checkpoints.push(STARTUP_CHECKPOINTS.PROCESS_STARTED);
// Handle telemetry CLI commands
const args = process.argv.slice(2);
// Handle telemetry CLI commands
const args = process.argv.slice(2);
if (args.length > 0 && args[0] === 'telemetry') {
const telemetryConfig = TelemetryConfigManager.getInstance();
const action = args[1];
@@ -102,15 +89,6 @@ Learn more: https://github.com/czlonkowski/n8n-mcp/blob/main/PRIVACY.md
const mode = process.env.MCP_MODE || 'stdio';
// Checkpoint: Telemetry initializing (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.TELEMETRY_INITIALIZING);
checkpoints.push(STARTUP_CHECKPOINTS.TELEMETRY_INITIALIZING);
// Telemetry is already initialized by TelemetryConfigManager in imports
// Mark as ready (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.TELEMETRY_READY);
checkpoints.push(STARTUP_CHECKPOINTS.TELEMETRY_READY);
try {
// Only show debug messages in HTTP mode to avoid corrupting stdio communication
if (mode === 'http') {
@@ -118,10 +96,6 @@ Learn more: https://github.com/czlonkowski/n8n-mcp/blob/main/PRIVACY.md
console.error('Current directory:', process.cwd());
console.error('Node version:', process.version);
}
// Checkpoint: MCP handshake starting (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.MCP_HANDSHAKE_STARTING);
checkpoints.push(STARTUP_CHECKPOINTS.MCP_HANDSHAKE_STARTING);
if (mode === 'http') {
// Check if we should use the fixed implementation
@@ -147,7 +121,7 @@ Learn more: https://github.com/czlonkowski/n8n-mcp/blob/main/PRIVACY.md
}
} else {
// Stdio mode - for local Claude Desktop
const server = new N8NDocumentationMCPServer(undefined, earlyLogger);
const server = new N8NDocumentationMCPServer();
// Graceful shutdown handler (fixes Issue #277)
let isShuttingDown = false;
@@ -211,31 +185,12 @@ Learn more: https://github.com/czlonkowski/n8n-mcp/blob/main/PRIVACY.md
await server.run();
}
// Checkpoint: MCP handshake complete (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.MCP_HANDSHAKE_COMPLETE);
checkpoints.push(STARTUP_CHECKPOINTS.MCP_HANDSHAKE_COMPLETE);
// Checkpoint: Server ready (fire-and-forget, no await)
earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.SERVER_READY);
checkpoints.push(STARTUP_CHECKPOINTS.SERVER_READY);
// Log successful startup (fire-and-forget, no await)
const startupDuration = Date.now() - startTime;
earlyLogger.logStartupSuccess(checkpoints, startupDuration);
logger.info(`Server startup completed in ${startupDuration}ms (${checkpoints.length} checkpoints passed)`);
} catch (error) {
// Log startup error with checkpoint context (fire-and-forget, no await)
const failedCheckpoint = findFailedCheckpoint(checkpoints);
earlyLogger.logStartupError(failedCheckpoint, error);
// In stdio mode, we cannot output to console at all
if (mode !== 'stdio') {
console.error('Failed to start MCP server:', error);
logger.error('Failed to start MCP server', error);
// Provide helpful error messages
if (error instanceof Error && error.message.includes('nodes.db not found')) {
console.error('\nTo fix this issue:');
@@ -249,12 +204,7 @@ Learn more: https://github.com/czlonkowski/n8n-mcp/blob/main/PRIVACY.md
console.error('3. If that doesn\'t work, try: rm -rf node_modules && npm install');
}
}
process.exit(1);
}
} catch (outerError) {
// Outer error catch for early initialization failures
logger.error('Critical startup error:', outerError);
process.exit(1);
}
}

View File

@@ -37,8 +37,6 @@ import {
} from '../utils/protocol-version';
import { InstanceContext } from '../types/instance-context';
import { telemetry } from '../telemetry';
import { EarlyErrorLogger } from '../telemetry/early-error-logger';
import { STARTUP_CHECKPOINTS } from '../telemetry/startup-checkpoints';
interface NodeRow {
node_type: string;
@@ -69,11 +67,9 @@ export class N8NDocumentationMCPServer {
private instanceContext?: InstanceContext;
private previousTool: string | null = null;
private previousToolTimestamp: number = Date.now();
private earlyLogger: EarlyErrorLogger | null = null;
constructor(instanceContext?: InstanceContext, earlyLogger?: EarlyErrorLogger) {
constructor(instanceContext?: InstanceContext) {
this.instanceContext = instanceContext;
this.earlyLogger = earlyLogger || null;
// Check for test environment first
const envDbPath = process.env.NODE_DB_PATH;
let dbPath: string | null = null;
@@ -104,49 +100,22 @@ export class N8NDocumentationMCPServer {
}
// Initialize database asynchronously
this.initialized = this.initializeDatabase(dbPath).then(() => {
// After database is ready, check n8n API configuration (v2.18.3)
if (this.earlyLogger) {
this.earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.N8N_API_CHECKING);
}
// Log n8n API configuration status at startup
const apiConfigured = isN8nApiConfigured();
const totalTools = apiConfigured ?
n8nDocumentationToolsFinal.length + n8nManagementTools.length :
n8nDocumentationToolsFinal.length;
logger.info(`MCP server initialized with ${totalTools} tools (n8n API: ${apiConfigured ? 'configured' : 'not configured'})`);
if (this.earlyLogger) {
this.earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.N8N_API_READY);
}
});
this.initialized = this.initializeDatabase(dbPath);
logger.info('Initializing n8n Documentation MCP server');
// Log n8n API configuration status at startup
const apiConfigured = isN8nApiConfigured();
const totalTools = apiConfigured ?
n8nDocumentationToolsFinal.length + n8nManagementTools.length :
n8nDocumentationToolsFinal.length;
logger.info(`MCP server initialized with ${totalTools} tools (n8n API: ${apiConfigured ? 'configured' : 'not configured'})`);
this.server = new Server(
{
name: 'n8n-documentation-mcp',
version: PROJECT_VERSION,
icons: [
{
src: "https://www.n8n-mcp.com/logo.png",
mimeType: "image/png",
sizes: ["192x192"]
},
{
src: "https://www.n8n-mcp.com/logo-128.png",
mimeType: "image/png",
sizes: ["128x128"]
},
{
src: "https://www.n8n-mcp.com/logo-48.png",
mimeType: "image/png",
sizes: ["48x48"]
}
],
websiteUrl: "https://n8n-mcp.com"
version: '1.0.0',
},
{
capabilities: {
@@ -160,38 +129,20 @@ export class N8NDocumentationMCPServer {
private async initializeDatabase(dbPath: string): Promise<void> {
try {
// Checkpoint: Database connecting (v2.18.3)
if (this.earlyLogger) {
this.earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.DATABASE_CONNECTING);
}
logger.debug('Database initialization starting...', { dbPath });
this.db = await createDatabaseAdapter(dbPath);
logger.debug('Database adapter created');
// If using in-memory database for tests, initialize schema
if (dbPath === ':memory:') {
await this.initializeInMemorySchema();
logger.debug('In-memory schema initialized');
}
this.repository = new NodeRepository(this.db);
logger.debug('Node repository initialized');
this.templateService = new TemplateService(this.db);
logger.debug('Template service initialized');
// Initialize similarity services for enhanced validation
EnhancedConfigValidator.initializeSimilarityServices(this.repository);
logger.debug('Similarity services initialized');
// Checkpoint: Database connected (v2.18.3)
if (this.earlyLogger) {
this.earlyLogger.logCheckpoint(STARTUP_CHECKPOINTS.DATABASE_CONNECTED);
}
logger.info(`Database initialized successfully from: ${dbPath}`);
logger.info(`Initialized database from: ${dbPath}`);
} catch (error) {
logger.error('Failed to initialize database:', error);
throw new Error(`Failed to open database: ${error instanceof Error ? error.message : 'Unknown error'}`);
@@ -200,122 +151,25 @@ export class N8NDocumentationMCPServer {
private async initializeInMemorySchema(): Promise<void> {
if (!this.db) return;
// Read and execute schema
const schemaPath = path.join(__dirname, '../../src/database/schema.sql');
const schema = await fs.readFile(schemaPath, 'utf-8');
// Parse SQL statements properly (handles BEGIN...END blocks in triggers)
const statements = this.parseSQLStatements(schema);
// Execute schema statements
const statements = schema.split(';').filter(stmt => stmt.trim());
for (const statement of statements) {
if (statement.trim()) {
try {
this.db.exec(statement);
} catch (error) {
logger.error(`Failed to execute SQL statement: ${statement.substring(0, 100)}...`, error);
throw error;
}
this.db.exec(statement);
}
}
}
/**
* Parse SQL statements from schema file, properly handling multi-line statements
* including triggers with BEGIN...END blocks
*/
private parseSQLStatements(sql: string): string[] {
const statements: string[] = [];
let current = '';
let inBlock = false;
const lines = sql.split('\n');
for (const line of lines) {
const trimmed = line.trim().toUpperCase();
// Skip comments and empty lines
if (trimmed.startsWith('--') || trimmed === '') {
continue;
}
// Track BEGIN...END blocks (triggers, procedures)
if (trimmed.includes('BEGIN')) {
inBlock = true;
}
current += line + '\n';
// End of block (trigger/procedure)
if (inBlock && trimmed === 'END;') {
statements.push(current.trim());
current = '';
inBlock = false;
continue;
}
// Regular statement end (not in block)
if (!inBlock && trimmed.endsWith(';')) {
statements.push(current.trim());
current = '';
}
}
// Add any remaining content
if (current.trim()) {
statements.push(current.trim());
}
return statements.filter(s => s.length > 0);
}
private async ensureInitialized(): Promise<void> {
await this.initialized;
if (!this.db || !this.repository) {
throw new Error('Database not initialized');
}
// Validate database health on first access
if (!this.dbHealthChecked) {
await this.validateDatabaseHealth();
this.dbHealthChecked = true;
}
}
private dbHealthChecked: boolean = false;
private async validateDatabaseHealth(): Promise<void> {
if (!this.db) return;
try {
// Check if nodes table has data
const nodeCount = this.db.prepare('SELECT COUNT(*) as count FROM nodes').get() as { count: number };
if (nodeCount.count === 0) {
logger.error('CRITICAL: Database is empty - no nodes found! Please run: npm run rebuild');
throw new Error('Database is empty. Run "npm run rebuild" to populate node data.');
}
// Check if FTS5 table exists
const ftsExists = this.db.prepare(`
SELECT name FROM sqlite_master
WHERE type='table' AND name='nodes_fts'
`).get();
if (!ftsExists) {
logger.warn('FTS5 table missing - search performance will be degraded. Please run: npm run rebuild');
} else {
const ftsCount = this.db.prepare('SELECT COUNT(*) as count FROM nodes_fts').get() as { count: number };
if (ftsCount.count === 0) {
logger.warn('FTS5 index is empty - search will not work properly. Please run: npm run rebuild');
}
}
logger.info(`Database health check passed: ${nodeCount.count} nodes loaded`);
} catch (error) {
logger.error('Database health check failed:', error);
throw error;
}
}
private setupHandlers(): void {
@@ -1180,15 +1034,6 @@ export class N8NDocumentationMCPServer {
};
}
/**
* Primary search method used by ALL MCP search tools.
*
* This method automatically detects and uses FTS5 full-text search when available
* (lines 1189-1203), falling back to LIKE queries only if FTS5 table doesn't exist.
*
* NOTE: This is separate from NodeRepository.searchNodes() which is legacy LIKE-based.
* All MCP tool invocations route through this method to leverage FTS5 performance.
*/
private async searchNodes(
query: string,
limit: number = 20,
@@ -1200,7 +1045,7 @@ export class N8NDocumentationMCPServer {
): Promise<any> {
await this.ensureInitialized();
if (!this.db) throw new Error('Database not initialized');
// Normalize the query if it looks like a full node type
let normalizedQuery = query;
@@ -1276,20 +1121,20 @@ export class N8NDocumentationMCPServer {
try {
// Use FTS5 with ranking
const nodes = this.db.prepare(`
SELECT
SELECT
n.*,
rank
FROM nodes n
JOIN nodes_fts ON n.rowid = nodes_fts.rowid
WHERE nodes_fts MATCH ?
ORDER BY
CASE
WHEN LOWER(n.display_name) = LOWER(?) THEN 0
WHEN LOWER(n.display_name) LIKE LOWER(?) THEN 1
WHEN LOWER(n.node_type) LIKE LOWER(?) THEN 2
ORDER BY
rank,
CASE
WHEN n.display_name = ? THEN 0
WHEN n.display_name LIKE ? THEN 1
WHEN n.node_type LIKE ? THEN 2
ELSE 3
END,
rank,
n.display_name
LIMIT ?
`).all(ftsQuery, cleanedQuery, `%${cleanedQuery}%`, `%${cleanedQuery}%`, limit) as (NodeRow & { rank: number })[];
@@ -2069,8 +1914,7 @@ Full documentation is being prepared. For now, use get_node_essentials for confi
// Add examples from templates if requested
if (includeExamples) {
try {
// Use the already-computed workflowNodeType from result (line 1888)
// This ensures consistency with search_nodes behavior (line 1203)
const fullNodeType = getWorkflowNodeType(node.package ?? 'n8n-nodes-base', node.nodeType);
const examples = this.db!.prepare(`
SELECT
parameters_json,
@@ -2084,7 +1928,7 @@ Full documentation is being prepared. For now, use get_node_essentials for confi
WHERE node_type = ?
ORDER BY rank
LIMIT 3
`).all(result.workflowNodeType) as any[];
`).all(fullNodeType) as any[];
if (examples.length > 0) {
(result as any).examples = examples.map((ex: any) => ({

View File

@@ -4,30 +4,26 @@ export const listAiToolsDoc: ToolDocumentation = {
name: 'list_ai_tools',
category: 'discovery',
essentials: {
description: 'DEPRECATED: Basic list of 263 AI nodes. For comprehensive AI Agent guidance, use tools_documentation({topic: "ai_agents_guide"}). That guide covers architecture, connections, tools, validation, and best practices. Use search_nodes({query: "AI", includeExamples: true}) for AI nodes with working examples.',
description: 'Returns 263 nodes with built-in AI features. CRITICAL: Any of the 525 n8n nodes can be used as an AI tool by connecting it to an AI Agent node\'s tool port. This list only shows nodes with AI-specific features, not all usable nodes.',
keyParameters: [],
example: 'tools_documentation({topic: "ai_agents_guide"}) // Recommended alternative',
example: 'list_ai_tools()',
performance: 'Instant (cached)',
tips: [
'NEW: Use ai_agents_guide for comprehensive AI workflow documentation',
'Use search_nodes({includeExamples: true}) for AI nodes with real-world examples',
'ANY node can be an AI tool - not limited to AI-specific nodes',
'ANY node can be an AI tool - not limited to this list',
'Connect Slack, Database, HTTP Request, etc. to AI Agent tool port',
'Use get_node_as_tool_info for guidance on any node'
]
},
full: {
description: '**DEPRECATED in favor of ai_agents_guide**. Lists 263 nodes with built-in AI capabilities. For comprehensive documentation on building AI Agent workflows, use tools_documentation({topic: "ai_agents_guide"}) which covers architecture, the 8 AI connection types, validation, and best practices with real examples. IMPORTANT: This basic list is NOT a complete guide - use the full AI Agents guide instead.',
description: 'Lists 263 nodes that have built-in AI capabilities or are optimized for AI workflows. IMPORTANT: This is NOT a complete list of nodes usable as AI tools. Any of the 525 n8n nodes can be connected to an AI Agent node\'s tool port to function as an AI tool. This includes Slack, Google Sheets, databases, HTTP requests, and more.',
parameters: {},
returns: 'Array of 263 AI-optimized nodes. RECOMMENDED: Use ai_agents_guide for comprehensive guidance, or search_nodes({query: "AI", includeExamples: true}) for AI nodes with working configuration examples.',
returns: 'Array of 263 AI-optimized nodes including: OpenAI (GPT-3/4), Anthropic (Claude), Google AI (Gemini/PaLM), Cohere, HuggingFace, Pinecone, Qdrant, Supabase Vector Store, LangChain nodes, embeddings processors, vector stores, chat models, and AI-specific utilities. Each entry includes nodeType, displayName, and AI-specific capabilities.',
examples: [
'// RECOMMENDED: Use the comprehensive AI Agents guide',
'tools_documentation({topic: "ai_agents_guide"})',
'',
'// Or search for AI nodes with real-world examples',
'search_nodes({query: "AI Agent", includeExamples: true})',
'',
'// Basic list (deprecated)',
'list_ai_tools() - Returns 263 AI-optimized nodes'
'list_ai_tools() - Returns all 263 AI-optimized nodes',
'// To use ANY node as AI tool:',
'// 1. Add any node (e.g., Slack, MySQL, HTTP Request)',
'// 2. Connect it to AI Agent node\'s "Tool" input port',
'// 3. The AI agent can now use that node\'s functionality'
],
useCases: [
'Discover AI model integrations (OpenAI, Anthropic, Google AI)',

View File

@@ -1,738 +0,0 @@
import { ToolDocumentation } from '../types';
export const aiAgentsGuide: ToolDocumentation = {
name: 'ai_agents_guide',
category: 'guides',
essentials: {
description: 'Comprehensive guide to building AI Agent workflows in n8n. Covers architecture, connections, tools, validation, and best practices for production AI systems.',
keyParameters: [],
example: 'Use tools_documentation({topic: "ai_agents_guide"}) to access this guide',
performance: 'N/A - Documentation only',
tips: [
'Start with Chat Trigger → AI Agent → Language Model pattern',
'Always connect language model BEFORE enabling AI Agent',
'Use proper toolDescription for all AI tools (15+ characters)',
'Validate workflows with n8n_validate_workflow before deployment',
'Use includeExamples=true when searching for AI nodes',
'Check FINAL_AI_VALIDATION_SPEC.md for detailed requirements'
]
},
full: {
description: `# Complete Guide to AI Agents in n8n
This comprehensive guide covers everything you need to build production-ready AI Agent workflows in n8n.
## Table of Contents
1. [AI Agent Architecture](#architecture)
2. [Essential Connection Types](#connections)
3. [Building Your First AI Agent](#first-agent)
4. [AI Tools Deep Dive](#tools)
5. [Advanced Patterns](#advanced)
6. [Validation & Best Practices](#validation)
7. [Troubleshooting](#troubleshooting)
---
## 1. AI Agent Architecture {#architecture}
### Core Components
An n8n AI Agent workflow typically consists of:
1. **Chat Trigger**: Entry point for user interactions
- Webhook-based or manual trigger
- Supports streaming responses (responseMode)
- Passes user message to AI Agent
2. **AI Agent**: The orchestrator
- Manages conversation flow
- Decides when to use tools
- Iterates until task is complete
- Supports fallback models (v2.1+)
3. **Language Model**: The AI brain
- OpenAI GPT-4, Claude, Gemini, etc.
- Connected via ai_languageModel port
- Can have primary + fallback for reliability
4. **Tools**: AI Agent's capabilities
- HTTP Request, Code, Vector Store, etc.
- Connected via ai_tool port
- Each tool needs clear toolDescription
5. **Optional Components**:
- Memory (conversation history)
- Output Parser (structured responses)
- Vector Store (knowledge retrieval)
### Connection Flow
**CRITICAL**: AI connections flow TO the consumer (reversed from standard n8n):
\`\`\`
Standard n8n: [Source] --main--> [Target]
AI pattern: [Language Model] --ai_languageModel--> [AI Agent]
[HTTP Tool] --ai_tool--> [AI Agent]
\`\`\`
This is why you use \`sourceOutput: "ai_languageModel"\` when connecting components.
---
## 2. Essential Connection Types {#connections}
### The 8 AI Connection Types
1. **ai_languageModel**
- FROM: OpenAI Chat Model, Anthropic, Google Gemini, etc.
- TO: AI Agent, Basic LLM Chain
- REQUIRED: Every AI Agent needs 1-2 language models
- Example: \`{type: "addConnection", source: "OpenAI", target: "AI Agent", sourceOutput: "ai_languageModel"}\`
2. **ai_tool**
- FROM: Any tool node (HTTP Request Tool, Code Tool, etc.)
- TO: AI Agent
- REQUIRED: At least 1 tool recommended
- Example: \`{type: "addConnection", source: "HTTP Request Tool", target: "AI Agent", sourceOutput: "ai_tool"}\`
3. **ai_memory**
- FROM: Window Buffer Memory, Conversation Summary, etc.
- TO: AI Agent
- OPTIONAL: 0-1 memory system
- Enables conversation history tracking
4. **ai_outputParser**
- FROM: Structured Output Parser, JSON Parser, etc.
- TO: AI Agent
- OPTIONAL: For structured responses
- Must set hasOutputParser=true on AI Agent
5. **ai_embedding**
- FROM: Embeddings OpenAI, Embeddings Google, etc.
- TO: Vector Store (Pinecone, In-Memory, etc.)
- REQUIRED: For vector-based retrieval
6. **ai_vectorStore**
- FROM: Vector Store node
- TO: Vector Store Tool
- REQUIRED: For retrieval-augmented generation (RAG)
7. **ai_document**
- FROM: Document Loader, Default Data Loader
- TO: Vector Store
- REQUIRED: Provides data for vector storage
8. **ai_textSplitter**
- FROM: Text Splitter nodes
- TO: Document processing chains
- OPTIONAL: Chunk large documents
### Connection Examples
\`\`\`typescript
// Basic AI Agent setup
n8n_update_partial_workflow({
id: "workflow_id",
operations: [
// Connect language model (REQUIRED)
{
type: "addConnection",
source: "OpenAI Chat Model",
target: "AI Agent",
sourceOutput: "ai_languageModel"
},
// Connect tools
{
type: "addConnection",
source: "HTTP Request Tool",
target: "AI Agent",
sourceOutput: "ai_tool"
},
{
type: "addConnection",
source: "Code Tool",
target: "AI Agent",
sourceOutput: "ai_tool"
},
// Add memory (optional)
{
type: "addConnection",
source: "Window Buffer Memory",
target: "AI Agent",
sourceOutput: "ai_memory"
}
]
})
\`\`\`
---
## 3. Building Your First AI Agent {#first-agent}
### Step-by-Step Tutorial
#### Step 1: Create Chat Trigger
Use \`n8n_create_workflow\` or manually create a workflow with:
\`\`\`typescript
{
name: "My First AI Agent",
nodes: [
{
id: "chat_trigger",
name: "Chat Trigger",
type: "@n8n/n8n-nodes-langchain.chatTrigger",
position: [100, 100],
parameters: {
options: {
responseMode: "lastNode" // or "streaming" for real-time
}
}
}
],
connections: {}
}
\`\`\`
#### Step 2: Add Language Model
\`\`\`typescript
n8n_update_partial_workflow({
id: "workflow_id",
operations: [
{
type: "addNode",
node: {
name: "OpenAI Chat Model",
type: "@n8n/n8n-nodes-langchain.lmChatOpenAi",
position: [300, 50],
parameters: {
model: "gpt-4",
temperature: 0.7
}
}
}
]
})
\`\`\`
#### Step 3: Add AI Agent
\`\`\`typescript
n8n_update_partial_workflow({
id: "workflow_id",
operations: [
{
type: "addNode",
node: {
name: "AI Agent",
type: "@n8n/n8n-nodes-langchain.agent",
position: [300, 150],
parameters: {
promptType: "auto",
systemMessage: "You are a helpful assistant. Be concise and accurate."
}
}
}
]
})
\`\`\`
#### Step 4: Connect Components
\`\`\`typescript
n8n_update_partial_workflow({
id: "workflow_id",
operations: [
// Chat Trigger → AI Agent (main connection)
{
type: "addConnection",
source: "Chat Trigger",
target: "AI Agent"
},
// Language Model → AI Agent (AI connection)
{
type: "addConnection",
source: "OpenAI Chat Model",
target: "AI Agent",
sourceOutput: "ai_languageModel"
}
]
})
\`\`\`
#### Step 5: Validate
\`\`\`typescript
n8n_validate_workflow({id: "workflow_id"})
\`\`\`
---
## 4. AI Tools Deep Dive {#tools}
### Tool Types and When to Use Them
#### 1. HTTP Request Tool
**Use when**: AI needs to call external APIs
**Critical Requirements**:
- \`toolDescription\`: Clear, 15+ character description
- \`url\`: API endpoint (can include placeholders)
- \`placeholderDefinitions\`: Define all {placeholders}
- Proper authentication if needed
**Example**:
\`\`\`typescript
{
type: "addNode",
node: {
name: "GitHub Issues Tool",
type: "@n8n/n8n-nodes-langchain.toolHttpRequest",
position: [500, 100],
parameters: {
method: "POST",
url: "https://api.github.com/repos/{owner}/{repo}/issues",
toolDescription: "Create GitHub issues. Requires owner (username), repo (repository name), title, and body.",
placeholderDefinitions: {
values: [
{name: "owner", description: "Repository owner username"},
{name: "repo", description: "Repository name"},
{name: "title", description: "Issue title"},
{name: "body", description: "Issue description"}
]
},
sendBody: true,
jsonBody: "={{ { title: $json.title, body: $json.body } }}"
}
}
}
\`\`\`
#### 2. Code Tool
**Use when**: AI needs to run custom logic
**Critical Requirements**:
- \`name\`: Function name (alphanumeric + underscore)
- \`description\`: 10+ character explanation
- \`code\`: JavaScript or Python code
- \`inputSchema\`: Define expected inputs (recommended)
**Example**:
\`\`\`typescript
{
type: "addNode",
node: {
name: "Calculate Shipping",
type: "@n8n/n8n-nodes-langchain.toolCode",
position: [500, 200],
parameters: {
name: "calculate_shipping",
description: "Calculate shipping cost based on weight (kg) and distance (km)",
language: "javaScript",
code: "const cost = 5 + ($input.weight * 2) + ($input.distance * 0.1); return { cost };",
specifyInputSchema: true,
inputSchema: "{ \\"type\\": \\"object\\", \\"properties\\": { \\"weight\\": { \\"type\\": \\"number\\" }, \\"distance\\": { \\"type\\": \\"number\\" } } }"
}
}
}
\`\`\`
#### 3. Vector Store Tool
**Use when**: AI needs to search knowledge base
**Setup**: Requires Vector Store + Embeddings + Documents
**Example**:
\`\`\`typescript
// Step 1: Create Vector Store with embeddings and documents
n8n_update_partial_workflow({
operations: [
{type: "addConnection", source: "Embeddings OpenAI", target: "Pinecone", sourceOutput: "ai_embedding"},
{type: "addConnection", source: "Document Loader", target: "Pinecone", sourceOutput: "ai_document"}
]
})
// Step 2: Connect Vector Store to Vector Store Tool
n8n_update_partial_workflow({
operations: [
{type: "addConnection", source: "Pinecone", target: "Vector Store Tool", sourceOutput: "ai_vectorStore"}
]
})
// Step 3: Connect tool to AI Agent
n8n_update_partial_workflow({
operations: [
{type: "addConnection", source: "Vector Store Tool", target: "AI Agent", sourceOutput: "ai_tool"}
]
})
\`\`\`
#### 4. AI Agent Tool (Sub-Agents)
**Use when**: Need specialized expertise
**Example**: Research specialist sub-agent
\`\`\`typescript
{
type: "addNode",
node: {
name: "Research Specialist",
type: "@n8n/n8n-nodes-langchain.agentTool",
position: [500, 300],
parameters: {
name: "research_specialist",
description: "Expert researcher that searches multiple sources and synthesizes information. Use for detailed research tasks.",
systemMessage: "You are a research specialist. Search thoroughly, cite sources, and provide comprehensive analysis."
}
}
}
\`\`\`
#### 5. MCP Client Tool
**Use when**: Need to use Model Context Protocol servers
**Example**: Filesystem access
\`\`\`typescript
{
type: "addNode",
node: {
name: "Filesystem Tool",
type: "@n8n/n8n-nodes-langchain.mcpClientTool",
position: [500, 400],
parameters: {
description: "Access file system to read files, list directories, and search content",
mcpServer: {
transport: "stdio",
command: "npx",
args: ["-y", "@modelcontextprotocol/server-filesystem", "/allowed/path"]
},
tool: "read_file"
}
}
}
\`\`\`
---
## 5. Advanced Patterns {#advanced}
### Pattern 1: Streaming Responses
For real-time user experience:
\`\`\`typescript
// Set Chat Trigger to streaming mode
{
parameters: {
options: {
responseMode: "streaming"
}
}
}
// CRITICAL: AI Agent must NOT have main output connections in streaming mode
// Responses stream back through Chat Trigger automatically
\`\`\`
**Validation will fail if**:
- Chat Trigger has streaming but target is not AI Agent
- AI Agent in streaming mode has main output connections
### Pattern 2: Fallback Language Models
For production reliability (requires AI Agent v2.1+):
\`\`\`typescript
n8n_update_partial_workflow({
operations: [
// Primary model
{
type: "addConnection",
source: "OpenAI GPT-4",
target: "AI Agent",
sourceOutput: "ai_languageModel",
targetIndex: 0
},
// Fallback model
{
type: "addConnection",
source: "Anthropic Claude",
target: "AI Agent",
sourceOutput: "ai_languageModel",
targetIndex: 1
}
]
})
// Enable fallback on AI Agent
{
type: "updateNode",
nodeName: "AI Agent",
updates: {
"parameters.needsFallback": true
}
}
\`\`\`
### Pattern 3: RAG (Retrieval-Augmented Generation)
Complete knowledge base setup:
\`\`\`typescript
// 1. Load documents
{type: "addConnection", source: "PDF Loader", target: "Text Splitter", sourceOutput: "ai_document"}
// 2. Split and embed
{type: "addConnection", source: "Text Splitter", target: "Vector Store"}
{type: "addConnection", source: "Embeddings", target: "Vector Store", sourceOutput: "ai_embedding"}
// 3. Create search tool
{type: "addConnection", source: "Vector Store", target: "Vector Store Tool", sourceOutput: "ai_vectorStore"}
// 4. Give tool to agent
{type: "addConnection", source: "Vector Store Tool", target: "AI Agent", sourceOutput: "ai_tool"}
\`\`\`
### Pattern 4: Multi-Agent Systems
Specialized sub-agents for complex tasks:
\`\`\`typescript
// Create sub-agents with specific expertise
[
{name: "research_agent", description: "Deep research specialist"},
{name: "data_analyst", description: "Data analysis expert"},
{name: "writer_agent", description: "Content writing specialist"}
].forEach(agent => {
// Add as AI Agent Tool to main coordinator agent
{
type: "addConnection",
source: agent.name,
target: "Coordinator Agent",
sourceOutput: "ai_tool"
}
})
\`\`\`
---
## 6. Validation & Best Practices {#validation}
### Always Validate Before Deployment
\`\`\`typescript
const result = n8n_validate_workflow({id: "workflow_id"})
if (!result.valid) {
console.log("Errors:", result.errors)
console.log("Warnings:", result.warnings)
console.log("Suggestions:", result.suggestions)
}
\`\`\`
### Common Validation Errors
1. **MISSING_LANGUAGE_MODEL**
- Problem: AI Agent has no ai_languageModel connection
- Fix: Connect a language model before creating AI Agent
2. **MISSING_TOOL_DESCRIPTION**
- Problem: HTTP Request Tool has no toolDescription
- Fix: Add clear description (15+ characters)
3. **STREAMING_WITH_MAIN_OUTPUT**
- Problem: AI Agent in streaming mode has outgoing main connections
- Fix: Remove main connections when using streaming
4. **FALLBACK_MISSING_SECOND_MODEL**
- Problem: needsFallback=true but only 1 language model
- Fix: Add second language model or disable needsFallback
### Best Practices Checklist
✅ **Before Creating AI Agent**:
- [ ] Language model is connected first
- [ ] At least one tool is prepared (or will be added)
- [ ] System message is thoughtful and specific
✅ **For Each Tool**:
- [ ] Has toolDescription/description (15+ characters)
- [ ] toolDescription explains WHEN to use the tool
- [ ] All required parameters are configured
- [ ] Credentials are set up if needed
✅ **For Production**:
- [ ] Workflow validated with n8n_validate_workflow
- [ ] Tested with real user queries
- [ ] Fallback model configured for reliability
- [ ] Error handling in place
- [ ] maxIterations set appropriately (default 10, max 50)
---
## 7. Troubleshooting {#troubleshooting}
### Problem: "AI Agent has no language model"
**Cause**: Connection created AFTER AI Agent or using wrong sourceOutput
**Solution**:
\`\`\`typescript
n8n_update_partial_workflow({
operations: [
{
type: "addConnection",
source: "OpenAI Chat Model",
target: "AI Agent",
sourceOutput: "ai_languageModel" // ← CRITICAL
}
]
})
\`\`\`
### Problem: "Tool has no description"
**Cause**: HTTP Request Tool or Code Tool missing toolDescription/description
**Solution**:
\`\`\`typescript
{
type: "updateNode",
nodeName: "HTTP Request Tool",
updates: {
"parameters.toolDescription": "Call weather API to get current conditions for a city"
}
}
\`\`\`
### Problem: "Streaming mode not working"
**Causes**:
1. Chat Trigger not set to streaming
2. AI Agent has main output connections
3. Target of Chat Trigger is not AI Agent
**Solution**:
\`\`\`typescript
// 1. Set Chat Trigger to streaming
{
type: "updateNode",
nodeName: "Chat Trigger",
updates: {
"parameters.options.responseMode": "streaming"
}
}
// 2. Remove AI Agent main outputs
{
type: "removeConnection",
source: "AI Agent",
target: "Any Output Node"
}
\`\`\`
### Problem: "Agent keeps looping"
**Cause**: Tool not returning proper response or agent stuck in reasoning loop
**Solutions**:
1. Set maxIterations lower: \`"parameters.maxIterations": 5\`
2. Improve tool descriptions to be more specific
3. Add system message guidance: "Use tools efficiently, don't repeat actions"
---
## Quick Reference
### Essential Tools
| Tool | Purpose | Key Parameters |
|------|---------|----------------|
| HTTP Request Tool | API calls | toolDescription, url, placeholders |
| Code Tool | Custom logic | name, description, code, inputSchema |
| Vector Store Tool | Knowledge search | description, topK |
| AI Agent Tool | Sub-agents | name, description, systemMessage |
| MCP Client Tool | MCP protocol | description, mcpServer, tool |
### Connection Quick Codes
\`\`\`typescript
// Language Model → AI Agent
sourceOutput: "ai_languageModel"
// Tool → AI Agent
sourceOutput: "ai_tool"
// Memory → AI Agent
sourceOutput: "ai_memory"
// Parser → AI Agent
sourceOutput: "ai_outputParser"
// Embeddings → Vector Store
sourceOutput: "ai_embedding"
// Vector Store → Vector Store Tool
sourceOutput: "ai_vectorStore"
\`\`\`
### Validation Command
\`\`\`typescript
n8n_validate_workflow({id: "workflow_id"})
\`\`\`
---
## Related Resources
- **FINAL_AI_VALIDATION_SPEC.md**: Complete validation rules
- **n8n_update_partial_workflow**: Workflow modification tool
- **search_nodes({query: "AI", includeExamples: true})**: Find AI nodes with examples
- **get_node_essentials({nodeType: "...", includeExamples: true})**: Node details with examples
---
*This guide is part of the n8n-mcp documentation system. For questions or issues, refer to the validation spec or use tools_documentation() for specific topics.*`,
parameters: {},
returns: 'Complete AI Agents guide with architecture, patterns, validation, and troubleshooting',
examples: [
'tools_documentation({topic: "ai_agents_guide"}) - Full guide',
'tools_documentation({topic: "ai_agents_guide", depth: "essentials"}) - Quick reference',
'When user asks about AI Agents, Chat Trigger, or building AI workflows → Point to this guide'
],
useCases: [
'Learning AI Agent architecture in n8n',
'Understanding AI connection types and patterns',
'Building first AI Agent workflow step-by-step',
'Implementing advanced patterns (streaming, fallback, RAG, multi-agent)',
'Troubleshooting AI workflow issues',
'Validating AI workflows before deployment',
'Quick reference for connection types and tools'
],
performance: 'N/A - Static documentation',
bestPractices: [
'Reference this guide when users ask about AI Agents',
'Point to specific sections based on user needs',
'Combine with search_nodes(includeExamples=true) for working examples',
'Validate workflows after following guide instructions',
'Use FINAL_AI_VALIDATION_SPEC.md for detailed requirements'
],
pitfalls: [
'This is a guide, not an executable tool',
'Always validate workflows after making changes',
'AI connections require sourceOutput parameter',
'Streaming mode has specific constraints',
'Some features require specific AI Agent versions (v2.1+ for fallback)'
],
relatedTools: [
'n8n_create_workflow',
'n8n_update_partial_workflow',
'n8n_validate_workflow',
'search_nodes',
'get_node_essentials',
'list_ai_tools'
]
}
};

View File

@@ -1,2 +0,0 @@
// Export all guides
export { aiAgentsGuide } from './ai-agents-guide';

View File

@@ -25,15 +25,12 @@ import {
searchTemplatesByMetadataDoc,
getTemplatesForTaskDoc
} from './templates';
import {
import {
toolsDocumentationDoc,
n8nDiagnosticDoc,
n8nHealthCheckDoc,
n8nListAvailableToolsDoc
} from './system';
import {
aiAgentsGuide
} from './guides';
import {
n8nCreateWorkflowDoc,
n8nGetWorkflowDoc,
@@ -59,10 +56,7 @@ export const toolsDocumentation: Record<string, ToolDocumentation> = {
n8n_diagnostic: n8nDiagnosticDoc,
n8n_health_check: n8nHealthCheckDoc,
n8n_list_available_tools: n8nListAvailableToolsDoc,
// Guides
ai_agents_guide: aiAgentsGuide,
// Discovery tools
search_nodes: searchNodesDoc,
list_nodes: listNodesDoc,

View File

@@ -4,16 +4,14 @@ export const n8nDiagnosticDoc: ToolDocumentation = {
name: 'n8n_diagnostic',
category: 'system',
essentials: {
description: 'Comprehensive diagnostic with environment-aware debugging, version checks, performance metrics, and mode-specific troubleshooting',
description: 'Diagnose n8n API configuration and troubleshoot why n8n management tools might not be working',
keyParameters: ['verbose'],
example: 'n8n_diagnostic({verbose: true})',
performance: 'Fast - checks environment, API, and npm version (~180ms median)',
performance: 'Instant - checks environment and configuration only',
tips: [
'Now includes environment-aware debugging based on MCP_MODE (http/stdio)',
'Provides mode-specific troubleshooting (HTTP server vs Claude Desktop)',
'Detects Docker and cloud platforms for targeted guidance',
'Shows performance metrics: response time and cache statistics',
'Includes data-driven tips based on 82% user success rate'
'Run first when n8n tools are missing or failing - shows exact configuration issues',
'Use verbose=true for detailed debugging info including environment variables',
'If tools are missing, check that N8N_API_URL and N8N_API_KEY are configured'
]
},
full: {
@@ -37,31 +35,15 @@ The diagnostic is essential when:
default: false
}
},
returns: `Comprehensive diagnostic report containing:
- timestamp: ISO timestamp of diagnostic run
- environment: Enhanced environment variables
- N8N_API_URL, N8N_API_KEY (masked), NODE_ENV, MCP_MODE
- isDocker: Boolean indicating if running in Docker
- cloudPlatform: Detected cloud platform (railway/render/fly/etc.) or null
- nodeVersion: Node.js version
- platform: OS platform (darwin/win32/linux)
- apiConfiguration: API configuration and connectivity status
- configured, status (connected/error/version), config details
- versionInfo: Version check results (current, latest, upToDate, message, updateCommand)
- toolsAvailability: Tool availability breakdown (doc tools + management tools)
- performance: Performance metrics (responseTimeMs, cacheHitRate, cachedInstances)
- modeSpecificDebug: Mode-specific debugging (ALWAYS PRESENT)
- HTTP mode: port, authTokenConfigured, serverUrl, healthCheckUrl, troubleshooting steps, commonIssues
- stdio mode: configLocation, troubleshooting steps, commonIssues
- dockerDebug: Docker-specific guidance (if IS_DOCKER=true)
- containerDetected, troubleshooting steps, commonIssues
- cloudPlatformDebug: Cloud platform-specific tips (if platform detected)
- name, troubleshooting steps tailored to platform (Railway/Render/Fly/K8s/AWS/etc.)
- nextSteps: Context-specific guidance (if API connected)
- troubleshooting: Troubleshooting guidance (if API not connecting)
- setupGuide: Setup guidance (if API not configured)
- updateWarning: Update recommendation (if version outdated)
- debug: Verbose debug information (if verbose=true)`,
returns: `Diagnostic report object containing:
- status: Overall health status ('ok', 'error', 'not_configured')
- apiUrl: Detected API URL (or null if not configured)
- apiKeyStatus: Status of API key ('configured', 'missing', 'invalid')
- toolsAvailable: Number of n8n management tools available
- connectivity: API connectivity test results
- errors: Array of specific error messages
- suggestions: Array of actionable fix suggestions
- verbose: Additional debug information (if verbose=true)`,
examples: [
'n8n_diagnostic({}) - Quick diagnostic check',
'n8n_diagnostic({verbose: true}) - Detailed diagnostic with environment info',

View File

@@ -4,15 +4,14 @@ export const n8nHealthCheckDoc: ToolDocumentation = {
name: 'n8n_health_check',
category: 'system',
essentials: {
description: 'Check n8n instance health, API connectivity, version status, and performance metrics',
description: 'Check n8n instance health, API connectivity, and available features',
keyParameters: [],
example: 'n8n_health_check({})',
performance: 'Fast - single API call (~150-200ms median)',
performance: 'Fast - single API call to health endpoint',
tips: [
'Use before starting workflow operations to ensure n8n is responsive',
'Automatically checks if n8n-mcp version is outdated',
'Returns version info, performance metrics, and next-step recommendations',
'New: Shows cache hit rate and response time for performance monitoring'
'Check regularly in production environments for monitoring',
'Returns version info and feature availability for compatibility checks'
]
},
full: {
@@ -34,27 +33,17 @@ Health checks are crucial for:
parameters: {},
returns: `Health status object containing:
- status: Overall health status ('healthy', 'degraded', 'error')
- n8nVersion: n8n instance version information
- version: n8n instance version information
- instanceId: Unique identifier for the n8n instance
- features: Object listing available features and their status
- mcpVersion: Current n8n-mcp version
- supportedN8nVersion: Recommended n8n version for compatibility
- versionCheck: Version status information
- current: Current n8n-mcp version
- latest: Latest available version from npm
- upToDate: Boolean indicating if version is current
- message: Formatted version status message
- updateCommand: Command to update (if outdated)
- performance: Performance metrics
- responseTimeMs: API response time in milliseconds
- cacheHitRate: Cache efficiency percentage
- cachedInstances: Number of cached API instances
- nextSteps: Recommended actions after health check
- updateWarning: Warning if version is outdated (if applicable)`,
- apiVersion: API version for compatibility checking
- responseTime: API response time in milliseconds
- timestamp: Check timestamp
- details: Additional health metrics from n8n`,
examples: [
'n8n_health_check({}) - Complete health check with version and performance data',
'// Use in monitoring scripts\nconst health = await n8n_health_check({});\nif (health.status !== "ok") alert("n8n is down!");\nif (!health.versionCheck.upToDate) console.log("Update available:", health.versionCheck.updateCommand);',
'// Check before critical operations\nconst health = await n8n_health_check({});\nif (health.performance.responseTimeMs > 1000) console.warn("n8n is slow");\nif (health.versionCheck.isOutdated) console.log(health.updateWarning);'
'n8n_health_check({}) - Standard health check',
'// Use in monitoring scripts\nconst health = await n8n_health_check({});\nif (health.status !== "healthy") alert("n8n is down!");',
'// Check before critical operations\nconst health = await n8n_health_check({});\nif (health.responseTime > 1000) console.warn("n8n is slow");'
],
useCases: [
'Pre-flight checks before workflow deployments',

View File

@@ -11,8 +11,7 @@ export const validateNodeOperationDoc: ToolDocumentation = {
tips: [
'Profile choices: minimal (editing), runtime (execution), ai-friendly (balanced), strict (deployment)',
'Returns fixes you can apply directly',
'Operation-aware - knows Slack post needs text',
'Validates operator structures for IF v2.2+ and Switch v3.2+ nodes'
'Operation-aware - knows Slack post needs text'
]
},
full: {
@@ -72,9 +71,7 @@ export const validateNodeOperationDoc: ToolDocumentation = {
'Validate configuration before workflow execution',
'Debug why a node isn\'t working as expected',
'Generate configuration fixes automatically',
'Different validation for editing vs production',
'Check IF/Switch operator structures (binary vs unary operators)',
'Validate conditions.options metadata for filter-based nodes'
'Different validation for editing vs production'
],
performance: '<100ms for most nodes, <200ms for complex nodes with many conditions',
bestPractices: [
@@ -88,10 +85,7 @@ export const validateNodeOperationDoc: ToolDocumentation = {
pitfalls: [
'Must include operation fields for multi-operation nodes',
'Fixes are suggestions - review before applying',
'Profile affects what\'s validated - minimal skips many checks',
'**Binary vs Unary operators**: Binary operators (equals, contains, greaterThan) must NOT have singleValue:true. Unary operators (isEmpty, isNotEmpty, true, false) REQUIRE singleValue:true',
'**IF v2.2+ and Switch v3.2+ nodes**: Must have complete conditions.options structure: {version: 2, leftValue: "", caseSensitive: true/false, typeValidation: "strict"}',
'**Operator type field**: Must be data type (string/number/boolean/dateTime/array/object), NOT operation name (e.g., use type:"string" operation:"equals", not type:"equals")'
'Profile affects what\'s validated - minimal skips many checks'
],
relatedTools: ['validate_node_minimal for quick checks', 'get_node_essentials for valid examples', 'validate_workflow for complete workflow validation']
}

View File

@@ -11,8 +11,7 @@ export const validateWorkflowDoc: ToolDocumentation = {
tips: [
'Always validate before n8n_create_workflow to catch errors early',
'Use options.profile="minimal" for quick checks during development',
'AI tool connections are automatically validated for proper node references',
'Detects operator structure issues (binary vs unary, singleValue requirements)'
'AI tool connections are automatically validated for proper node references'
]
},
full: {
@@ -68,9 +67,7 @@ export const validateWorkflowDoc: ToolDocumentation = {
'Use minimal profile during development, strict profile before production',
'Pay attention to warnings - they often indicate potential runtime issues',
'Validate after any workflow modifications, especially connection changes',
'Check statistics to understand workflow complexity',
'**Auto-sanitization runs during create/update**: Operator structures and missing metadata are automatically fixed when workflows are created or updated, but validation helps catch issues before they reach n8n',
'If validation detects operator issues, they will be auto-fixed during n8n_create_workflow or n8n_update_partial_workflow'
'Check statistics to understand workflow complexity'
],
pitfalls: [
'Large workflows (100+ nodes) may take longer to validate',

View File

@@ -11,8 +11,7 @@ export const n8nCreateWorkflowDoc: ToolDocumentation = {
tips: [
'Workflow created inactive',
'Returns ID for future updates',
'Validate first with validate_workflow',
'Auto-sanitization fixes operator structures and missing metadata during creation'
'Validate first with validate_workflow'
]
},
full: {
@@ -91,9 +90,7 @@ n8n_create_workflow({
'Workflows created in INACTIVE state - must activate separately',
'Node IDs must be unique within workflow',
'Credentials must be configured separately in n8n',
'Node type names must include package prefix (e.g., "n8n-nodes-base.slack")',
'**Auto-sanitization runs on creation**: All nodes sanitized before workflow created (operator structures fixed, missing metadata added)',
'**Auto-sanitization cannot prevent all failures**: Broken connections or invalid node configurations may still cause creation to fail'
'Node type names must include package prefix (e.g., "n8n-nodes-base.slack")'
],
relatedTools: ['validate_workflow', 'n8n_update_partial_workflow', 'n8n_trigger_webhook_workflow']
}

View File

@@ -4,7 +4,7 @@ export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
name: 'n8n_update_partial_workflow',
category: 'workflow_management',
essentials: {
description: 'Update workflow incrementally with diff operations. Types: addNode, removeNode, updateNode, moveNode, enable/disableNode, addConnection, removeConnection, rewireConnection, cleanStaleConnections, replaceConnections, updateSettings, updateName, add/removeTag. Supports smart parameters (branch, case) for multi-output nodes. Full support for AI connections (ai_languageModel, ai_tool, ai_memory, ai_embedding, ai_vectorStore, ai_document, ai_textSplitter, ai_outputParser).',
description: 'Update workflow incrementally with diff operations. Types: addNode, removeNode, updateNode, moveNode, enable/disableNode, addConnection, removeConnection, rewireConnection, cleanStaleConnections, replaceConnections, updateSettings, updateName, add/removeTag. Supports smart parameters (branch, case) for multi-output nodes.',
keyParameters: ['id', 'operations', 'continueOnError'],
example: 'n8n_update_partial_workflow({id: "wf_123", operations: [{type: "rewireConnection", source: "IF", from: "Old", to: "New", branch: "true"}]})',
performance: 'Fast (50-200ms)',
@@ -15,10 +15,7 @@ export const n8nUpdatePartialWorkflowDoc: ToolDocumentation = {
'Use cleanStaleConnections to auto-remove broken connections',
'Set ignoreErrors:true on removeConnection for cleanup',
'Use continueOnError mode for best-effort bulk operations',
'Validate with validateOnly first',
'For AI connections, specify sourceOutput type (ai_languageModel, ai_tool, etc.)',
'Batch AI component connections for atomic updates',
'Auto-sanitization: ALL nodes auto-fixed during updates (operator structures, missing metadata)'
'Validate with validateOnly first'
]
},
full: {
@@ -60,32 +57,6 @@ For **Switch nodes**, use semantic 'case' parameter:
Works with addConnection and rewireConnection operations. Explicit sourceIndex overrides smart parameters.
## AI Connection Support
Full support for all 8 AI connection types used in n8n AI workflows:
**Connection Types**:
- **ai_languageModel**: Connect language models (OpenAI, Anthropic, Google Gemini) to AI Agents
- **ai_tool**: Connect tools (HTTP Request Tool, Code Tool, etc.) to AI Agents
- **ai_memory**: Connect memory systems (Window Buffer, Conversation Summary) to AI Agents
- **ai_outputParser**: Connect output parsers (Structured, JSON) to AI Agents
- **ai_embedding**: Connect embedding models to Vector Stores
- **ai_vectorStore**: Connect vector stores to Vector Store Tools
- **ai_document**: Connect document loaders to Vector Stores
- **ai_textSplitter**: Connect text splitters to document processing chains
**AI Connection Examples**:
- Single connection: \`{type: "addConnection", source: "OpenAI", target: "AI Agent", sourceOutput: "ai_languageModel"}\`
- Fallback model: Use targetIndex (0=primary, 1=fallback) for dual language model setup
- Multiple tools: Batch multiple \`sourceOutput: "ai_tool"\` connections to one AI Agent
- Vector retrieval: Chain ai_embedding → ai_vectorStore → ai_tool → AI Agent
**Best Practices**:
- Always specify \`sourceOutput\` for AI connections (defaults to "main" if omitted)
- Connect language model BEFORE creating/enabling AI Agent (validation requirement)
- Use atomic mode (default) when setting up AI workflows to ensure complete configuration
- Validate AI workflows after changes with \`n8n_validate_workflow\` tool
## Cleanup & Recovery Features
### Automatic Cleanup
@@ -95,41 +66,7 @@ The **cleanStaleConnections** operation automatically removes broken connection
Set **continueOnError: true** to apply valid operations even if some fail. Returns detailed results showing which operations succeeded/failed. Perfect for bulk cleanup operations.
### Graceful Error Handling
Add **ignoreErrors: true** to removeConnection operations to prevent failures when connections don't exist.
## Auto-Sanitization System
### What Gets Auto-Fixed
When ANY workflow update is made, ALL nodes in the workflow are automatically sanitized to ensure complete metadata and correct structure:
1. **Operator Structure Fixes**:
- Binary operators (equals, contains, greaterThan, etc.) automatically have \`singleValue\` removed
- Unary operators (isEmpty, isNotEmpty, true, false) automatically get \`singleValue: true\` added
- Invalid operator structures (e.g., \`{type: "isNotEmpty"}\`) are corrected to \`{type: "boolean", operation: "isNotEmpty"}\`
2. **Missing Metadata Added**:
- IF v2.2+ nodes get complete \`conditions.options\` structure if missing
- Switch v3.2+ nodes get complete \`conditions.options\` for all rules
- Required fields: \`{version: 2, leftValue: "", caseSensitive: true, typeValidation: "strict"}\`
### Sanitization Scope
- Runs on **ALL nodes** in the workflow, not just modified ones
- Triggered by ANY update operation (addNode, updateNode, addConnection, etc.)
- Prevents workflow corruption that would make UI unrenderable
### Limitations
Auto-sanitization CANNOT fix:
- Broken connections (connections referencing non-existent nodes) - use \`cleanStaleConnections\`
- Branch count mismatches (e.g., Switch with 3 rules but only 2 outputs) - requires manual connection fixes
- Workflows in paradoxical corrupt states (API returns corrupt data, API rejects updates) - must recreate workflow
### Recovery Guidance
If validation still fails after auto-sanitization:
1. Check error details for specific issues
2. Use \`validate_workflow\` to see all validation errors
3. For connection issues, use \`cleanStaleConnections\` operation
4. For branch mismatches, add missing output connections
5. For paradoxical corrupted workflows, create new workflow and migrate nodes`,
Add **ignoreErrors: true** to removeConnection operations to prevent failures when connections don't exist.`,
parameters: {
id: { type: 'string', required: true, description: 'Workflow ID to update' },
operations: {
@@ -155,18 +92,7 @@ If validation still fails after auto-sanitization:
'// Remove connection gracefully (no error if it doesn\'t exist)\nn8n_update_partial_workflow({id: "stu", operations: [{type: "removeConnection", source: "Old Node", target: "Target", ignoreErrors: true}]})',
'// Best-effort mode: apply what works, report what fails\nn8n_update_partial_workflow({id: "vwx", operations: [\n {type: "updateName", name: "Fixed Workflow"},\n {type: "removeConnection", source: "Broken", target: "Node"},\n {type: "cleanStaleConnections"}\n], continueOnError: true})',
'// Update node parameter\nn8n_update_partial_workflow({id: "yza", operations: [{type: "updateNode", nodeName: "HTTP Request", updates: {"parameters.url": "https://api.example.com"}}]})',
'// Validate before applying\nn8n_update_partial_workflow({id: "bcd", operations: [{type: "removeNode", nodeName: "Old Process"}], validateOnly: true})',
'\n// ============ AI CONNECTION EXAMPLES ============',
'// Connect language model to AI Agent\nn8n_update_partial_workflow({id: "ai1", operations: [{type: "addConnection", source: "OpenAI Chat Model", target: "AI Agent", sourceOutput: "ai_languageModel"}]})',
'// Connect tool to AI Agent\nn8n_update_partial_workflow({id: "ai2", operations: [{type: "addConnection", source: "HTTP Request Tool", target: "AI Agent", sourceOutput: "ai_tool"}]})',
'// Connect memory to AI Agent\nn8n_update_partial_workflow({id: "ai3", operations: [{type: "addConnection", source: "Window Buffer Memory", target: "AI Agent", sourceOutput: "ai_memory"}]})',
'// Connect output parser to AI Agent\nn8n_update_partial_workflow({id: "ai4", operations: [{type: "addConnection", source: "Structured Output Parser", target: "AI Agent", sourceOutput: "ai_outputParser"}]})',
'// Complete AI Agent setup: Add language model, tools, and memory\nn8n_update_partial_workflow({id: "ai5", operations: [\n {type: "addConnection", source: "OpenAI Chat Model", target: "AI Agent", sourceOutput: "ai_languageModel"},\n {type: "addConnection", source: "HTTP Request Tool", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "Code Tool", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "Window Buffer Memory", target: "AI Agent", sourceOutput: "ai_memory"}\n]})',
'// Add fallback model to AI Agent (requires v2.1+)\nn8n_update_partial_workflow({id: "ai6", operations: [\n {type: "addConnection", source: "OpenAI Chat Model", target: "AI Agent", sourceOutput: "ai_languageModel", targetIndex: 0},\n {type: "addConnection", source: "Anthropic Chat Model", target: "AI Agent", sourceOutput: "ai_languageModel", targetIndex: 1}\n]})',
'// Vector Store setup: Connect embeddings and documents\nn8n_update_partial_workflow({id: "ai7", operations: [\n {type: "addConnection", source: "Embeddings OpenAI", target: "Pinecone Vector Store", sourceOutput: "ai_embedding"},\n {type: "addConnection", source: "Default Data Loader", target: "Pinecone Vector Store", sourceOutput: "ai_document"}\n]})',
'// Connect Vector Store Tool to AI Agent (retrieval setup)\nn8n_update_partial_workflow({id: "ai8", operations: [\n {type: "addConnection", source: "Pinecone Vector Store", target: "Vector Store Tool", sourceOutput: "ai_vectorStore"},\n {type: "addConnection", source: "Vector Store Tool", target: "AI Agent", sourceOutput: "ai_tool"}\n]})',
'// Rewire AI Agent to use different language model\nn8n_update_partial_workflow({id: "ai9", operations: [{type: "rewireConnection", source: "AI Agent", from: "OpenAI Chat Model", to: "Anthropic Chat Model", sourceOutput: "ai_languageModel"}]})',
'// Replace all AI tools for an agent\nn8n_update_partial_workflow({id: "ai10", operations: [\n {type: "removeConnection", source: "Old Tool 1", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "removeConnection", source: "Old Tool 2", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New HTTP Tool", target: "AI Agent", sourceOutput: "ai_tool"},\n {type: "addConnection", source: "New Code Tool", target: "AI Agent", sourceOutput: "ai_tool"}\n]})'
'// Validate before applying\nn8n_update_partial_workflow({id: "bcd", operations: [{type: "removeNode", nodeName: "Old Process"}], validateOnly: true})'
],
useCases: [
'Rewire connections when replacing nodes',
@@ -178,13 +104,7 @@ If validation still fails after auto-sanitization:
'Graceful cleanup operations that don\'t fail',
'Enable/disable nodes',
'Rename workflows or nodes',
'Manage tags efficiently',
'Connect AI components (language models, tools, memory, parsers)',
'Set up AI Agent workflows with multiple tools',
'Add fallback language models to AI Agents',
'Configure Vector Store retrieval systems',
'Swap language models in existing AI workflows',
'Batch-update AI tool connections'
'Manage tags efficiently'
],
performance: 'Very fast - typically 50-200ms. Much faster than full updates as only changes are processed.',
bestPractices: [
@@ -197,12 +117,7 @@ If validation still fails after auto-sanitization:
'Use validateOnly to test operations before applying',
'Group related changes in one call',
'Check operation order for dependencies',
'Use atomic mode (default) for critical updates',
'For AI connections, always specify sourceOutput (ai_languageModel, ai_tool, ai_memory, etc.)',
'Connect language model BEFORE adding AI Agent to ensure validation passes',
'Use targetIndex for fallback models (primary=0, fallback=1)',
'Batch AI component connections in a single operation for atomicity',
'Validate AI workflows after connection changes to catch configuration errors'
'Use atomic mode (default) for critical updates'
],
pitfalls: [
'**REQUIRES N8N_API_URL and N8N_API_KEY environment variables** - will not work without n8n API access',
@@ -216,11 +131,7 @@ If validation still fails after auto-sanitization:
'Smart parameters (branch, case) only work with IF and Switch nodes - ignored for other node types',
'Explicit sourceIndex overrides smart parameters (branch, case) if both provided',
'cleanStaleConnections removes ALL broken connections - cannot be selective',
'replaceConnections overwrites entire connections object - all previous connections lost',
'**Auto-sanitization behavior**: Binary operators (equals, contains) automatically have singleValue removed; unary operators (isEmpty, isNotEmpty) automatically get singleValue:true added',
'**Auto-sanitization runs on ALL nodes**: When ANY update is made, ALL nodes in the workflow are sanitized (not just modified ones)',
'**Auto-sanitization cannot fix everything**: It fixes operator structures and missing metadata, but cannot fix broken connections or branch mismatches',
'**Corrupted workflows beyond repair**: Workflows in paradoxical states (API returns corrupt, API rejects updates) cannot be fixed via API - must be recreated'
'replaceConnections overwrites entire connections object - all previous connections lost'
],
relatedTools: ['n8n_update_full_workflow', 'n8n_get_workflow', 'validate_workflow', 'tools_documentation']
}

View File

@@ -1,14 +1,4 @@
import { PropertyExtractor } from './property-extractor';
import type {
NodeClass,
VersionedNodeInstance
} from '../types/node-types';
import {
isVersionedNodeInstance,
isVersionedNodeClass,
getNodeDescription as getNodeDescriptionHelper
} from '../types/node-types';
import type { INodeTypeBaseDescription, INodeTypeDescription } from 'n8n-workflow';
export interface ParsedNode {
style: 'declarative' | 'programmatic';
@@ -32,9 +22,9 @@ export interface ParsedNode {
export class NodeParser {
private propertyExtractor = new PropertyExtractor();
private currentNodeClass: NodeClass | null = null;
parse(nodeClass: NodeClass, packageName: string): ParsedNode {
private currentNodeClass: any = null;
parse(nodeClass: any, packageName: string): ParsedNode {
this.currentNodeClass = nodeClass;
// Get base description (handles versioned nodes)
const description = this.getNodeDescription(nodeClass);
@@ -60,64 +50,46 @@ export class NodeParser {
};
}
private getNodeDescription(nodeClass: NodeClass): INodeTypeBaseDescription | INodeTypeDescription {
private getNodeDescription(nodeClass: any): any {
// Try to get description from the class first
let description: INodeTypeBaseDescription | INodeTypeDescription | undefined;
// Check if it's a versioned node using type guard
if (isVersionedNodeClass(nodeClass)) {
let description: any;
// Check if it's a versioned node (has baseDescription and nodeVersions)
if (typeof nodeClass === 'function' && nodeClass.prototype &&
nodeClass.prototype.constructor &&
nodeClass.prototype.constructor.name === 'VersionedNodeType') {
// This is a VersionedNodeType class - instantiate it
try {
const instance = new (nodeClass as new () => VersionedNodeInstance)();
// Strategic any assertion for accessing both description and baseDescription
const inst = instance as any;
// Try description first (real VersionedNodeType with getter)
// Only fallback to baseDescription if nodeVersions exists (complete VersionedNodeType mock)
// This prevents using baseDescription for incomplete mocks that test edge cases
description = inst.description || (inst.nodeVersions ? inst.baseDescription : undefined);
// If still undefined (incomplete mock), leave as undefined to use catch block fallback
} catch (e) {
// Some nodes might require parameters to instantiate
}
const instance = new nodeClass();
description = instance.baseDescription || {};
} else if (typeof nodeClass === 'function') {
// Try to instantiate to get description
try {
const instance = new nodeClass();
description = instance.description;
// If description is empty or missing name, check for baseDescription fallback
if (!description || !description.name) {
const inst = instance as any;
if (inst.baseDescription?.name) {
description = inst.baseDescription;
}
description = instance.description || {};
// For versioned nodes, we might need to look deeper
if (!description.name && instance.baseDescription) {
description = instance.baseDescription;
}
} catch (e) {
// Some nodes might require parameters to instantiate
// Try to access static properties
description = (nodeClass as any).description;
description = nodeClass.description || {};
}
} else {
// Maybe it's already an instance
description = nodeClass.description;
// If description is empty or missing name, check for baseDescription fallback
if (!description || !description.name) {
const inst = nodeClass as any;
if (inst.baseDescription?.name) {
description = inst.baseDescription;
}
}
description = nodeClass.description || {};
}
return description || ({} as any);
return description;
}
private detectStyle(nodeClass: NodeClass): 'declarative' | 'programmatic' {
private detectStyle(nodeClass: any): 'declarative' | 'programmatic' {
const desc = this.getNodeDescription(nodeClass);
return (desc as any).routing ? 'declarative' : 'programmatic';
return desc.routing ? 'declarative' : 'programmatic';
}
private extractNodeType(description: INodeTypeBaseDescription | INodeTypeDescription, packageName: string): string {
private extractNodeType(description: any, packageName: string): string {
// Ensure we have the full node type including package prefix
const name = description.name;
@@ -134,97 +106,57 @@ export class NodeParser {
return `${packagePrefix}.${name}`;
}
private extractCategory(description: INodeTypeBaseDescription | INodeTypeDescription): string {
return description.group?.[0] ||
(description as any).categories?.[0] ||
(description as any).category ||
private extractCategory(description: any): string {
return description.group?.[0] ||
description.categories?.[0] ||
description.category ||
'misc';
}
private detectTrigger(description: INodeTypeBaseDescription | INodeTypeDescription): boolean {
// Strategic any assertion for properties that only exist on INodeTypeDescription
const desc = description as any;
private detectTrigger(description: any): boolean {
// Primary check: group includes 'trigger'
if (description.group && Array.isArray(description.group)) {
if (description.group.includes('trigger')) {
return true;
}
}
// Fallback checks for edge cases
return desc.polling === true ||
desc.trigger === true ||
desc.eventTrigger === true ||
return description.polling === true ||
description.trigger === true ||
description.eventTrigger === true ||
description.name?.toLowerCase().includes('trigger');
}
private detectWebhook(description: INodeTypeBaseDescription | INodeTypeDescription): boolean {
const desc = description as any; // INodeTypeDescription has webhooks, but INodeTypeBaseDescription doesn't
return (desc.webhooks?.length > 0) ||
desc.webhook === true ||
private detectWebhook(description: any): boolean {
return (description.webhooks?.length > 0) ||
description.webhook === true ||
description.name?.toLowerCase().includes('webhook');
}
/**
* Extracts the version from a node class.
*
* Priority Chain:
* 1. Instance currentVersion (VersionedNodeType's computed property)
* 2. Instance description.defaultVersion (explicit default)
* 3. Instance nodeVersions (fallback to max available version)
* 4. Description version array (legacy nodes)
* 5. Description version scalar (simple versioning)
* 6. Class-level properties (if instantiation fails)
* 7. Default to "1"
*
* Critical Fix (v2.17.4): Removed check for non-existent instance.baseDescription.defaultVersion
* which caused AI Agent to incorrectly return version "3" instead of "2.2"
*
* @param nodeClass - The node class or instance to extract version from
* @returns The version as a string
*/
private extractVersion(nodeClass: NodeClass): string {
// Check instance properties first
private extractVersion(nodeClass: any): string {
// Check instance for baseDescription first
try {
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
// Strategic any assertion - instance could be INodeType or IVersionedNodeType
const inst = instance as any;
// PRIORITY 1: Check currentVersion (what VersionedNodeType actually uses)
// For VersionedNodeType, currentVersion = defaultVersion ?? max(nodeVersions)
if (inst?.currentVersion !== undefined) {
return inst.currentVersion.toString();
// Handle instance-level baseDescription
if (instance?.baseDescription?.defaultVersion) {
return instance.baseDescription.defaultVersion.toString();
}
// PRIORITY 2: Handle instance-level description.defaultVersion
// VersionedNodeType stores baseDescription as 'description', not 'baseDescription'
if (inst?.description?.defaultVersion) {
return inst.description.defaultVersion.toString();
// Handle instance-level nodeVersions
if (instance?.nodeVersions) {
const versions = Object.keys(instance.nodeVersions);
return Math.max(...versions.map(Number)).toString();
}
// PRIORITY 3: Handle instance-level nodeVersions (fallback to max)
if (inst?.nodeVersions) {
const versions = Object.keys(inst.nodeVersions).map(Number);
if (versions.length > 0) {
const maxVersion = Math.max(...versions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
}
// Handle version array in description (e.g., [1, 1.1, 1.2])
if (inst?.description?.version) {
const version = inst.description.version;
if (instance?.description?.version) {
const version = instance.description.version;
if (Array.isArray(version)) {
const numericVersions = version.map((v: any) => parseFloat(v.toString()));
if (numericVersions.length > 0) {
const maxVersion = Math.max(...numericVersions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
// Find the maximum version from the array
const maxVersion = Math.max(...version.map((v: any) => parseFloat(v.toString())));
return maxVersion.toString();
} else if (typeof version === 'number' || typeof version === 'string') {
return version.toString();
}
@@ -233,119 +165,94 @@ export class NodeParser {
// Some nodes might require parameters to instantiate
// Try class-level properties
}
// Handle class-level VersionedNodeType with defaultVersion
// Note: Most VersionedNodeType classes don't have static properties
// Strategic any assertion for class-level property access
const nodeClassAny = nodeClass as any;
if (nodeClassAny.description?.defaultVersion) {
return nodeClassAny.description.defaultVersion.toString();
if (nodeClass.baseDescription?.defaultVersion) {
return nodeClass.baseDescription.defaultVersion.toString();
}
// Handle class-level VersionedNodeType with nodeVersions
if (nodeClassAny.nodeVersions) {
const versions = Object.keys(nodeClassAny.nodeVersions).map(Number);
if (versions.length > 0) {
const maxVersion = Math.max(...versions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
if (nodeClass.nodeVersions) {
const versions = Object.keys(nodeClass.nodeVersions);
return Math.max(...versions.map(Number)).toString();
}
// Also check class-level description for version array
const description = this.getNodeDescription(nodeClass);
const desc = description as any; // Strategic assertion for version property
if (desc?.version) {
if (Array.isArray(desc.version)) {
const numericVersions = desc.version.map((v: any) => parseFloat(v.toString()));
if (numericVersions.length > 0) {
const maxVersion = Math.max(...numericVersions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
} else if (typeof desc.version === 'number' || typeof desc.version === 'string') {
return desc.version.toString();
if (description?.version) {
if (Array.isArray(description.version)) {
const maxVersion = Math.max(...description.version.map((v: any) => parseFloat(v.toString())));
return maxVersion.toString();
} else if (typeof description.version === 'number' || typeof description.version === 'string') {
return description.version.toString();
}
}
// Default to version 1
return '1';
}
private detectVersioned(nodeClass: NodeClass): boolean {
private detectVersioned(nodeClass: any): boolean {
// Check instance-level properties first
try {
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
// Strategic any assertion - instance could be INodeType or IVersionedNodeType
const inst = instance as any;
// Check for instance baseDescription with defaultVersion
if (inst?.baseDescription?.defaultVersion) {
if (instance?.baseDescription?.defaultVersion) {
return true;
}
// Check for nodeVersions
if (inst?.nodeVersions) {
if (instance?.nodeVersions) {
return true;
}
// Check for version array in description
if (inst?.description?.version && Array.isArray(inst.description.version)) {
if (instance?.description?.version && Array.isArray(instance.description.version)) {
return true;
}
} catch (e) {
// Some nodes might require parameters to instantiate
// Try class-level checks
}
// Check class-level nodeVersions
// Strategic any assertion for class-level property access
const nodeClassAny = nodeClass as any;
if (nodeClassAny.nodeVersions || nodeClassAny.baseDescription?.defaultVersion) {
if (nodeClass.nodeVersions || nodeClass.baseDescription?.defaultVersion) {
return true;
}
// Also check class-level description for version array
const description = this.getNodeDescription(nodeClass);
const desc = description as any; // Strategic assertion for version property
if (desc?.version && Array.isArray(desc.version)) {
if (description?.version && Array.isArray(description.version)) {
return true;
}
return false;
}
private extractOutputs(description: INodeTypeBaseDescription | INodeTypeDescription): { outputs?: any[], outputNames?: string[] } {
private extractOutputs(description: any): { outputs?: any[], outputNames?: string[] } {
const result: { outputs?: any[], outputNames?: string[] } = {};
// Strategic any assertion for outputs/outputNames properties
const desc = description as any;
// First check the base description
if (desc.outputs) {
result.outputs = Array.isArray(desc.outputs) ? desc.outputs : [desc.outputs];
if (description.outputs) {
result.outputs = Array.isArray(description.outputs) ? description.outputs : [description.outputs];
}
if (desc.outputNames) {
result.outputNames = Array.isArray(desc.outputNames) ? desc.outputNames : [desc.outputNames];
if (description.outputNames) {
result.outputNames = Array.isArray(description.outputNames) ? description.outputNames : [description.outputNames];
}
// If no outputs found and this is a versioned node, check the latest version
if (!result.outputs && !result.outputNames) {
const nodeClass = this.currentNodeClass; // We'll need to track this
if (nodeClass) {
try {
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
// Strategic any assertion for instance properties
const inst = instance as any;
if (inst.nodeVersions) {
const instance = new nodeClass();
if (instance.nodeVersions) {
// Get the latest version
const versions = Object.keys(inst.nodeVersions).map(Number);
if (versions.length > 0) {
const latestVersion = Math.max(...versions);
if (!isNaN(latestVersion)) {
const versionedDescription = inst.nodeVersions[latestVersion]?.description;
const versions = Object.keys(instance.nodeVersions).map(Number);
const latestVersion = Math.max(...versions);
const versionedDescription = instance.nodeVersions[latestVersion]?.description;
if (versionedDescription) {
if (versionedDescription.outputs) {
@@ -355,13 +262,11 @@ export class NodeParser {
}
if (versionedDescription.outputNames) {
result.outputNames = Array.isArray(versionedDescription.outputNames)
? versionedDescription.outputNames
result.outputNames = Array.isArray(versionedDescription.outputNames)
? versionedDescription.outputNames
: [versionedDescription.outputNames];
}
}
}
}
}
} catch (e) {
// Ignore errors from instantiating node

View File

@@ -1,10 +1,8 @@
import type { NodeClass } from '../types/node-types';
export class PropertyExtractor {
/**
* Extract properties with proper handling of n8n's complex structures
*/
extractProperties(nodeClass: NodeClass): any[] {
extractProperties(nodeClass: any): any[] {
const properties: any[] = [];
// First try to get instance-level properties
@@ -17,16 +15,12 @@ export class PropertyExtractor {
// Handle versioned nodes - check instance for nodeVersions
if (instance?.nodeVersions) {
const versions = Object.keys(instance.nodeVersions).map(Number);
if (versions.length > 0) {
const latestVersion = Math.max(...versions);
if (!isNaN(latestVersion)) {
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description?.properties) {
return this.normalizeProperties(versionedNode.description.properties);
}
}
const versions = Object.keys(instance.nodeVersions);
const latestVersion = Math.max(...versions.map(Number));
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description?.properties) {
return this.normalizeProperties(versionedNode.description.properties);
}
}
@@ -41,36 +35,30 @@ export class PropertyExtractor {
return properties;
}
private getNodeDescription(nodeClass: NodeClass): any {
private getNodeDescription(nodeClass: any): any {
// Try to get description from the class first
let description: any;
if (typeof nodeClass === 'function') {
// Try to instantiate to get description
try {
const instance = new nodeClass();
// Strategic any assertion for instance properties
const inst = instance as any;
description = inst.description || inst.baseDescription || {};
description = instance.description || instance.baseDescription || {};
} catch (e) {
// Some nodes might require parameters to instantiate
// Strategic any assertion for class-level properties
const nodeClassAny = nodeClass as any;
description = nodeClassAny.description || {};
description = nodeClass.description || {};
}
} else {
// Strategic any assertion for instance properties
const inst = nodeClass as any;
description = inst.description || {};
description = nodeClass.description || {};
}
return description;
}
/**
* Extract operations from both declarative and programmatic nodes
*/
extractOperations(nodeClass: NodeClass): any[] {
extractOperations(nodeClass: any): any[] {
const operations: any[] = [];
// First try to get instance-level data
@@ -83,16 +71,12 @@ export class PropertyExtractor {
// Handle versioned nodes
if (instance?.nodeVersions) {
const versions = Object.keys(instance.nodeVersions).map(Number);
if (versions.length > 0) {
const latestVersion = Math.max(...versions);
if (!isNaN(latestVersion)) {
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description) {
return this.extractOperationsFromDescription(versionedNode.description);
}
}
const versions = Object.keys(instance.nodeVersions);
const latestVersion = Math.max(...versions.map(Number));
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description) {
return this.extractOperationsFromDescription(versionedNode.description);
}
}
@@ -154,35 +138,33 @@ export class PropertyExtractor {
/**
* Deep search for AI tool capability
*/
detectAIToolCapability(nodeClass: NodeClass): boolean {
detectAIToolCapability(nodeClass: any): boolean {
const description = this.getNodeDescription(nodeClass);
// Direct property check
if (description?.usableAsTool === true) return true;
// Check in actions for declarative nodes
if (description?.actions?.some((a: any) => a.usableAsTool === true)) return true;
// Check versioned nodes
// Strategic any assertion for nodeVersions property
const nodeClassAny = nodeClass as any;
if (nodeClassAny.nodeVersions) {
for (const version of Object.values(nodeClassAny.nodeVersions)) {
if (nodeClass.nodeVersions) {
for (const version of Object.values(nodeClass.nodeVersions)) {
if ((version as any).description?.usableAsTool === true) return true;
}
}
// Check for specific AI-related properties
const aiIndicators = ['openai', 'anthropic', 'huggingface', 'cohere', 'ai'];
const nodeName = description?.name?.toLowerCase() || '';
return aiIndicators.some(indicator => nodeName.includes(indicator));
}
/**
* Extract credential requirements with proper structure
*/
extractCredentials(nodeClass: NodeClass): any[] {
extractCredentials(nodeClass: any): any[] {
const credentials: any[] = [];
// First try to get instance-level data
@@ -195,16 +177,12 @@ export class PropertyExtractor {
// Handle versioned nodes
if (instance?.nodeVersions) {
const versions = Object.keys(instance.nodeVersions).map(Number);
if (versions.length > 0) {
const latestVersion = Math.max(...versions);
if (!isNaN(latestVersion)) {
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description?.credentials) {
return versionedNode.description.credentials;
}
}
const versions = Object.keys(instance.nodeVersions);
const latestVersion = Math.max(...versions.map(Number));
const versionedNode = instance.nodeVersions[latestVersion];
if (versionedNode?.description?.credentials) {
return versionedNode.description.credentials;
}
}
@@ -231,7 +209,6 @@ export class PropertyExtractor {
required: prop.required,
displayOptions: prop.displayOptions,
typeOptions: prop.typeOptions,
modes: prop.modes, // For resourceLocator type properties - modes are at top level
noDataExpression: prop.noDataExpression
}));
}

View File

@@ -1,13 +1,3 @@
import type {
NodeClass,
VersionedNodeInstance
} from '../types/node-types';
import {
isVersionedNodeInstance,
isVersionedNodeClass
} from '../types/node-types';
import type { INodeTypeBaseDescription, INodeTypeDescription } from 'n8n-workflow';
export interface ParsedNode {
style: 'declarative' | 'programmatic';
nodeType: string;
@@ -25,32 +15,24 @@ export interface ParsedNode {
}
export class SimpleParser {
parse(nodeClass: NodeClass): ParsedNode {
let description: INodeTypeBaseDescription | INodeTypeDescription;
parse(nodeClass: any): ParsedNode {
let description: any;
let isVersioned = false;
// Try to get description from the class
try {
// Check if it's a versioned node using type guard
if (isVersionedNodeClass(nodeClass)) {
// Check if it's a versioned node (has baseDescription and nodeVersions)
if (typeof nodeClass === 'function' && nodeClass.prototype &&
nodeClass.prototype.constructor &&
nodeClass.prototype.constructor.name === 'VersionedNodeType') {
// This is a VersionedNodeType class - instantiate it
const instance = new (nodeClass as new () => VersionedNodeInstance)();
// Strategic any assertion for accessing both description and baseDescription
const inst = instance as any;
// Try description first (real VersionedNodeType with getter)
// Only fallback to baseDescription if nodeVersions exists (complete VersionedNodeType mock)
// This prevents using baseDescription for incomplete mocks that test edge cases
description = inst.description || (inst.nodeVersions ? inst.baseDescription : undefined);
// If still undefined (incomplete mock), use empty object to allow graceful failure later
if (!description) {
description = {} as any;
}
const instance = new nodeClass();
description = instance.baseDescription || {};
isVersioned = true;
// For versioned nodes, try to get properties from the current version
if (inst.nodeVersions && inst.currentVersion) {
const currentVersionNode = inst.nodeVersions[inst.currentVersion];
if (instance.nodeVersions && instance.currentVersion) {
const currentVersionNode = instance.nodeVersions[instance.currentVersion];
if (currentVersionNode && currentVersionNode.description) {
// Merge baseDescription with version-specific description
description = { ...description, ...currentVersionNode.description };
@@ -60,76 +42,63 @@ export class SimpleParser {
// Try to instantiate to get description
try {
const instance = new nodeClass();
description = instance.description;
// If description is empty or missing name, check for baseDescription fallback
if (!description || !description.name) {
const inst = instance as any;
if (inst.baseDescription?.name) {
description = inst.baseDescription;
}
description = instance.description || {};
// For versioned nodes, we might need to look deeper
if (!description.name && instance.baseDescription) {
description = instance.baseDescription;
isVersioned = true;
}
} catch (e) {
// Some nodes might require parameters to instantiate
// Try to access static properties or look for common patterns
description = {} as any;
description = {};
}
} else {
// Maybe it's already an instance
description = nodeClass.description;
// If description is empty or missing name, check for baseDescription fallback
if (!description || !description.name) {
const inst = nodeClass as any;
if (inst.baseDescription?.name) {
description = inst.baseDescription;
}
}
description = nodeClass.description || {};
}
} catch (error) {
// If instantiation fails, try to get static description
description = (nodeClass as any).description || ({} as any);
description = nodeClass.description || {};
}
// Strategic any assertion for properties that don't exist on both union sides
const desc = description as any;
const isDeclarative = !!desc.routing;
const isDeclarative = !!description.routing;
// Ensure we have a valid nodeType
if (!description.name) {
throw new Error('Node is missing name property');
}
return {
style: isDeclarative ? 'declarative' : 'programmatic',
nodeType: description.name,
displayName: description.displayName || description.name,
description: description.description,
category: description.group?.[0] || desc.categories?.[0],
properties: desc.properties || [],
credentials: desc.credentials || [],
isAITool: desc.usableAsTool === true,
category: description.group?.[0] || description.categories?.[0],
properties: description.properties || [],
credentials: description.credentials || [],
isAITool: description.usableAsTool === true,
isTrigger: this.detectTrigger(description),
isWebhook: desc.webhooks?.length > 0,
operations: isDeclarative ? this.extractOperations(desc.routing) : this.extractProgrammaticOperations(desc),
isWebhook: description.webhooks?.length > 0,
operations: isDeclarative ? this.extractOperations(description.routing) : this.extractProgrammaticOperations(description),
version: this.extractVersion(nodeClass),
isVersioned: isVersioned || this.isVersionedNode(nodeClass) || Array.isArray(desc.version) || desc.defaultVersion !== undefined
isVersioned: isVersioned || this.isVersionedNode(nodeClass) || Array.isArray(description.version) || description.defaultVersion !== undefined
};
}
private detectTrigger(description: INodeTypeBaseDescription | INodeTypeDescription): boolean {
private detectTrigger(description: any): boolean {
// Primary check: group includes 'trigger'
if (description.group && Array.isArray(description.group)) {
if (description.group.includes('trigger')) {
return true;
}
}
// Strategic any assertion for properties that only exist on INodeTypeDescription
const desc = description as any;
// Fallback checks for edge cases
return desc.polling === true ||
desc.trigger === true ||
desc.eventTrigger === true ||
return description.polling === true ||
description.trigger === true ||
description.eventTrigger === true ||
description.name?.toLowerCase().includes('trigger');
}
@@ -217,109 +186,48 @@ export class SimpleParser {
return operations;
}
/**
* Extracts the version from a node class.
*
* Priority Chain (same as node-parser.ts):
* 1. Instance currentVersion (VersionedNodeType's computed property)
* 2. Instance description.defaultVersion (explicit default)
* 3. Instance nodeVersions (fallback to max available version)
* 4. Instance description.version (simple versioning)
* 5. Class-level properties (if instantiation fails)
* 6. Default to "1"
*
* Critical Fix (v2.17.4): Removed check for non-existent instance.baseDescription.defaultVersion
* which caused AI Agent and other VersionedNodeType nodes to return wrong versions.
*
* @param nodeClass - The node class or instance to extract version from
* @returns The version as a string
*/
private extractVersion(nodeClass: NodeClass): string {
private extractVersion(nodeClass: any): string {
// Try to get version from instance first
try {
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
// Strategic any assertion for instance properties
const inst = instance as any;
// PRIORITY 1: Check currentVersion (what VersionedNodeType actually uses)
// For VersionedNodeType, currentVersion = defaultVersion ?? max(nodeVersions)
if (inst?.currentVersion !== undefined) {
return inst.currentVersion.toString();
// Check instance baseDescription
if (instance?.baseDescription?.defaultVersion) {
return instance.baseDescription.defaultVersion.toString();
}
// PRIORITY 2: Handle instance-level description.defaultVersion
// VersionedNodeType stores baseDescription as 'description', not 'baseDescription'
if (inst?.description?.defaultVersion) {
return inst.description.defaultVersion.toString();
}
// PRIORITY 3: Handle instance-level nodeVersions (fallback to max)
if (inst?.nodeVersions) {
const versions = Object.keys(inst.nodeVersions).map(Number);
if (versions.length > 0) {
const maxVersion = Math.max(...versions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
}
// PRIORITY 4: Check instance description version
if (inst?.description?.version) {
return inst.description.version.toString();
// Check instance description version
if (instance?.description?.version) {
return instance.description.version.toString();
}
} catch (e) {
// Ignore instantiation errors
}
// PRIORITY 5: Check class-level properties (if instantiation failed)
// Strategic any assertion for class-level properties
const nodeClassAny = nodeClass as any;
if (nodeClassAny.description?.defaultVersion) {
return nodeClassAny.description.defaultVersion.toString();
// Check class-level properties
if (nodeClass.baseDescription?.defaultVersion) {
return nodeClass.baseDescription.defaultVersion.toString();
}
if (nodeClassAny.nodeVersions) {
const versions = Object.keys(nodeClassAny.nodeVersions).map(Number);
if (versions.length > 0) {
const maxVersion = Math.max(...versions);
if (!isNaN(maxVersion)) {
return maxVersion.toString();
}
}
}
// PRIORITY 6: Default to version 1
return nodeClassAny.description?.version || '1';
return nodeClass.description?.version || '1';
}
private isVersionedNode(nodeClass: NodeClass): boolean {
// Strategic any assertion for class-level properties
const nodeClassAny = nodeClass as any;
// Check for VersionedNodeType pattern at class level
if (nodeClassAny.baseDescription && nodeClassAny.nodeVersions) {
private isVersionedNode(nodeClass: any): boolean {
// Check for VersionedNodeType pattern
if (nodeClass.baseDescription && nodeClass.nodeVersions) {
return true;
}
// Check for inline versioning pattern (like Code node)
try {
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
// Strategic any assertion for instance properties
const inst = instance as any;
// Check for VersionedNodeType pattern at instance level
if (inst.baseDescription && inst.nodeVersions) {
return true;
}
const description = inst.description || {};
const description = instance.description || {};
// If version is an array, it's versioned
if (Array.isArray(description.version)) {
return true;
}
// If it has defaultVersion, it's likely versioned
if (description.defaultVersion !== undefined) {
return true;
@@ -327,7 +235,7 @@ export class SimpleParser {
} catch (e) {
// Ignore instantiation errors
}
return false;
}
}

View File

@@ -116,6 +116,12 @@ function insertAndRankConfigs(db: any, configs: any[]) {
}
// Rank configs per node_type by template popularity
/**
* @security SQL: Static UPDATE statement with no user input.
* Template literal used for multi-line formatting only.
* See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-01)
*/
// eslint-disable-next-line no-restricted-syntax
db.exec(`
UPDATE template_node_configs
SET rank = (
@@ -127,6 +133,11 @@ function insertAndRankConfigs(db: any, configs: any[]) {
`);
// Keep only top 10 per node_type
/**
* @security SQL: Static DELETE statement with no user input.
* Template literal used for multi-line formatting only.
*/
// eslint-disable-next-line no-restricted-syntax
db.exec(`
DELETE FROM template_node_configs
WHERE id NOT IN (
@@ -294,6 +305,12 @@ async function fetchTemplates(
if (!hasMetadataColumn) {
console.log('📋 Adding metadata columns to existing schema...');
/**
* @security SQL: Static ALTER TABLE statement with no user input.
* Template literal used for multi-line formatting only.
* See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-01)
*/
// eslint-disable-next-line no-restricted-syntax
db.exec(`
ALTER TABLE templates ADD COLUMN metadata_json TEXT;
ALTER TABLE templates ADD COLUMN metadata_generated_at DATETIME;
@@ -417,28 +434,12 @@ async function generateTemplateMetadata(db: any, service: TemplateService) {
} catch (error) {
console.warn(`Failed to parse workflow for template ${t.id}:`, error);
}
// Parse nodes_used safely
let nodes: string[] = [];
try {
if (t.nodes_used) {
nodes = JSON.parse(t.nodes_used);
// Ensure it's an array
if (!Array.isArray(nodes)) {
console.warn(`Template ${t.id} has invalid nodes_used (not an array), using empty array`);
nodes = [];
}
}
} catch (error) {
console.warn(`Failed to parse nodes_used for template ${t.id}:`, error);
nodes = [];
}
return {
templateId: t.id,
name: t.name,
description: t.description,
nodes: nodes,
nodes: JSON.parse(t.nodes_used),
workflow
};
});

View File

@@ -167,81 +167,29 @@ async function rebuild() {
function validateDatabase(repository: NodeRepository): { passed: boolean; issues: string[] } {
const issues = [];
try {
const db = (repository as any).db;
// CRITICAL: Check if database has any nodes at all
const nodeCount = db.prepare('SELECT COUNT(*) as count FROM nodes').get() as { count: number };
if (nodeCount.count === 0) {
issues.push('CRITICAL: Database is empty - no nodes found! Rebuild failed or was interrupted.');
return { passed: false, issues };
// Check critical nodes
const criticalNodes = ['nodes-base.httpRequest', 'nodes-base.code', 'nodes-base.webhook', 'nodes-base.slack'];
for (const nodeType of criticalNodes) {
const node = repository.getNode(nodeType);
if (!node) {
issues.push(`Critical node ${nodeType} not found`);
continue;
}
// Check minimum expected node count (should have at least 500 nodes from both packages)
if (nodeCount.count < 500) {
issues.push(`WARNING: Only ${nodeCount.count} nodes found - expected at least 500 (both n8n packages)`);
if (node.properties.length === 0) {
issues.push(`Node ${nodeType} has no properties`);
}
// Check critical nodes
const criticalNodes = ['nodes-base.httpRequest', 'nodes-base.code', 'nodes-base.webhook', 'nodes-base.slack'];
for (const nodeType of criticalNodes) {
const node = repository.getNode(nodeType);
if (!node) {
issues.push(`Critical node ${nodeType} not found`);
continue;
}
if (node.properties.length === 0) {
issues.push(`Node ${nodeType} has no properties`);
}
}
// Check AI tools
const aiTools = repository.getAITools();
if (aiTools.length === 0) {
issues.push('No AI tools found - check detection logic');
}
// Check FTS5 table existence and population
const ftsTableCheck = db.prepare(`
SELECT name FROM sqlite_master
WHERE type='table' AND name='nodes_fts'
`).get();
if (!ftsTableCheck) {
issues.push('CRITICAL: FTS5 table (nodes_fts) does not exist - searches will fail or be very slow');
} else {
// Check if FTS5 table is properly populated
const ftsCount = db.prepare('SELECT COUNT(*) as count FROM nodes_fts').get() as { count: number };
if (ftsCount.count === 0) {
issues.push('CRITICAL: FTS5 index is empty - searches will return zero results');
} else if (nodeCount.count !== ftsCount.count) {
issues.push(`FTS5 index out of sync: ${nodeCount.count} nodes but ${ftsCount.count} FTS5 entries`);
}
// Verify critical nodes are searchable via FTS5
const searchableNodes = ['webhook', 'merge', 'split'];
for (const searchTerm of searchableNodes) {
const searchResult = db.prepare(`
SELECT COUNT(*) as count FROM nodes_fts
WHERE nodes_fts MATCH ?
`).get(searchTerm);
if (searchResult.count === 0) {
issues.push(`CRITICAL: Search for "${searchTerm}" returns zero results in FTS5 index`);
}
}
}
} catch (error) {
// Catch any validation errors
const errorMessage = (error as Error).message;
issues.push(`Validation error: ${errorMessage}`);
}
// Check AI tools
const aiTools = repository.getAITools();
if (aiTools.length === 0) {
issues.push('No AI tools found - check detection logic');
}
return {
passed: issues.length === 0,
issues

View File

@@ -1,161 +0,0 @@
#!/usr/bin/env node
/**
* Seed canonical AI tool examples into the database
*
* These hand-crafted examples demonstrate best practices for critical AI tools
* that are missing from the template database.
*/
import * as fs from 'fs';
import * as path from 'path';
import { createDatabaseAdapter } from '../database/database-adapter';
import { logger } from '../utils/logger';
interface CanonicalExample {
name: string;
use_case: string;
complexity: 'simple' | 'medium' | 'complex';
parameters: Record<string, any>;
credentials?: Record<string, any>;
connections?: Record<string, any>;
notes: string;
}
interface CanonicalToolExamples {
node_type: string;
display_name: string;
examples: CanonicalExample[];
}
interface CanonicalExamplesFile {
description: string;
version: string;
examples: CanonicalToolExamples[];
}
async function seedCanonicalExamples() {
try {
// Load canonical examples file
const examplesPath = path.join(__dirname, '../data/canonical-ai-tool-examples.json');
const examplesData = fs.readFileSync(examplesPath, 'utf-8');
const canonicalExamples: CanonicalExamplesFile = JSON.parse(examplesData);
logger.info('Loading canonical AI tool examples', {
version: canonicalExamples.version,
tools: canonicalExamples.examples.length
});
// Initialize database
const db = await createDatabaseAdapter('./data/nodes.db');
// First, ensure we have placeholder templates for canonical examples
const templateStmt = db.prepare(`
INSERT OR IGNORE INTO templates (
id,
workflow_id,
name,
description,
views,
created_at,
updated_at
) VALUES (?, ?, ?, ?, ?, datetime('now'), datetime('now'))
`);
// Create one placeholder template for canonical examples
const canonicalTemplateId = -1000;
templateStmt.run(
canonicalTemplateId,
canonicalTemplateId, // workflow_id must be unique
'Canonical AI Tool Examples',
'Hand-crafted examples demonstrating best practices for AI tools',
99999 // High view count
);
// Prepare insert statement for node configs
const stmt = db.prepare(`
INSERT OR REPLACE INTO template_node_configs (
node_type,
template_id,
template_name,
template_views,
node_name,
parameters_json,
credentials_json,
has_credentials,
has_expressions,
complexity,
use_cases
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
`);
let totalInserted = 0;
// Seed each tool's examples
for (const toolExamples of canonicalExamples.examples) {
const { node_type, display_name, examples } = toolExamples;
logger.info(`Seeding examples for ${display_name}`, {
nodeType: node_type,
exampleCount: examples.length
});
for (let i = 0; i < examples.length; i++) {
const example = examples[i];
// All canonical examples use the same template ID
const templateId = canonicalTemplateId;
const templateName = `Canonical: ${display_name} - ${example.name}`;
// Check for expressions in parameters
const paramsStr = JSON.stringify(example.parameters);
const hasExpressions = paramsStr.includes('={{') || paramsStr.includes('$json') || paramsStr.includes('$node') ? 1 : 0;
// Insert into database
stmt.run(
node_type,
templateId,
templateName,
99999, // High view count for canonical examples
example.name,
JSON.stringify(example.parameters),
example.credentials ? JSON.stringify(example.credentials) : null,
example.credentials ? 1 : 0,
hasExpressions,
example.complexity,
example.use_case
);
totalInserted++;
logger.info(` ✓ Seeded: ${example.name}`, {
complexity: example.complexity,
hasCredentials: !!example.credentials,
hasExpressions: hasExpressions === 1
});
}
}
db.close();
logger.info('Canonical examples seeding complete', {
totalExamples: totalInserted,
tools: canonicalExamples.examples.length
});
console.log('\n✅ Successfully seeded', totalInserted, 'canonical AI tool examples');
console.log('\nExamples are now available via:');
console.log(' • search_nodes({query: "HTTP Request Tool", includeExamples: true})');
console.log(' • get_node_essentials({nodeType: "nodes-langchain.toolCode", includeExamples: true})');
} catch (error) {
logger.error('Failed to seed canonical examples', { error });
console.error('❌ Error:', error);
process.exit(1);
}
}
// Run if called directly
if (require.main === module) {
seedCanonicalExamples().catch(console.error);
}
export { seedCanonicalExamples };

View File

@@ -1,634 +0,0 @@
/**
* AI Node Validator
*
* Implements validation logic for AI Agent, Chat Trigger, and Basic LLM Chain nodes
* from docs/FINAL_AI_VALIDATION_SPEC.md
*
* Key Features:
* - Reverse connection mapping (AI connections flow TO the consumer)
* - AI Agent comprehensive validation (prompt types, fallback models, streaming mode)
* - Chat Trigger validation (streaming mode constraints)
* - Integration with AI tool validators
*/
import { NodeTypeNormalizer } from '../utils/node-type-normalizer';
import {
WorkflowNode,
WorkflowJson,
ReverseConnection,
ValidationIssue,
isAIToolSubNode,
validateAIToolSubNode
} from './ai-tool-validators';
// Re-export types for test files
export type {
WorkflowNode,
WorkflowJson,
ReverseConnection,
ValidationIssue
} from './ai-tool-validators';
// Validation constants
const MIN_SYSTEM_MESSAGE_LENGTH = 20;
const MAX_ITERATIONS_WARNING_THRESHOLD = 50;
/**
* AI Connection Types
* From spec lines 551-596
*/
export const AI_CONNECTION_TYPES = [
'ai_languageModel',
'ai_memory',
'ai_tool',
'ai_embedding',
'ai_vectorStore',
'ai_document',
'ai_textSplitter',
'ai_outputParser'
] as const;
/**
* Build Reverse Connection Map
*
* CRITICAL: AI connections flow TO the consumer node (reversed from standard n8n pattern)
* This utility maps which nodes connect TO each node, essential for AI validation.
*
* From spec lines 551-596
*
* @example
* Standard n8n: [Source] --main--> [Target]
* workflow.connections["Source"]["main"] = [[{node: "Target", ...}]]
*
* AI pattern: [Language Model] --ai_languageModel--> [AI Agent]
* workflow.connections["Language Model"]["ai_languageModel"] = [[{node: "AI Agent", ...}]]
*
* Reverse map: reverseMap.get("AI Agent") = [{sourceName: "Language Model", type: "ai_languageModel", ...}]
*/
export function buildReverseConnectionMap(
workflow: WorkflowJson
): Map<string, ReverseConnection[]> {
const map = new Map<string, ReverseConnection[]>();
// Iterate through all connections
for (const [sourceName, outputs] of Object.entries(workflow.connections)) {
// Validate source name is not empty
if (!sourceName || typeof sourceName !== 'string' || sourceName.trim() === '') {
continue;
}
if (!outputs || typeof outputs !== 'object') continue;
// Iterate through all output types (main, error, ai_tool, ai_languageModel, etc.)
for (const [outputType, connections] of Object.entries(outputs)) {
if (!Array.isArray(connections)) continue;
// Flatten nested arrays and process each connection
const connArray = connections.flat().filter(c => c);
for (const conn of connArray) {
if (!conn || !conn.node) continue;
// Validate target node name is not empty
if (typeof conn.node !== 'string' || conn.node.trim() === '') {
continue;
}
// Initialize array for target node if not exists
if (!map.has(conn.node)) {
map.set(conn.node, []);
}
// Add reverse connection entry
map.get(conn.node)!.push({
sourceName: sourceName,
sourceType: outputType,
type: outputType,
index: conn.index ?? 0
});
}
}
}
return map;
}
/**
* Get AI connections TO a specific node
*/
export function getAIConnections(
nodeName: string,
reverseConnections: Map<string, ReverseConnection[]>,
connectionType?: string
): ReverseConnection[] {
const incoming = reverseConnections.get(nodeName) || [];
if (connectionType) {
return incoming.filter(c => c.type === connectionType);
}
return incoming.filter(c => AI_CONNECTION_TYPES.includes(c.type as any));
}
/**
* Validate AI Agent Node
* From spec lines 3-549
*
* Validates:
* - Language model connections (1 or 2 if fallback)
* - Output parser connection + hasOutputParser flag
* - Prompt type configuration (auto vs define)
* - System message recommendations
* - Streaming mode constraints (CRITICAL)
* - Memory connections (0-1)
* - Tool connections
* - maxIterations validation
*/
export function validateAIAgent(
node: WorkflowNode,
reverseConnections: Map<string, ReverseConnection[]>,
workflow: WorkflowJson
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
const incoming = reverseConnections.get(node.name) || [];
// 1. Validate language model connections (REQUIRED: 1 or 2 if fallback)
const languageModelConnections = incoming.filter(c => c.type === 'ai_languageModel');
if (languageModelConnections.length === 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" requires an ai_languageModel connection. Connect a language model node (e.g., OpenAI Chat Model, Anthropic Chat Model).`,
code: 'MISSING_LANGUAGE_MODEL'
});
} else if (languageModelConnections.length > 2) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has ${languageModelConnections.length} ai_languageModel connections. Maximum is 2 (for fallback model support).`,
code: 'TOO_MANY_LANGUAGE_MODELS'
});
} else if (languageModelConnections.length === 2) {
// Check if fallback is enabled
if (!node.parameters.needsFallback) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has 2 language models but needsFallback is not enabled. Set needsFallback=true or remove the second model.`
});
}
} else if (languageModelConnections.length === 1 && node.parameters.needsFallback === true) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has needsFallback=true but only 1 language model connected. Connect a second model for fallback or disable needsFallback.`,
code: 'FALLBACK_MISSING_SECOND_MODEL'
});
}
// 2. Validate output parser configuration
const outputParserConnections = incoming.filter(c => c.type === 'ai_outputParser');
if (node.parameters.hasOutputParser === true) {
if (outputParserConnections.length === 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has hasOutputParser=true but no ai_outputParser connection. Connect an output parser or set hasOutputParser=false.`,
code: 'MISSING_OUTPUT_PARSER'
});
}
} else if (outputParserConnections.length > 0) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has an output parser connected but hasOutputParser is not true. Set hasOutputParser=true to enable output parsing.`
});
}
if (outputParserConnections.length > 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has ${outputParserConnections.length} output parsers. Only 1 is allowed.`,
code: 'MULTIPLE_OUTPUT_PARSERS'
});
}
// 3. Validate prompt type configuration
if (node.parameters.promptType === 'define') {
if (!node.parameters.text || node.parameters.text.trim() === '') {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has promptType="define" but the text field is empty. Provide a custom prompt or switch to promptType="auto".`,
code: 'MISSING_PROMPT_TEXT'
});
}
}
// 4. Check system message (RECOMMENDED)
if (!node.parameters.systemMessage) {
issues.push({
severity: 'info',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has no systemMessage. Consider adding one to define the agent's role, capabilities, and constraints.`
});
} else if (node.parameters.systemMessage.trim().length < MIN_SYSTEM_MESSAGE_LENGTH) {
issues.push({
severity: 'info',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" systemMessage is very short (minimum ${MIN_SYSTEM_MESSAGE_LENGTH} characters recommended). Provide more detail about the agent's role and capabilities.`
});
}
// 5. Validate streaming mode constraints (CRITICAL)
// From spec lines 753-879: AI Agent with streaming MUST NOT have main output connections
const isStreamingTarget = checkIfStreamingTarget(node, workflow, reverseConnections);
const hasOwnStreamingEnabled = node.parameters?.options?.streamResponse === true;
if (isStreamingTarget || hasOwnStreamingEnabled) {
// Check if AI Agent has any main output connections
const agentMainOutput = workflow.connections[node.name]?.main;
if (agentMainOutput && agentMainOutput.flat().some((c: any) => c)) {
const streamSource = isStreamingTarget
? 'connected from Chat Trigger with responseMode="streaming"'
: 'has streamResponse=true in options';
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" is in streaming mode (${streamSource}) but has outgoing main connections. Remove all main output connections - streaming responses flow back through the Chat Trigger.`,
code: 'STREAMING_WITH_MAIN_OUTPUT'
});
}
}
// 6. Validate memory connections (0-1 allowed)
const memoryConnections = incoming.filter(c => c.type === 'ai_memory');
if (memoryConnections.length > 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has ${memoryConnections.length} ai_memory connections. Only 1 memory is allowed.`,
code: 'MULTIPLE_MEMORY_CONNECTIONS'
});
}
// 7. Validate tool connections
const toolConnections = incoming.filter(c => c.type === 'ai_tool');
if (toolConnections.length === 0) {
issues.push({
severity: 'info',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has no ai_tool connections. Consider adding tools to enhance the agent's capabilities.`
});
}
// 8. Validate maxIterations if specified
if (node.parameters.maxIterations !== undefined) {
if (typeof node.parameters.maxIterations !== 'number') {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has invalid maxIterations type. Must be a number.`,
code: 'INVALID_MAX_ITERATIONS_TYPE'
});
} else if (node.parameters.maxIterations < 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has maxIterations=${node.parameters.maxIterations}. Must be at least 1.`,
code: 'MAX_ITERATIONS_TOO_LOW'
});
} else if (node.parameters.maxIterations > MAX_ITERATIONS_WARNING_THRESHOLD) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent "${node.name}" has maxIterations=${node.parameters.maxIterations}. Very high iteration counts (>${MAX_ITERATIONS_WARNING_THRESHOLD}) may cause long execution times and high costs.`
});
}
}
return issues;
}
/**
* Check if AI Agent is a streaming target
* Helper function to determine if an AI Agent is receiving streaming input from Chat Trigger
*/
function checkIfStreamingTarget(
node: WorkflowNode,
workflow: WorkflowJson,
reverseConnections: Map<string, ReverseConnection[]>
): boolean {
const incoming = reverseConnections.get(node.name) || [];
// Check if any incoming main connection is from a Chat Trigger with streaming enabled
const mainConnections = incoming.filter(c => c.type === 'main');
for (const conn of mainConnections) {
const sourceNode = workflow.nodes.find(n => n.name === conn.sourceName);
if (!sourceNode) continue;
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(sourceNode.type);
if (normalizedType === 'nodes-langchain.chatTrigger') {
const responseMode = sourceNode.parameters?.options?.responseMode || 'lastNode';
if (responseMode === 'streaming') {
return true;
}
}
}
return false;
}
/**
* Validate Chat Trigger Node
* From spec lines 753-879
*
* Critical validations:
* - responseMode="streaming" requires AI Agent target
* - AI Agent with streaming MUST NOT have main output connections
* - responseMode="lastNode" validation
*/
export function validateChatTrigger(
node: WorkflowNode,
workflow: WorkflowJson,
reverseConnections: Map<string, ReverseConnection[]>
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
const responseMode = node.parameters?.options?.responseMode || 'lastNode';
// Get outgoing main connections from Chat Trigger
const outgoingMain = workflow.connections[node.name]?.main;
if (!outgoingMain || outgoingMain.length === 0 || !outgoingMain[0] || outgoingMain[0].length === 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Chat Trigger "${node.name}" has no outgoing connections. Connect it to an AI Agent or workflow.`,
code: 'MISSING_CONNECTIONS'
});
return issues;
}
const firstConnection = outgoingMain[0][0];
if (!firstConnection) {
return issues;
}
const targetNode = workflow.nodes.find(n => n.name === firstConnection.node);
if (!targetNode) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Chat Trigger "${node.name}" connects to non-existent node "${firstConnection.node}".`,
code: 'INVALID_TARGET_NODE'
});
return issues;
}
const targetType = NodeTypeNormalizer.normalizeToFullForm(targetNode.type);
// Validate streaming mode
if (responseMode === 'streaming') {
// CRITICAL: Streaming mode only works with AI Agent
if (targetType !== 'nodes-langchain.agent') {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Chat Trigger "${node.name}" has responseMode="streaming" but connects to "${targetNode.name}" (${targetType}). Streaming mode only works with AI Agent. Change responseMode to "lastNode" or connect to an AI Agent.`,
code: 'STREAMING_WRONG_TARGET'
});
} else {
// CRITICAL: Check AI Agent has NO main output connections
const agentMainOutput = workflow.connections[targetNode.name]?.main;
if (agentMainOutput && agentMainOutput.flat().some((c: any) => c)) {
issues.push({
severity: 'error',
nodeId: targetNode.id,
nodeName: targetNode.name,
message: `AI Agent "${targetNode.name}" is in streaming mode but has outgoing main connections. In streaming mode, the AI Agent must NOT have main output connections - responses stream back through the Chat Trigger.`,
code: 'STREAMING_AGENT_HAS_OUTPUT'
});
}
}
}
// Validate lastNode mode
if (responseMode === 'lastNode') {
// lastNode mode requires a workflow that ends somewhere
// Just informational - this is the default and works with any workflow
if (targetType === 'nodes-langchain.agent') {
issues.push({
severity: 'info',
nodeId: node.id,
nodeName: node.name,
message: `Chat Trigger "${node.name}" uses responseMode="lastNode" with AI Agent. Consider using responseMode="streaming" for better user experience with real-time responses.`
});
}
}
return issues;
}
/**
* Validate Basic LLM Chain Node
* From spec - simplified AI chain without agent loop
*
* Similar to AI Agent but simpler:
* - Requires exactly 1 language model
* - Can have 0-1 memory
* - No tools (not an agent)
* - No fallback model support
*/
export function validateBasicLLMChain(
node: WorkflowNode,
reverseConnections: Map<string, ReverseConnection[]>
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
const incoming = reverseConnections.get(node.name) || [];
// 1. Validate language model connection (REQUIRED: exactly 1)
const languageModelConnections = incoming.filter(c => c.type === 'ai_languageModel');
if (languageModelConnections.length === 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Basic LLM Chain "${node.name}" requires an ai_languageModel connection. Connect a language model node.`,
code: 'MISSING_LANGUAGE_MODEL'
});
} else if (languageModelConnections.length > 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Basic LLM Chain "${node.name}" has ${languageModelConnections.length} ai_languageModel connections. Basic LLM Chain only supports 1 language model (no fallback).`,
code: 'MULTIPLE_LANGUAGE_MODELS'
});
}
// 2. Validate memory connections (0-1 allowed)
const memoryConnections = incoming.filter(c => c.type === 'ai_memory');
if (memoryConnections.length > 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Basic LLM Chain "${node.name}" has ${memoryConnections.length} ai_memory connections. Only 1 memory is allowed.`,
code: 'MULTIPLE_MEMORY_CONNECTIONS'
});
}
// 3. Check for tool connections (not supported)
const toolConnections = incoming.filter(c => c.type === 'ai_tool');
if (toolConnections.length > 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Basic LLM Chain "${node.name}" has ai_tool connections. Basic LLM Chain does not support tools. Use AI Agent if you need tool support.`,
code: 'TOOLS_NOT_SUPPORTED'
});
}
// 4. Validate prompt configuration
if (node.parameters.promptType === 'define') {
if (!node.parameters.text || node.parameters.text.trim() === '') {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Basic LLM Chain "${node.name}" has promptType="define" but the text field is empty.`,
code: 'MISSING_PROMPT_TEXT'
});
}
}
return issues;
}
/**
* Validate all AI-specific nodes in a workflow
*
* This is the main entry point called by WorkflowValidator
*/
export function validateAISpecificNodes(
workflow: WorkflowJson
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// Build reverse connection map (critical for AI validation)
const reverseConnectionMap = buildReverseConnectionMap(workflow);
for (const node of workflow.nodes) {
if (node.disabled) continue;
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(node.type);
// Validate AI Agent nodes
if (normalizedType === 'nodes-langchain.agent') {
const nodeIssues = validateAIAgent(node, reverseConnectionMap, workflow);
issues.push(...nodeIssues);
}
// Validate Chat Trigger nodes
if (normalizedType === 'nodes-langchain.chatTrigger') {
const nodeIssues = validateChatTrigger(node, workflow, reverseConnectionMap);
issues.push(...nodeIssues);
}
// Validate Basic LLM Chain nodes
if (normalizedType === 'nodes-langchain.chainLlm') {
const nodeIssues = validateBasicLLMChain(node, reverseConnectionMap);
issues.push(...nodeIssues);
}
// Validate AI tool sub-nodes (13 types)
if (isAIToolSubNode(normalizedType)) {
const nodeIssues = validateAIToolSubNode(
node,
normalizedType,
reverseConnectionMap,
workflow
);
issues.push(...nodeIssues);
}
}
return issues;
}
/**
* Check if a workflow contains any AI nodes
* Useful for skipping AI validation when not needed
*/
export function hasAINodes(workflow: WorkflowJson): boolean {
const aiNodeTypes = [
'nodes-langchain.agent',
'nodes-langchain.chatTrigger',
'nodes-langchain.chainLlm',
];
return workflow.nodes.some(node => {
const normalized = NodeTypeNormalizer.normalizeToFullForm(node.type);
return aiNodeTypes.includes(normalized) || isAIToolSubNode(normalized);
});
}
/**
* Helper: Get AI node type category
*/
export function getAINodeCategory(nodeType: string): string | null {
const normalized = NodeTypeNormalizer.normalizeToFullForm(nodeType);
if (normalized === 'nodes-langchain.agent') return 'AI Agent';
if (normalized === 'nodes-langchain.chatTrigger') return 'Chat Trigger';
if (normalized === 'nodes-langchain.chainLlm') return 'Basic LLM Chain';
if (isAIToolSubNode(normalized)) return 'AI Tool';
// Check for AI component nodes
if (normalized.startsWith('nodes-langchain.')) {
if (normalized.includes('openAi') || normalized.includes('anthropic') || normalized.includes('googleGemini')) {
return 'Language Model';
}
if (normalized.includes('memory') || normalized.includes('buffer')) {
return 'Memory';
}
if (normalized.includes('vectorStore') || normalized.includes('pinecone') || normalized.includes('qdrant')) {
return 'Vector Store';
}
if (normalized.includes('embedding')) {
return 'Embeddings';
}
return 'AI Component';
}
return null;
}

View File

@@ -1,607 +0,0 @@
/**
* AI Tool Sub-Node Validators
*
* Implements validation logic for all 13 AI tool sub-nodes from
* docs/FINAL_AI_VALIDATION_SPEC.md
*
* Each validator checks configuration requirements, connections, and
* parameters specific to that tool type.
*/
import { NodeTypeNormalizer } from '../utils/node-type-normalizer';
// Validation constants
const MIN_DESCRIPTION_LENGTH_SHORT = 10;
const MIN_DESCRIPTION_LENGTH_MEDIUM = 15;
const MIN_DESCRIPTION_LENGTH_LONG = 20;
const MAX_ITERATIONS_WARNING_THRESHOLD = 50;
const MAX_TOPK_WARNING_THRESHOLD = 20;
export interface WorkflowNode {
id: string;
name: string;
type: string;
position: [number, number];
parameters: any;
credentials?: any;
disabled?: boolean;
typeVersion?: number;
}
export interface WorkflowJson {
name?: string;
nodes: WorkflowNode[];
connections: Record<string, any>;
settings?: any;
}
export interface ReverseConnection {
sourceName: string;
sourceType: string;
type: string; // main, ai_tool, ai_languageModel, etc.
index: number;
}
export interface ValidationIssue {
severity: 'error' | 'warning' | 'info';
nodeId?: string;
nodeName?: string;
message: string;
code?: string;
}
/**
* 1. HTTP Request Tool Validator
* From spec lines 883-1123
*/
export function validateHTTPRequestTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" has no toolDescription. Add a clear description to help the LLM know when to use this API.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
} else if (node.parameters.toolDescription.trim().length < MIN_DESCRIPTION_LENGTH_MEDIUM) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" toolDescription is too short (minimum ${MIN_DESCRIPTION_LENGTH_MEDIUM} characters). Explain what API this calls and when to use it.`
});
}
// 2. Check URL (REQUIRED)
if (!node.parameters.url) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" has no URL. Add the API endpoint URL.`,
code: 'MISSING_URL'
});
} else {
// Validate URL protocol (must be http or https)
try {
const urlObj = new URL(node.parameters.url);
if (urlObj.protocol !== 'http:' && urlObj.protocol !== 'https:') {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" has invalid URL protocol "${urlObj.protocol}". Use http:// or https:// only.`,
code: 'INVALID_URL_PROTOCOL'
});
}
} catch (e) {
// URL parsing failed - invalid format
// Only warn if it's not an n8n expression
if (!node.parameters.url.includes('{{')) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" has potentially invalid URL format. Ensure it's a valid URL or n8n expression.`
});
}
}
}
// 3. Validate placeholders match definitions
if (node.parameters.url || node.parameters.body || node.parameters.headers) {
const placeholderRegex = /\{([^}]+)\}/g;
const placeholders = new Set<string>();
// Extract placeholders from URL, body, headers
[node.parameters.url, node.parameters.body, JSON.stringify(node.parameters.headers || {})].forEach(text => {
if (text) {
let match;
while ((match = placeholderRegex.exec(text)) !== null) {
placeholders.add(match[1]);
}
}
});
// If placeholders exist in URL/body/headers
if (placeholders.size > 0) {
const definitions = node.parameters.placeholderDefinitions?.values || [];
const definedNames = new Set(definitions.map((d: any) => d.name));
// If no placeholderDefinitions at all, warn
if (!node.parameters.placeholderDefinitions) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" uses placeholders but has no placeholderDefinitions. Add definitions to describe the expected inputs.`
});
} else {
// Has placeholderDefinitions, check each placeholder
for (const placeholder of placeholders) {
if (!definedNames.has(placeholder)) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" Placeholder "${placeholder}" in URL but it's not defined in placeholderDefinitions.`,
code: 'UNDEFINED_PLACEHOLDER'
});
}
}
// Check for defined but unused placeholders
for (const def of definitions) {
if (!placeholders.has(def.name)) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" defines placeholder "${def.name}" but doesn't use it.`
});
}
}
}
}
}
// 4. Validate authentication
if (node.parameters.authentication === 'predefinedCredentialType' &&
(!node.credentials || Object.keys(node.credentials).length === 0)) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" requires credentials but none are configured.`,
code: 'MISSING_CREDENTIALS'
});
}
// 5. Validate HTTP method
const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
if (node.parameters.method && !validMethods.includes(node.parameters.method.toUpperCase())) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" has invalid HTTP method "${node.parameters.method}". Use one of: ${validMethods.join(', ')}.`,
code: 'INVALID_HTTP_METHOD'
});
}
// 6. Validate body for POST/PUT/PATCH
if (['POST', 'PUT', 'PATCH'].includes(node.parameters.method?.toUpperCase())) {
if (!node.parameters.body && !node.parameters.jsonBody) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `HTTP Request Tool "${node.name}" uses ${node.parameters.method} but has no body. Consider adding a body or using GET instead.`
});
}
}
return issues;
}
/**
* 2. Code Tool Validator
* From spec lines 1125-1393
*/
export function validateCodeTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Code Tool "${node.name}" has no toolDescription. Add one to help the LLM understand the tool's purpose.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Check jsCode exists (REQUIRED)
if (!node.parameters.jsCode || node.parameters.jsCode.trim().length === 0) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Code Tool "${node.name}" code is empty. Add the JavaScript code to execute.`,
code: 'MISSING_CODE'
});
}
// 3. Recommend input/output schema
if (!node.parameters.inputSchema && !node.parameters.specifyInputSchema) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `Code Tool "${node.name}" has no input schema. Consider adding one to validate LLM inputs.`
});
}
return issues;
}
/**
* 3. Vector Store Tool Validator
* From spec lines 1395-1620
*/
export function validateVectorStoreTool(
node: WorkflowNode,
reverseConnections: Map<string, ReverseConnection[]>,
workflow: WorkflowJson
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Vector Store Tool "${node.name}" has no toolDescription. Add one to explain what data it searches.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Validate topK parameter if specified
if (node.parameters.topK !== undefined) {
if (typeof node.parameters.topK !== 'number' || node.parameters.topK < 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Vector Store Tool "${node.name}" has invalid topK value. Must be a positive number.`,
code: 'INVALID_TOPK'
});
} else if (node.parameters.topK > MAX_TOPK_WARNING_THRESHOLD) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `Vector Store Tool "${node.name}" has topK=${node.parameters.topK}. Large values (>${MAX_TOPK_WARNING_THRESHOLD}) may overwhelm the LLM context. Consider reducing to 10 or less.`
});
}
}
return issues;
}
/**
* 4. Workflow Tool Validator
* From spec lines 1622-1831 (already complete in spec)
*/
export function validateWorkflowTool(node: WorkflowNode, reverseConnections?: Map<string, ReverseConnection[]>): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Workflow Tool "${node.name}" has no toolDescription. Add one to help the LLM know when to use this tool.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Check workflowId (REQUIRED)
if (!node.parameters.workflowId) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Workflow Tool "${node.name}" has no workflowId. Select a workflow to execute.`,
code: 'MISSING_WORKFLOW_ID'
});
}
return issues;
}
/**
* 5. AI Agent Tool Validator
* From spec lines 1882-2122
*/
export function validateAIAgentTool(
node: WorkflowNode,
reverseConnections: Map<string, ReverseConnection[]>
): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent Tool "${node.name}" has no toolDescription. Add one to help the LLM know when to use this tool.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Validate maxIterations if specified
if (node.parameters.maxIterations !== undefined) {
if (typeof node.parameters.maxIterations !== 'number' || node.parameters.maxIterations < 1) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent Tool "${node.name}" has invalid maxIterations. Must be a positive number.`,
code: 'INVALID_MAX_ITERATIONS'
});
} else if (node.parameters.maxIterations > MAX_ITERATIONS_WARNING_THRESHOLD) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `AI Agent Tool "${node.name}" has maxIterations=${node.parameters.maxIterations}. Large values (>${MAX_ITERATIONS_WARNING_THRESHOLD}) may lead to long execution times.`
});
}
}
return issues;
}
/**
* 6. MCP Client Tool Validator
* From spec lines 2124-2534 (already complete in spec)
*/
export function validateMCPClientTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `MCP Client Tool "${node.name}" has no toolDescription. Add one to help the LLM know when to use this tool.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Check serverUrl (REQUIRED)
if (!node.parameters.serverUrl) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `MCP Client Tool "${node.name}" has no serverUrl. Configure the MCP server URL.`,
code: 'MISSING_SERVER_URL'
});
}
return issues;
}
/**
* 7-8. Simple Tools (Calculator, Think) Validators
* From spec lines 1868-2009
*/
export function validateCalculatorTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// Calculator Tool has a built-in description and is self-explanatory
// toolDescription is optional - no validation needed
return issues;
}
export function validateThinkTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// Think Tool has a built-in description and is self-explanatory
// toolDescription is optional - no validation needed
return issues;
}
/**
* 9-12. Search Tools Validators
* From spec lines 1833-2139
*/
export function validateSerpApiTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `SerpApi Tool "${node.name}" has no toolDescription. Add one to explain when to use Google search.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Check credentials (RECOMMENDED)
if (!node.credentials || !node.credentials.serpApiApi) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `SerpApi Tool "${node.name}" requires SerpApi credentials. Configure your API key.`
});
}
return issues;
}
export function validateWikipediaTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Wikipedia Tool "${node.name}" has no toolDescription. Add one to explain when to use Wikipedia.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Validate language if specified
if (node.parameters.language) {
const validLanguageCodes = /^[a-z]{2,3}$/; // ISO 639 codes
if (!validLanguageCodes.test(node.parameters.language)) {
issues.push({
severity: 'warning',
nodeId: node.id,
nodeName: node.name,
message: `Wikipedia Tool "${node.name}" has potentially invalid language code "${node.parameters.language}". Use ISO 639 codes (e.g., "en", "es", "fr").`
});
}
}
return issues;
}
export function validateSearXngTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check toolDescription (REQUIRED)
if (!node.parameters.toolDescription) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `SearXNG Tool "${node.name}" has no toolDescription. Add one to explain when to use SearXNG.`,
code: 'MISSING_TOOL_DESCRIPTION'
});
}
// 2. Check baseUrl (REQUIRED)
if (!node.parameters.baseUrl) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `SearXNG Tool "${node.name}" has no baseUrl. Configure your SearXNG instance URL.`,
code: 'MISSING_BASE_URL'
});
}
return issues;
}
export function validateWolframAlphaTool(node: WorkflowNode): ValidationIssue[] {
const issues: ValidationIssue[] = [];
// 1. Check credentials (REQUIRED)
if (!node.credentials || (!node.credentials.wolframAlpha && !node.credentials.wolframAlphaApi)) {
issues.push({
severity: 'error',
nodeId: node.id,
nodeName: node.name,
message: `WolframAlpha Tool "${node.name}" requires Wolfram|Alpha API credentials. Configure your App ID.`,
code: 'MISSING_CREDENTIALS'
});
}
// 2. Check description (INFO)
if (!node.parameters.description && !node.parameters.toolDescription) {
issues.push({
severity: 'info',
nodeId: node.id,
nodeName: node.name,
message: `WolframAlpha Tool "${node.name}" has no custom description. Add one to explain when to use Wolfram|Alpha for computational queries.`
});
}
return issues;
}
/**
* Helper: Map node types to validator functions
*/
export const AI_TOOL_VALIDATORS = {
'nodes-langchain.toolHttpRequest': validateHTTPRequestTool,
'nodes-langchain.toolCode': validateCodeTool,
'nodes-langchain.toolVectorStore': validateVectorStoreTool,
'nodes-langchain.toolWorkflow': validateWorkflowTool,
'nodes-langchain.agentTool': validateAIAgentTool,
'nodes-langchain.mcpClientTool': validateMCPClientTool,
'nodes-langchain.toolCalculator': validateCalculatorTool,
'nodes-langchain.toolThink': validateThinkTool,
'nodes-langchain.toolSerpApi': validateSerpApiTool,
'nodes-langchain.toolWikipedia': validateWikipediaTool,
'nodes-langchain.toolSearXng': validateSearXngTool,
'nodes-langchain.toolWolframAlpha': validateWolframAlphaTool,
} as const;
/**
* Check if a node type is an AI tool sub-node
*/
export function isAIToolSubNode(nodeType: string): boolean {
const normalized = NodeTypeNormalizer.normalizeToFullForm(nodeType);
return normalized in AI_TOOL_VALIDATORS;
}
/**
* Validate an AI tool sub-node with the appropriate validator
*/
export function validateAIToolSubNode(
node: WorkflowNode,
nodeType: string,
reverseConnections: Map<string, ReverseConnection[]>,
workflow: WorkflowJson
): ValidationIssue[] {
const normalized = NodeTypeNormalizer.normalizeToFullForm(nodeType);
// Route to appropriate validator based on node type
switch (normalized) {
case 'nodes-langchain.toolHttpRequest':
return validateHTTPRequestTool(node);
case 'nodes-langchain.toolCode':
return validateCodeTool(node);
case 'nodes-langchain.toolVectorStore':
return validateVectorStoreTool(node, reverseConnections, workflow);
case 'nodes-langchain.toolWorkflow':
return validateWorkflowTool(node);
case 'nodes-langchain.agentTool':
return validateAIAgentTool(node, reverseConnections);
case 'nodes-langchain.mcpClientTool':
return validateMCPClientTool(node);
case 'nodes-langchain.toolCalculator':
return validateCalculatorTool(node);
case 'nodes-langchain.toolThink':
return validateThinkTool(node);
case 'nodes-langchain.toolSerpApi':
return validateSerpApiTool(node);
case 'nodes-langchain.toolWikipedia':
return validateWikipediaTool(node);
case 'nodes-langchain.toolSearXng':
return validateSearXngTool(node);
case 'nodes-langchain.toolWolframAlpha':
return validateWolframAlphaTool(node);
default:
return [];
}
}

View File

@@ -1,12 +1,10 @@
/**
* Configuration Validator Service
*
*
* Validates node configurations to catch errors before execution.
* Provides helpful suggestions and identifies missing or misconfigured properties.
*/
import { shouldSkipLiteralValidation } from '../utils/expression-utils.js';
export interface ValidationResult {
valid: boolean;
errors: ValidationError[];
@@ -33,19 +31,13 @@ export interface ValidationWarning {
}
export class ConfigValidator {
/**
* UI-only property types that should not be validated as configuration
*/
private static readonly UI_ONLY_TYPES = ['notice', 'callout', 'infoBox', 'info'];
/**
* Validate a node configuration
*/
static validate(
nodeType: string,
config: Record<string, any>,
properties: any[],
userProvidedKeys?: Set<string> // NEW: Track user-provided properties to avoid warning about defaults
nodeType: string,
config: Record<string, any>,
properties: any[]
): ValidationResult {
// Input validation
if (!config || typeof config !== 'object') {
@@ -54,7 +46,7 @@ export class ConfigValidator {
if (!properties || !Array.isArray(properties)) {
throw new TypeError('Properties must be a non-null array');
}
const errors: ValidationError[] = [];
const warnings: ValidationWarning[] = [];
const suggestions: string[] = [];
@@ -77,8 +69,8 @@ export class ConfigValidator {
this.performNodeSpecificValidation(nodeType, config, errors, warnings, suggestions, autofix);
// Check for common issues
this.checkCommonIssues(nodeType, config, properties, warnings, suggestions, userProvidedKeys);
this.checkCommonIssues(nodeType, config, properties, warnings, suggestions);
// Security checks
this.performSecurityChecks(nodeType, config, warnings);
@@ -242,86 +234,8 @@ export class ConfigValidator {
message: `Property '${key}' must be a boolean, got ${typeof value}`,
fix: `Change ${key} to true or false`
});
} else if (prop.type === 'resourceLocator') {
// resourceLocator validation: Used by AI model nodes (OpenAI, Anthropic, etc.)
// Must be an object with required properties:
// - mode: string ('list' | 'id' | 'url')
// - value: any (the actual model/resource identifier)
// Common mistake: passing string directly instead of object structure
if (typeof value !== 'object' || value === null || Array.isArray(value)) {
const fixValue = typeof value === 'string' ? value : JSON.stringify(value);
errors.push({
type: 'invalid_type',
property: key,
message: `Property '${key}' is a resourceLocator and must be an object with 'mode' and 'value' properties, got ${typeof value}`,
fix: `Change ${key} to { mode: "list", value: ${JSON.stringify(fixValue)} } or { mode: "id", value: ${JSON.stringify(fixValue)} }`
});
} else {
// Check required properties
if (!value.mode) {
errors.push({
type: 'missing_required',
property: `${key}.mode`,
message: `resourceLocator '${key}' is missing required property 'mode'`,
fix: `Add mode property: { mode: "list", value: ${JSON.stringify(value.value || '')} }`
});
} else if (typeof value.mode !== 'string') {
errors.push({
type: 'invalid_type',
property: `${key}.mode`,
message: `resourceLocator '${key}.mode' must be a string, got ${typeof value.mode}`,
fix: `Set mode to a valid string value`
});
} else if (prop.modes) {
// Schema-based validation: Check if mode exists in the modes definition
// In n8n, modes are defined at the top level of resourceLocator properties
// Modes can be defined in different ways:
// 1. Array of mode objects: [{name: 'list', ...}, {name: 'id', ...}, {name: 'name', ...}]
// 2. Object with mode keys: { list: {...}, id: {...}, url: {...}, name: {...} }
const modes = prop.modes;
// Validate modes structure before processing to prevent crashes
if (!modes || typeof modes !== 'object') {
// Invalid schema structure - skip validation to prevent false positives
continue;
}
let allowedModes: string[] = [];
if (Array.isArray(modes)) {
// Array format (most common in n8n): extract name property from each mode object
allowedModes = modes
.map(m => (typeof m === 'object' && m !== null) ? m.name : m)
.filter(m => typeof m === 'string' && m.length > 0);
} else {
// Object format: extract keys as mode names
allowedModes = Object.keys(modes).filter(k => k.length > 0);
}
// Only validate if we successfully extracted modes
if (allowedModes.length > 0 && !allowedModes.includes(value.mode)) {
errors.push({
type: 'invalid_value',
property: `${key}.mode`,
message: `resourceLocator '${key}.mode' must be one of [${allowedModes.join(', ')}], got '${value.mode}'`,
fix: `Change mode to one of: ${allowedModes.join(', ')}`
});
}
}
// If no modes defined at property level, skip mode validation
// This prevents false positives for nodes with dynamic/runtime-determined modes
if (value.value === undefined) {
errors.push({
type: 'missing_required',
property: `${key}.value`,
message: `resourceLocator '${key}' is missing required property 'value'`,
fix: `Add value property to specify the ${prop.displayName || key}`
});
}
}
}
// Options validation
if (prop.type === 'options' && prop.options) {
const validValues = prop.options.map((opt: any) =>
@@ -383,16 +297,13 @@ export class ConfigValidator {
): void {
// URL validation
if (config.url && typeof config.url === 'string') {
// Skip validation for expressions - they will be evaluated at runtime
if (!shouldSkipLiteralValidation(config.url)) {
if (!config.url.startsWith('http://') && !config.url.startsWith('https://')) {
errors.push({
type: 'invalid_value',
property: 'url',
message: 'URL must start with http:// or https://',
fix: 'Add https:// to the beginning of your URL'
});
}
if (!config.url.startsWith('http://') && !config.url.startsWith('https://')) {
errors.push({
type: 'invalid_value',
property: 'url',
message: 'URL must start with http:// or https://',
fix: 'Add https:// to the beginning of your URL'
});
}
}
@@ -422,19 +333,15 @@ export class ConfigValidator {
// JSON body validation
if (config.sendBody && config.contentType === 'json' && config.jsonBody) {
// Skip validation for expressions - they will be evaluated at runtime
if (!shouldSkipLiteralValidation(config.jsonBody)) {
try {
JSON.parse(config.jsonBody);
} catch (e) {
const errorMsg = e instanceof Error ? e.message : 'Unknown parsing error';
errors.push({
type: 'invalid_value',
property: 'jsonBody',
message: `jsonBody contains invalid JSON: ${errorMsg}`,
fix: 'Fix JSON syntax error and ensure valid JSON format'
});
}
try {
JSON.parse(config.jsonBody);
} catch (e) {
errors.push({
type: 'invalid_value',
property: 'jsonBody',
message: 'jsonBody contains invalid JSON',
fix: 'Ensure jsonBody contains valid JSON syntax'
});
}
}
}
@@ -538,48 +445,30 @@ export class ConfigValidator {
config: Record<string, any>,
properties: any[],
warnings: ValidationWarning[],
suggestions: string[],
userProvidedKeys?: Set<string> // NEW: Only warn about user-provided properties
suggestions: string[]
): void {
// Skip visibility checks for Code nodes as they have simple property structure
if (nodeType === 'nodes-base.code') {
// Code nodes don't have complex displayOptions, so skip visibility warnings
return;
}
// Check for properties that won't be used
const visibleProps = properties.filter(p => this.isPropertyVisible(p, config));
const configuredKeys = Object.keys(config);
for (const key of configuredKeys) {
// Skip internal properties that are always present
if (key === '@version' || key.startsWith('_')) {
continue;
}
// CRITICAL FIX: Only warn about properties the user actually provided, not defaults
if (userProvidedKeys && !userProvidedKeys.has(key)) {
continue; // Skip properties that were added as defaults
}
// Find the property definition
const prop = properties.find(p => p.name === key);
// Skip UI-only properties (notice, callout, etc.) - they're not configuration
if (prop && this.UI_ONLY_TYPES.includes(prop.type)) {
continue;
}
// Check if property is visible with current settings
if (!visibleProps.find(p => p.name === key)) {
// Get visibility requirements for better error message
const visibilityReq = this.getVisibilityRequirement(prop, config);
warnings.push({
type: 'inefficient',
property: key,
message: `Property '${prop?.displayName || key}' won't be used - not visible with current settings`,
suggestion: visibilityReq || 'Remove this property or adjust other settings to make it visible'
message: `Property '${key}' is configured but won't be used due to current settings`,
suggestion: 'Remove this property or adjust other settings to make it visible'
});
}
}
@@ -628,36 +517,6 @@ export class ConfigValidator {
}
}
/**
* Get visibility requirement for a property
* Explains what needs to be set for the property to be visible
*/
private static getVisibilityRequirement(prop: any, config: Record<string, any>): string | undefined {
if (!prop || !prop.displayOptions?.show) {
return undefined;
}
const requirements: string[] = [];
for (const [field, values] of Object.entries(prop.displayOptions.show)) {
const expectedValues = Array.isArray(values) ? values : [values];
const currentValue = config[field];
// Only include if the current value doesn't match
if (!expectedValues.includes(currentValue)) {
const valueStr = expectedValues.length === 1
? `"${expectedValues[0]}"`
: expectedValues.map(v => `"${v}"`).join(' or ');
requirements.push(`${field}=${valueStr}`);
}
}
if (requirements.length === 0) {
return undefined;
}
return `Requires: ${requirements.join(', ')}`;
}
/**
* Basic JavaScript syntax validation
*/

View File

@@ -78,9 +78,6 @@ export class EnhancedConfigValidator extends ConfigValidator {
// Extract operation context from config
const operationContext = this.extractOperationContext(config);
// Extract user-provided keys before applying defaults (CRITICAL FIX for warning system)
const userProvidedKeys = new Set(Object.keys(config));
// Filter properties based on mode and operation, and get config with defaults
const { properties: filteredProperties, configWithDefaults } = this.filterPropertiesByMode(
properties,
@@ -90,8 +87,7 @@ export class EnhancedConfigValidator extends ConfigValidator {
);
// Perform base validation on filtered properties with defaults applied
// Pass userProvidedKeys to prevent warnings about default values
const baseResult = super.validate(nodeType, configWithDefaults, filteredProperties, userProvidedKeys);
const baseResult = super.validate(nodeType, configWithDefaults, filteredProperties);
// Enhance the result
const enhancedResult: EnhancedValidationResult = {
@@ -318,11 +314,7 @@ export class EnhancedConfigValidator extends ConfigValidator {
case 'nodes-base.mysql':
NodeSpecificValidators.validateMySQL(context);
break;
case 'nodes-base.set':
NodeSpecificValidators.validateSet(context);
break;
case 'nodes-base.switch':
this.validateSwitchNodeStructure(config, result);
break;
@@ -466,15 +458,6 @@ export class EnhancedConfigValidator extends ConfigValidator {
return Array.from(seen.values());
}
/**
* Check if a warning should be filtered out (hardcoded credentials shown only in strict mode)
*/
private static shouldFilterCredentialWarning(warning: ValidationWarning): boolean {
return warning.type === 'security' &&
warning.message !== undefined &&
warning.message.includes('Hardcoded nodeCredentialType');
}
/**
* Apply profile-based filtering to validation results
*/
@@ -486,40 +469,22 @@ export class EnhancedConfigValidator extends ConfigValidator {
case 'minimal':
// Only keep missing required errors
result.errors = result.errors.filter(e => e.type === 'missing_required');
// Keep ONLY critical warnings (security and deprecated)
// But filter out hardcoded credential type warnings (only show in strict mode)
result.warnings = result.warnings.filter(w => {
if (this.shouldFilterCredentialWarning(w)) {
return false;
}
return w.type === 'security' || w.type === 'deprecated';
});
result.warnings = [];
result.suggestions = [];
break;
case 'runtime':
// Keep critical runtime errors only
result.errors = result.errors.filter(e =>
e.type === 'missing_required' ||
result.errors = result.errors.filter(e =>
e.type === 'missing_required' ||
e.type === 'invalid_value' ||
(e.type === 'invalid_type' && e.message.includes('undefined'))
);
// Keep security and deprecated warnings, REMOVE property visibility warnings
result.warnings = result.warnings.filter(w => {
// Filter out hardcoded credential type warnings (only show in strict mode)
if (this.shouldFilterCredentialWarning(w)) {
return false;
}
if (w.type === 'security' || w.type === 'deprecated') return true;
// FILTER OUT property visibility warnings (too noisy)
if (w.type === 'inefficient' && w.message && w.message.includes('not visible')) {
return false;
}
return false;
});
// Keep only security warnings
result.warnings = result.warnings.filter(w => w.type === 'security');
result.suggestions = [];
break;
case 'strict':
// Keep everything, add more suggestions
if (result.warnings.length === 0 && result.errors.length === 0) {
@@ -529,32 +494,14 @@ export class EnhancedConfigValidator extends ConfigValidator {
// Require error handling for external service nodes
this.enforceErrorHandlingForProfile(result, profile);
break;
case 'ai-friendly':
default:
// Current behavior - balanced for AI agents
// Filter out noise but keep helpful warnings
result.warnings = result.warnings.filter(w => {
// Filter out hardcoded credential type warnings (only show in strict mode)
if (this.shouldFilterCredentialWarning(w)) {
return false;
}
// Keep security and deprecated warnings
if (w.type === 'security' || w.type === 'deprecated') return true;
// Keep missing common properties
if (w.type === 'missing_common') return true;
// Keep best practice warnings
if (w.type === 'best_practice') return true;
// FILTER OUT inefficient warnings about property visibility (now fixed at source)
if (w.type === 'inefficient' && w.message && w.message.includes('not visible')) {
return false; // These are now rare due to userProvidedKeys fix
}
// Filter out internal property warnings
if (w.type === 'inefficient' && w.property?.startsWith('_')) {
return false;
}
return true;
});
result.warnings = result.warnings.filter(w =>
w.type !== 'inefficient' || !w.property?.startsWith('_')
);
// Add error handling suggestions for AI-friendly profile
this.addErrorHandlingSuggestions(result);
break;

View File

@@ -207,14 +207,8 @@ export class ExpressionValidator {
expr: string,
result: ExpressionValidationResult
): void {
// Check for missing $ prefix - but exclude cases where $ is already present OR it's property access (e.g., .json)
// The pattern now excludes:
// - Immediately preceded by $ (e.g., $json) - handled by (?<!\$)
// - Preceded by a dot (e.g., .json in $('Node').item.json.field) - handled by (?<!\.)
// - Inside word characters (e.g., myJson) - handled by (?<!\w)
// - Inside bracket notation (e.g., ['json']) - handled by (?<![)
// - After opening bracket or quote (e.g., "json" or ['json'])
const missingPrefixPattern = /(?<![.$\w['])\b(json|node|input|items|workflow|execution)\b(?!\s*[:''])/;
// Check for missing $ prefix - but exclude cases where $ is already present
const missingPrefixPattern = /(?<!\$)\b(json|node|input|items|workflow|execution)\b(?!\s*:)/;
if (expr.match(missingPrefixPattern)) {
result.warnings.push(
'Possible missing $ prefix for variable (e.g., use $json instead of json)'

View File

@@ -1,6 +1,5 @@
import { z } from 'zod';
import { WorkflowNode, WorkflowConnection, Workflow } from '../types/n8n-api';
import { isNonExecutableNode, isTriggerNode } from '../utils/node-classification';
// Zod schemas for n8n API validation
@@ -195,14 +194,6 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
errors.push('Workflow must have at least one node');
}
// Check if workflow has only non-executable nodes (sticky notes)
if (workflow.nodes && workflow.nodes.length > 0) {
const hasExecutableNodes = workflow.nodes.some(node => !isNonExecutableNode(node.type));
if (!hasExecutableNodes) {
errors.push('Workflow must have at least one executable node. Sticky notes alone cannot form a valid workflow.');
}
}
if (!workflow.connections) {
errors.push('Workflow connections are required');
}
@@ -210,71 +201,20 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
// Check for minimum viable workflow
if (workflow.nodes && workflow.nodes.length === 1) {
const singleNode = workflow.nodes[0];
const isWebhookOnly = singleNode.type === 'n8n-nodes-base.webhook' ||
const isWebhookOnly = singleNode.type === 'n8n-nodes-base.webhook' ||
singleNode.type === 'n8n-nodes-base.webhookTrigger';
if (!isWebhookOnly) {
errors.push(`Single non-webhook node workflow is invalid. Current node: "${singleNode.name}" (${singleNode.type}). Add another node using: {type: 'addNode', node: {name: 'Process Data', type: 'n8n-nodes-base.set', typeVersion: 3.4, position: [450, 300], parameters: {}}}`);
errors.push('Single-node workflows are only valid for webhooks. Add at least one more node and connect them. Example: Manual Trigger → Set node');
}
}
// Check for disconnected nodes in multi-node workflows
// Check for empty connections in multi-node workflows
if (workflow.nodes && workflow.nodes.length > 1 && workflow.connections) {
// Filter out non-executable nodes (sticky notes) when counting nodes
const executableNodes = workflow.nodes.filter(node => !isNonExecutableNode(node.type));
const connectionCount = Object.keys(workflow.connections).length;
// First check: workflow has no connections at all (only check if there are multiple executable nodes)
if (connectionCount === 0 && executableNodes.length > 1) {
const nodeNames = executableNodes.slice(0, 2).map(n => n.name);
errors.push(`Multi-node workflow has no connections between nodes. Add a connection using: {type: 'addConnection', source: '${nodeNames[0]}', target: '${nodeNames[1]}', sourcePort: 'main', targetPort: 'main'}`);
} else if (connectionCount > 0 || executableNodes.length > 1) {
// Second check: detect disconnected nodes (nodes with no incoming or outgoing connections)
const connectedNodes = new Set<string>();
// Collect all nodes that appear in connections (as source or target)
Object.entries(workflow.connections).forEach(([sourceName, connection]) => {
connectedNodes.add(sourceName); // Node has outgoing connection
if (connection.main && Array.isArray(connection.main)) {
connection.main.forEach((outputs) => {
if (Array.isArray(outputs)) {
outputs.forEach((target) => {
connectedNodes.add(target.node); // Node has incoming connection
});
}
});
}
});
// Find disconnected nodes (excluding non-executable nodes and triggers)
// Non-executable nodes (sticky notes) are UI-only and don't need connections
// Trigger nodes only need outgoing connections
const disconnectedNodes = workflow.nodes.filter(node => {
// Skip non-executable nodes (sticky notes, etc.) - they're UI-only annotations
if (isNonExecutableNode(node.type)) {
return false;
}
const isConnected = connectedNodes.has(node.name);
const isTrigger = isTriggerNode(node.type);
// Trigger nodes only need outgoing connections
if (isTrigger) {
return !workflow.connections?.[node.name]; // Disconnected if no outgoing connections
}
// Regular nodes need at least one connection (incoming or outgoing)
return !isConnected;
});
if (disconnectedNodes.length > 0) {
const disconnectedList = disconnectedNodes.map(n => `"${n.name}" (${n.type})`).join(', ');
const firstDisconnected = disconnectedNodes[0];
const suggestedSource = workflow.nodes.find(n => connectedNodes.has(n.name))?.name || workflow.nodes[0].name;
errors.push(`Disconnected nodes detected: ${disconnectedList}. Each node must have at least one connection. Add a connection: {type: 'addConnection', source: '${suggestedSource}', target: '${firstDisconnected.name}', sourcePort: 'main', targetPort: 'main'}`);
}
if (connectionCount === 0) {
errors.push('Multi-node workflow has empty connections. Connect nodes like this: connections: { "Node1 Name": { "main": [[{ "node": "Node2 Name", "type": "main", "index": 0 }]] } }');
}
}
@@ -296,16 +236,6 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
});
}
// Validate filter-based nodes (IF v2.2+, Switch v3.2+) have complete metadata
if (workflow.nodes) {
workflow.nodes.forEach((node, index) => {
const filterErrors = validateFilterBasedNodeMetadata(node);
if (filterErrors.length > 0) {
errors.push(...filterErrors.map(err => `Node "${node.name}" (index ${index}): ${err}`));
}
});
}
// Validate connections
if (workflow.connections) {
try {
@@ -315,66 +245,12 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
}
}
// Validate Switch and IF node connection structures match their rules
if (workflow.nodes && workflow.connections) {
const switchNodes = workflow.nodes.filter(n => {
if (n.type !== 'n8n-nodes-base.switch') return false;
const mode = (n.parameters as any)?.mode;
return !mode || mode === 'rules'; // Default mode is 'rules'
});
for (const switchNode of switchNodes) {
const params = switchNode.parameters as any;
const rules = params?.rules?.rules || [];
const nodeConnections = workflow.connections[switchNode.name];
if (rules.length > 0 && nodeConnections?.main) {
const outputBranches = nodeConnections.main.length;
// Switch nodes in "rules" mode need output branches matching rules count
if (outputBranches !== rules.length) {
const ruleNames = rules.map((r: any, i: number) =>
r.outputKey ? `"${r.outputKey}" (index ${i})` : `Rule ${i}`
).join(', ');
errors.push(
`Switch node "${switchNode.name}" has ${rules.length} rules [${ruleNames}] ` +
`but only ${outputBranches} output branch${outputBranches !== 1 ? 'es' : ''} in connections. ` +
`Each rule needs its own output branch. When connecting to Switch outputs, specify sourceIndex: ` +
rules.map((_: any, i: number) => i).join(', ') +
` (or use case parameter for clarity).`
);
}
// Check for empty output branches (except trailing ones)
const nonEmptyBranches = nodeConnections.main.filter((branch: any[]) => branch.length > 0).length;
if (nonEmptyBranches < rules.length) {
const emptyIndices = nodeConnections.main
.map((branch: any[], i: number) => branch.length === 0 ? i : -1)
.filter((i: number) => i !== -1 && i < rules.length);
if (emptyIndices.length > 0) {
const ruleInfo = emptyIndices.map((i: number) => {
const rule = rules[i];
return rule.outputKey ? `"${rule.outputKey}" (index ${i})` : `Rule ${i}`;
}).join(', ');
errors.push(
`Switch node "${switchNode.name}" has unconnected output${emptyIndices.length !== 1 ? 's' : ''}: ${ruleInfo}. ` +
`Add connection${emptyIndices.length !== 1 ? 's' : ''} using sourceIndex: ${emptyIndices.join(' or ')}.`
);
}
}
}
}
}
// Validate that all connection references exist and use node NAMES (not IDs)
if (workflow.nodes && workflow.connections) {
const nodeNames = new Set(workflow.nodes.map(node => node.name));
const nodeIds = new Set(workflow.nodes.map(node => node.id));
const nodeIdToName = new Map(workflow.nodes.map(node => [node.id, node.name]));
Object.entries(workflow.connections).forEach(([sourceName, connection]) => {
// Check if source exists by name (correct)
if (!nodeNames.has(sourceName)) {
@@ -413,177 +289,12 @@ export function validateWorkflowStructure(workflow: Partial<Workflow>): string[]
// Check if workflow has webhook trigger
export function hasWebhookTrigger(workflow: Workflow): boolean {
return workflow.nodes.some(node =>
node.type === 'n8n-nodes-base.webhook' ||
return workflow.nodes.some(node =>
node.type === 'n8n-nodes-base.webhook' ||
node.type === 'n8n-nodes-base.webhookTrigger'
);
}
/**
* Validate filter-based node metadata (IF v2.2+, Switch v3.2+)
* Returns array of error messages
*/
export function validateFilterBasedNodeMetadata(node: WorkflowNode): string[] {
const errors: string[] = [];
// Check if node is filter-based
const isIFNode = node.type === 'n8n-nodes-base.if' && node.typeVersion >= 2.2;
const isSwitchNode = node.type === 'n8n-nodes-base.switch' && node.typeVersion >= 3.2;
if (!isIFNode && !isSwitchNode) {
return errors; // Not a filter-based node
}
// Validate IF node
if (isIFNode) {
const conditions = (node.parameters.conditions as any);
// Check conditions.options exists
if (!conditions?.options) {
errors.push(
'Missing required "conditions.options". ' +
'IF v2.2+ requires: {version: 2, leftValue: "", caseSensitive: true, typeValidation: "strict"}'
);
} else {
// Validate required fields
const requiredFields = {
version: 2,
leftValue: '',
caseSensitive: 'boolean',
typeValidation: 'strict'
};
for (const [field, expectedValue] of Object.entries(requiredFields)) {
if (!(field in conditions.options)) {
errors.push(
`Missing required field "conditions.options.${field}". ` +
`Expected value: ${typeof expectedValue === 'string' ? `"${expectedValue}"` : expectedValue}`
);
}
}
}
// Validate operators in conditions
if (conditions?.conditions && Array.isArray(conditions.conditions)) {
conditions.conditions.forEach((condition: any, i: number) => {
const operatorErrors = validateOperatorStructure(condition.operator, `conditions.conditions[${i}].operator`);
errors.push(...operatorErrors);
});
}
}
// Validate Switch node
if (isSwitchNode) {
const rules = (node.parameters.rules as any);
if (rules?.rules && Array.isArray(rules.rules)) {
rules.rules.forEach((rule: any, ruleIndex: number) => {
// Check rule.conditions.options
if (!rule.conditions?.options) {
errors.push(
`Missing required "rules.rules[${ruleIndex}].conditions.options". ` +
'Switch v3.2+ requires: {version: 2, leftValue: "", caseSensitive: true, typeValidation: "strict"}'
);
} else {
// Validate required fields
const requiredFields = {
version: 2,
leftValue: '',
caseSensitive: 'boolean',
typeValidation: 'strict'
};
for (const [field, expectedValue] of Object.entries(requiredFields)) {
if (!(field in rule.conditions.options)) {
errors.push(
`Missing required field "rules.rules[${ruleIndex}].conditions.options.${field}". ` +
`Expected value: ${typeof expectedValue === 'string' ? `"${expectedValue}"` : expectedValue}`
);
}
}
}
// Validate operators in rule conditions
if (rule.conditions?.conditions && Array.isArray(rule.conditions.conditions)) {
rule.conditions.conditions.forEach((condition: any, condIndex: number) => {
const operatorErrors = validateOperatorStructure(
condition.operator,
`rules.rules[${ruleIndex}].conditions.conditions[${condIndex}].operator`
);
errors.push(...operatorErrors);
});
}
});
}
}
return errors;
}
/**
* Validate operator structure
* Ensures operator has correct format: {type, operation, singleValue?}
*/
export function validateOperatorStructure(operator: any, path: string): string[] {
const errors: string[] = [];
if (!operator || typeof operator !== 'object') {
errors.push(`${path}: operator is missing or not an object`);
return errors;
}
// Check required field: type (data type, not operation name)
if (!operator.type) {
errors.push(
`${path}: missing required field "type". ` +
'Must be a data type: "string", "number", "boolean", "dateTime", "array", or "object"'
);
} else {
const validTypes = ['string', 'number', 'boolean', 'dateTime', 'array', 'object'];
if (!validTypes.includes(operator.type)) {
errors.push(
`${path}: invalid type "${operator.type}". ` +
`Type must be a data type (${validTypes.join(', ')}), not an operation name. ` +
'Did you mean to use the "operation" field?'
);
}
}
// Check required field: operation
if (!operator.operation) {
errors.push(
`${path}: missing required field "operation". ` +
'Operation specifies the comparison type (e.g., "equals", "contains", "isNotEmpty")'
);
}
// Check singleValue based on operator type
if (operator.operation) {
const unaryOperators = ['isEmpty', 'isNotEmpty', 'true', 'false', 'isNumeric'];
const isUnary = unaryOperators.includes(operator.operation);
if (isUnary) {
// Unary operators MUST have singleValue: true
if (operator.singleValue !== true) {
errors.push(
`${path}: unary operator "${operator.operation}" requires "singleValue: true". ` +
'Unary operators do not use rightValue.'
);
}
} else {
// Binary operators should NOT have singleValue: true
if (operator.singleValue === true) {
errors.push(
`${path}: binary operator "${operator.operation}" should not have "singleValue: true". ` +
'Only unary operators (isEmpty, isNotEmpty, true, false, isNumeric) need this property.'
);
}
}
}
return errors;
}
// Get webhook URL from workflow
export function getWebhookUrl(workflow: Workflow): string | null {
const webhookNode = workflow.nodes.find(node =>

View File

@@ -1,361 +0,0 @@
/**
* Node Sanitizer Service
*
* Ensures nodes have complete metadata required by n8n UI.
* Based on n8n AI Workflow Builder patterns:
* - Merges node type defaults with user parameters
* - Auto-adds required metadata for filter-based nodes (IF v2.2+, Switch v3.2+)
* - Fixes operator structure
* - Prevents "Could not find property option" errors
*/
import { INodeParameters } from 'n8n-workflow';
import { logger } from '../utils/logger';
import { WorkflowNode } from '../types/n8n-api';
/**
* Sanitize a single node by adding required metadata
*/
export function sanitizeNode(node: WorkflowNode): WorkflowNode {
const sanitized = { ...node };
// Apply node-specific sanitization
if (isFilterBasedNode(node.type, node.typeVersion)) {
sanitized.parameters = sanitizeFilterBasedNode(
sanitized.parameters as INodeParameters,
node.type,
node.typeVersion
);
}
return sanitized;
}
/**
* Sanitize all nodes in a workflow
*/
export function sanitizeWorkflowNodes(workflow: any): any {
if (!workflow.nodes || !Array.isArray(workflow.nodes)) {
return workflow;
}
return {
...workflow,
nodes: workflow.nodes.map((node: any) => sanitizeNode(node))
};
}
/**
* Check if node is filter-based (IF v2.2+, Switch v3.2+)
*/
function isFilterBasedNode(nodeType: string, typeVersion: number): boolean {
if (nodeType === 'n8n-nodes-base.if') {
return typeVersion >= 2.2;
}
if (nodeType === 'n8n-nodes-base.switch') {
return typeVersion >= 3.2;
}
return false;
}
/**
* Sanitize filter-based nodes (IF v2.2+, Switch v3.2+)
* Ensures conditions.options has complete structure
*/
function sanitizeFilterBasedNode(
parameters: INodeParameters,
nodeType: string,
typeVersion: number
): INodeParameters {
const sanitized = { ...parameters };
// Handle IF node
if (nodeType === 'n8n-nodes-base.if' && typeVersion >= 2.2) {
sanitized.conditions = sanitizeFilterConditions(sanitized.conditions as any);
}
// Handle Switch node
if (nodeType === 'n8n-nodes-base.switch' && typeVersion >= 3.2) {
if (sanitized.rules && typeof sanitized.rules === 'object') {
const rules = sanitized.rules as any;
if (rules.rules && Array.isArray(rules.rules)) {
rules.rules = rules.rules.map((rule: any) => ({
...rule,
conditions: sanitizeFilterConditions(rule.conditions)
}));
}
}
}
return sanitized;
}
/**
* Sanitize filter conditions structure
*/
function sanitizeFilterConditions(conditions: any): any {
if (!conditions || typeof conditions !== 'object') {
return conditions;
}
const sanitized = { ...conditions };
// Ensure options has complete structure
if (!sanitized.options) {
sanitized.options = {};
}
// Add required filter options metadata
const requiredOptions = {
version: 2,
leftValue: '',
caseSensitive: true,
typeValidation: 'strict'
};
// Merge with existing options, preserving user values
sanitized.options = {
...requiredOptions,
...sanitized.options
};
// Sanitize conditions array
if (sanitized.conditions && Array.isArray(sanitized.conditions)) {
sanitized.conditions = sanitized.conditions.map((condition: any) =>
sanitizeCondition(condition)
);
}
return sanitized;
}
/**
* Sanitize a single condition
*/
function sanitizeCondition(condition: any): any {
if (!condition || typeof condition !== 'object') {
return condition;
}
const sanitized = { ...condition };
// Ensure condition has an ID
if (!sanitized.id) {
sanitized.id = generateConditionId();
}
// Sanitize operator structure
if (sanitized.operator) {
sanitized.operator = sanitizeOperator(sanitized.operator);
}
return sanitized;
}
/**
* Sanitize operator structure
* Ensures operator has correct format: {type, operation, singleValue?}
*/
function sanitizeOperator(operator: any): any {
if (!operator || typeof operator !== 'object') {
return operator;
}
const sanitized = { ...operator };
// Fix common mistake: type field used for operation name
// WRONG: {type: "isNotEmpty"}
// RIGHT: {type: "string", operation: "isNotEmpty"}
if (sanitized.type && !sanitized.operation) {
// Check if type value looks like an operation (lowercase, no dots)
const typeValue = sanitized.type as string;
if (isOperationName(typeValue)) {
logger.debug(`Fixing operator structure: converting type="${typeValue}" to operation`);
// Infer data type from operation
const dataType = inferDataType(typeValue);
sanitized.type = dataType;
sanitized.operation = typeValue;
}
}
// Set singleValue based on operator type
if (sanitized.operation) {
if (isUnaryOperator(sanitized.operation)) {
// Unary operators require singleValue: true
sanitized.singleValue = true;
} else {
// Binary operators should NOT have singleValue (or it should be false/undefined)
// Remove it to prevent UI errors
delete sanitized.singleValue;
}
}
return sanitized;
}
/**
* Check if string looks like an operation name (not a data type)
*/
function isOperationName(value: string): boolean {
// Operation names are lowercase and don't contain dots
// Data types are: string, number, boolean, dateTime, array, object
const dataTypes = ['string', 'number', 'boolean', 'dateTime', 'array', 'object'];
return !dataTypes.includes(value) && /^[a-z][a-zA-Z]*$/.test(value);
}
/**
* Infer data type from operation name
*/
function inferDataType(operation: string): string {
// Boolean operations
const booleanOps = ['true', 'false', 'isEmpty', 'isNotEmpty'];
if (booleanOps.includes(operation)) {
return 'boolean';
}
// Number operations
const numberOps = ['isNumeric', 'gt', 'gte', 'lt', 'lte'];
if (numberOps.some(op => operation.includes(op))) {
return 'number';
}
// Date operations
const dateOps = ['after', 'before', 'afterDate', 'beforeDate'];
if (dateOps.some(op => operation.includes(op))) {
return 'dateTime';
}
// Default to string
return 'string';
}
/**
* Check if operator is unary (requires singleValue: true)
*/
function isUnaryOperator(operation: string): boolean {
const unaryOps = [
'isEmpty',
'isNotEmpty',
'true',
'false',
'isNumeric'
];
return unaryOps.includes(operation);
}
/**
* Generate unique condition ID
*/
function generateConditionId(): string {
return `condition-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
}
/**
* Validate that a node has complete metadata
* Returns array of issues found
*/
export function validateNodeMetadata(node: WorkflowNode): string[] {
const issues: string[] = [];
if (!isFilterBasedNode(node.type, node.typeVersion)) {
return issues; // Not a filter-based node
}
// Check IF node
if (node.type === 'n8n-nodes-base.if') {
const conditions = (node.parameters.conditions as any);
if (!conditions?.options) {
issues.push('Missing conditions.options');
} else {
const required = ['version', 'leftValue', 'typeValidation', 'caseSensitive'];
for (const field of required) {
if (!(field in conditions.options)) {
issues.push(`Missing conditions.options.${field}`);
}
}
}
// Check operators
if (conditions?.conditions && Array.isArray(conditions.conditions)) {
for (let i = 0; i < conditions.conditions.length; i++) {
const condition = conditions.conditions[i];
const operatorIssues = validateOperator(condition.operator, `conditions.conditions[${i}].operator`);
issues.push(...operatorIssues);
}
}
}
// Check Switch node
if (node.type === 'n8n-nodes-base.switch') {
const rules = (node.parameters.rules as any);
if (rules?.rules && Array.isArray(rules.rules)) {
for (let i = 0; i < rules.rules.length; i++) {
const rule = rules.rules[i];
if (!rule.conditions?.options) {
issues.push(`Missing rules.rules[${i}].conditions.options`);
} else {
const required = ['version', 'leftValue', 'typeValidation', 'caseSensitive'];
for (const field of required) {
if (!(field in rule.conditions.options)) {
issues.push(`Missing rules.rules[${i}].conditions.options.${field}`);
}
}
}
// Check operators
if (rule.conditions?.conditions && Array.isArray(rule.conditions.conditions)) {
for (let j = 0; j < rule.conditions.conditions.length; j++) {
const condition = rule.conditions.conditions[j];
const operatorIssues = validateOperator(
condition.operator,
`rules.rules[${i}].conditions.conditions[${j}].operator`
);
issues.push(...operatorIssues);
}
}
}
}
}
return issues;
}
/**
* Validate operator structure
*/
function validateOperator(operator: any, path: string): string[] {
const issues: string[] = [];
if (!operator || typeof operator !== 'object') {
issues.push(`${path}: operator is missing or not an object`);
return issues;
}
if (!operator.type) {
issues.push(`${path}: missing required field 'type'`);
} else if (!['string', 'number', 'boolean', 'dateTime', 'array', 'object'].includes(operator.type)) {
issues.push(`${path}: invalid type "${operator.type}" (must be data type, not operation)`);
}
if (!operator.operation) {
issues.push(`${path}: missing required field 'operation'`);
}
// Check singleValue based on operator type
if (operator.operation) {
if (isUnaryOperator(operator.operation)) {
// Unary operators MUST have singleValue: true
if (operator.singleValue !== true) {
issues.push(`${path}: unary operator "${operator.operation}" requires singleValue: true`);
}
} else {
// Binary operators should NOT have singleValue
if (operator.singleValue === true) {
issues.push(`${path}: binary operator "${operator.operation}" should not have singleValue: true (only unary operators need this)`);
}
}
}
return issues;
}

View File

@@ -269,15 +269,13 @@ export class NodeSpecificValidators {
private static validateGoogleSheetsAppend(context: NodeValidationContext): void {
const { config, errors, warnings, autofix } = context;
// In Google Sheets v4+, range is only required if NOT using the columns resourceMapper
// The columns parameter is a resourceMapper introduced in v4 that handles range automatically
if (!config.range && !config.columns) {
if (!config.range) {
errors.push({
type: 'missing_required',
property: 'range',
message: 'Range or columns mapping is required for append operation',
fix: 'Specify range like "Sheet1!A:B" OR use columns with mappingMode'
message: 'Range is required for append operation',
fix: 'Specify range like "Sheet1!A:B" or "Sheet1!A1:B10"'
});
}
@@ -1038,9 +1036,16 @@ export class NodeSpecificValidators {
delete autofix.continueOnFail;
}
// Note: responseNode mode validation moved to workflow-validator.ts
// where it has access to node-level onError property (not just config/parameters)
// Response mode validation
if (responseMode === 'responseNode' && !config.onError && !config.continueOnFail) {
errors.push({
type: 'invalid_configuration',
property: 'responseMode',
message: 'responseNode mode requires onError: "continueRegularOutput"',
fix: 'Set onError to ensure response is always sent'
});
}
// Always output data for debugging
if (!config.alwaysOutputData) {
suggestions.push('Enable alwaysOutputData to debug webhook payloads');
@@ -1551,59 +1556,4 @@ export class NodeSpecificValidators {
});
}
}
/**
* Validate Set node configuration
*/
static validateSet(context: NodeValidationContext): void {
const { config, errors, warnings } = context;
// Validate jsonOutput when present (used in JSON mode or when directly setting JSON)
if (config.jsonOutput !== undefined && config.jsonOutput !== null && config.jsonOutput !== '') {
try {
const parsed = JSON.parse(config.jsonOutput);
// Set node with JSON input expects an OBJECT {}, not an ARRAY []
// This is a common mistake that n8n UI catches but our validator should too
if (Array.isArray(parsed)) {
errors.push({
type: 'invalid_value',
property: 'jsonOutput',
message: 'Set node expects a JSON object {}, not an array []',
fix: 'Either wrap array items as object properties: {"items": [...]}, OR use a different approach for multiple items'
});
}
// Warn about empty objects
if (typeof parsed === 'object' && !Array.isArray(parsed) && Object.keys(parsed).length === 0) {
warnings.push({
type: 'inefficient',
property: 'jsonOutput',
message: 'jsonOutput is an empty object - this node will output no data',
suggestion: 'Add properties to the object or remove this node if not needed'
});
}
} catch (e) {
errors.push({
type: 'syntax_error',
property: 'jsonOutput',
message: `Invalid JSON in jsonOutput: ${e instanceof Error ? e.message : 'Syntax error'}`,
fix: 'Ensure jsonOutput contains valid JSON syntax'
});
}
}
// Validate mode-specific requirements
if (config.mode === 'manual') {
// In manual mode, at least one field should be defined
const hasFields = config.values && Object.keys(config.values).length > 0;
if (!hasFields && !config.jsonOutput) {
warnings.push({
type: 'missing_common',
message: 'Set node has no fields configured - will output empty items',
suggestion: 'Add fields in the Values section or use JSON mode'
});
}
}
}
}

View File

@@ -21,18 +21,8 @@ export class UniversalExpressionValidator {
private static readonly EXPRESSION_PREFIX = '=';
/**
* Universal Rule 1: Any field containing {{ }} MUST have = prefix to be evaluated
* This applies to BOTH pure expressions and mixed content
*
* Examples:
* - "{{ $json.value }}" -> literal text (NOT evaluated)
* - "={{ $json.value }}" -> evaluated expression
* - "Hello {{ $json.name }}!" -> literal text (NOT evaluated)
* - "=Hello {{ $json.name }}!" -> evaluated (expression in mixed content)
* - "=https://api.com/{{ $json.id }}/data" -> evaluated (real example from n8n)
*
* EXCEPTION: Some langchain node fields auto-evaluate without = prefix
* (validated separately by AI-specific validators)
* Universal Rule 1: Any field containing {{ }} MUST have = prefix
* This is an absolute rule in n8n - no exceptions
*/
static validateExpressionPrefix(value: any): UniversalValidationResult {
// Only validate strings
@@ -63,10 +53,6 @@ export class UniversalExpressionValidator {
const hasPrefix = value.startsWith(this.EXPRESSION_PREFIX);
const isMixedContent = this.hasMixedContent(value);
// For langchain nodes, we don't validate expression prefixes
// They have AI-specific validators that handle their expression rules
// This is checked at the node level, not here
if (!hasPrefix) {
return {
isValid: false,

View File

@@ -31,7 +31,6 @@ import {
import { Workflow, WorkflowNode, WorkflowConnection } from '../types/n8n-api';
import { Logger } from '../utils/logger';
import { validateWorkflowNode, validateWorkflowConnections } from './n8n-validation';
import { sanitizeNode, sanitizeWorkflowNodes } from './node-sanitizer';
const logger = new Logger({ prefix: '[WorkflowDiffEngine]' });
@@ -175,13 +174,6 @@ export class WorkflowDiffEngine {
}
}
// Sanitize ALL nodes in the workflow after operations are applied
// This ensures existing invalid nodes (e.g., binary operators with singleValue: true)
// are fixed automatically when any update is made to the workflow
workflowCopy.nodes = workflowCopy.nodes.map((node: WorkflowNode) => sanitizeNode(node));
logger.debug('Applied full-workflow sanitization to all nodes');
// If validateOnly flag is set, return success without applying
if (request.validateOnly) {
return {
@@ -534,11 +526,8 @@ export class WorkflowDiffEngine {
alwaysOutputData: operation.node.alwaysOutputData,
executeOnce: operation.node.executeOnce
};
// Sanitize node to ensure complete metadata (filter options, operator structure, etc.)
const sanitizedNode = sanitizeNode(newNode);
workflow.nodes.push(sanitizedNode);
workflow.nodes.push(newNode);
}
private applyRemoveNode(workflow: Workflow, operation: RemoveNodeOperation): void {
@@ -578,17 +567,11 @@ export class WorkflowDiffEngine {
private applyUpdateNode(workflow: Workflow, operation: UpdateNodeOperation): void {
const node = this.findNode(workflow, operation.nodeId, operation.nodeName);
if (!node) return;
// Apply updates using dot notation
Object.entries(operation.updates).forEach(([path, value]) => {
this.setNestedProperty(node, path, value);
});
// Sanitize node after updates to ensure metadata is complete
const sanitized = sanitizeNode(node);
// Update the node in-place
Object.assign(node, sanitized);
}
private applyMoveNode(workflow: Workflow, operation: MoveNodeOperation): void {

View File

@@ -10,8 +10,6 @@ import { ExpressionFormatValidator } from './expression-format-validator';
import { NodeSimilarityService, NodeSuggestion } from './node-similarity-service';
import { NodeTypeNormalizer } from '../utils/node-type-normalizer';
import { Logger } from '../utils/logger';
import { validateAISpecificNodes, hasAINodes } from './ai-node-validator';
import { isNonExecutableNode } from '../utils/node-classification';
const logger = new Logger({ prefix: '[WorkflowValidator]' });
interface WorkflowNode {
@@ -86,8 +84,17 @@ export class WorkflowValidator {
this.similarityService = new NodeSimilarityService(nodeRepository);
}
// Note: isStickyNote logic moved to shared utility: src/utils/node-classification.ts
// Use isNonExecutableNode(node.type) instead
/**
* Check if a node is a Sticky Note or other non-executable node
*/
private isStickyNote(node: WorkflowNode): boolean {
const stickyNoteTypes = [
'n8n-nodes-base.stickyNote',
'nodes-base.stickyNote',
'@n8n/n8n-nodes-base.stickyNote'
];
return stickyNoteTypes.includes(node.type);
}
/**
* Validate a complete workflow
@@ -138,7 +145,7 @@ export class WorkflowValidator {
}
// Update statistics after null check (exclude sticky notes from counts)
const executableNodes = Array.isArray(workflow.nodes) ? workflow.nodes.filter(n => !isNonExecutableNode(n.type)) : [];
const executableNodes = Array.isArray(workflow.nodes) ? workflow.nodes.filter(n => !this.isStickyNote(n)) : [];
result.statistics.totalNodes = executableNodes.length;
result.statistics.enabledNodes = executableNodes.filter(n => !n.disabled).length;
@@ -167,30 +174,9 @@ export class WorkflowValidator {
this.checkWorkflowPatterns(workflow, result, profile);
}
// Validate AI-specific nodes (AI Agent, Chat Trigger, AI tools)
if (workflow.nodes.length > 0 && hasAINodes(workflow)) {
const aiIssues = validateAISpecificNodes(workflow);
// Convert AI validation issues to workflow validation format
for (const issue of aiIssues) {
const validationIssue: ValidationIssue = {
type: issue.severity === 'error' ? 'error' : 'warning',
nodeId: issue.nodeId,
nodeName: issue.nodeName,
message: issue.message,
details: issue.code ? { code: issue.code } : undefined
};
if (issue.severity === 'error') {
result.errors.push(validationIssue);
} else {
result.warnings.push(validationIssue);
}
}
}
// Add suggestions based on findings
this.generateSuggestions(workflow, result);
// Add AI-specific recovery suggestions if there are errors
if (result.errors.length > 0) {
this.addErrorRecoverySuggestions(result);
@@ -264,15 +250,13 @@ export class WorkflowValidator {
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(singleNode.type);
const isWebhook = normalizedType === 'nodes-base.webhook' ||
normalizedType === 'nodes-base.webhookTrigger';
const isLangchainNode = normalizedType.startsWith('nodes-langchain.');
// Langchain nodes can be validated standalone for AI tool purposes
if (!isWebhook && !isLangchainNode) {
if (!isWebhook) {
result.errors.push({
type: 'error',
message: 'Single-node workflows are only valid for webhook endpoints. Add at least one more connected node to create a functional workflow.'
});
} else if (isWebhook && Object.keys(workflow.connections).length === 0) {
} else if (Object.keys(workflow.connections).length === 0) {
result.warnings.push({
type: 'warning',
message: 'Webhook node has no connections. Consider adding nodes to process the webhook data.'
@@ -321,9 +305,8 @@ export class WorkflowValidator {
// Count trigger nodes - normalize type names first
const triggerNodes = workflow.nodes.filter(n => {
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(n.type);
const lowerType = normalizedType.toLowerCase();
return lowerType.includes('trigger') ||
(lowerType.includes('webhook') && !lowerType.includes('respond')) ||
return normalizedType.toLowerCase().includes('trigger') ||
normalizedType.toLowerCase().includes('webhook') ||
normalizedType === 'nodes-base.start' ||
normalizedType === 'nodes-base.manualTrigger' ||
normalizedType === 'nodes-base.formTrigger';
@@ -348,7 +331,7 @@ export class WorkflowValidator {
profile: string
): Promise<void> {
for (const node of workflow.nodes) {
if (node.disabled || isNonExecutableNode(node.type)) continue;
if (node.disabled || this.isStickyNote(node)) continue;
try {
// Validate node name length
@@ -389,11 +372,10 @@ export class WorkflowValidator {
node.type = normalizedType;
}
// Get node definition using normalized type (needed for typeVersion validation)
// Get node definition using normalized type
const nodeInfo = this.nodeRepository.getNode(normalizedType);
if (!nodeInfo) {
// Use NodeSimilarityService to find suggestions
const suggestions = await this.similarityService.findSimilarNodes(node.type, 3);
@@ -436,10 +418,7 @@ export class WorkflowValidator {
continue;
}
// Validate typeVersion for ALL versioned nodes (including langchain nodes)
// CRITICAL: This MUST run BEFORE the langchain skip below!
// Otherwise, langchain nodes with invalid typeVersion (e.g., 99999) would pass validation
// but fail at runtime in n8n. This was the bug fixed in v2.17.4.
// Validate typeVersion for versioned nodes
if (nodeInfo.isVersioned) {
// Check if typeVersion is missing
if (!node.typeVersion) {
@@ -449,14 +428,14 @@ export class WorkflowValidator {
nodeName: node.name,
message: `Missing required property 'typeVersion'. Add typeVersion: ${nodeInfo.version || 1}`
});
}
// Check if typeVersion is invalid (must be non-negative number, version 0 is valid)
else if (typeof node.typeVersion !== 'number' || node.typeVersion < 0) {
}
// Check if typeVersion is invalid
else if (typeof node.typeVersion !== 'number' || node.typeVersion < 1) {
result.errors.push({
type: 'error',
nodeId: node.id,
nodeName: node.name,
message: `Invalid typeVersion: ${node.typeVersion}. Must be a non-negative number`
message: `Invalid typeVersion: ${node.typeVersion}. Must be a positive number`
});
}
// Check if typeVersion is outdated (less than latest)
@@ -479,13 +458,6 @@ export class WorkflowValidator {
}
}
// Skip PARAMETER validation for langchain nodes (but NOT typeVersion validation above!)
// Langchain nodes have dedicated AI-specific validators in validateAISpecificNodes()
// which handle their unique parameter structures (AI connections, tool ports, etc.)
if (normalizedType.startsWith('nodes-langchain.')) {
continue;
}
// Validate node configuration
const nodeValidation = this.nodeValidator.validateWithMode(
node.type,
@@ -624,7 +596,7 @@ export class WorkflowValidator {
// Check for orphaned nodes (exclude sticky notes)
for (const node of workflow.nodes) {
if (node.disabled || isNonExecutableNode(node.type)) continue;
if (node.disabled || this.isStickyNote(node)) continue;
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(node.type);
const isTrigger = normalizedType.toLowerCase().includes('trigger') ||
@@ -869,7 +841,7 @@ export class WorkflowValidator {
// Build node type map (exclude sticky notes)
workflow.nodes.forEach(node => {
if (!isNonExecutableNode(node.type)) {
if (!this.isStickyNote(node)) {
nodeTypeMap.set(node.name, node.type);
}
});
@@ -937,7 +909,7 @@ export class WorkflowValidator {
// Check from all executable nodes (exclude sticky notes)
for (const node of workflow.nodes) {
if (!isNonExecutableNode(node.type) && !visited.has(node.name)) {
if (!this.isStickyNote(node) && !visited.has(node.name)) {
if (hasCycleDFS(node.name)) return true;
}
}
@@ -956,14 +928,7 @@ export class WorkflowValidator {
const nodeNames = workflow.nodes.map(n => n.name);
for (const node of workflow.nodes) {
if (node.disabled || isNonExecutableNode(node.type)) continue;
// Skip expression validation for langchain nodes
// They have AI-specific validators and different expression rules
const normalizedType = NodeTypeNormalizer.normalizeToFullForm(node.type);
if (normalizedType.startsWith('nodes-langchain.')) {
continue;
}
if (node.disabled || this.isStickyNote(node)) continue;
// Create expression context
const context = {
@@ -1103,7 +1068,7 @@ export class WorkflowValidator {
// Check node-level error handling properties for ALL executable nodes
for (const node of workflow.nodes) {
if (!isNonExecutableNode(node.type)) {
if (!this.isStickyNote(node)) {
this.checkNodeErrorHandling(node, workflow, result);
}
}
@@ -1284,15 +1249,6 @@ export class WorkflowValidator {
/**
* Check node-level error handling configuration for a single node
*
* Validates error handling properties (onError, continueOnFail, retryOnFail)
* and provides warnings for error-prone nodes (HTTP, webhooks, databases)
* that lack proper error handling. Delegates webhook-specific validation
* to checkWebhookErrorHandling() for clearer logic.
*
* @param node - The workflow node to validate
* @param workflow - The complete workflow for context
* @param result - Validation result to add errors/warnings to
*/
private checkNodeErrorHandling(
node: WorkflowNode,
@@ -1503,8 +1459,12 @@ export class WorkflowValidator {
message: 'HTTP Request node without error handling. Consider adding "onError: \'continueRegularOutput\'" for non-critical requests or "retryOnFail: true" for transient failures.'
});
} else if (normalizedType.includes('webhook')) {
// Delegate to specialized webhook validation helper
this.checkWebhookErrorHandling(node, normalizedType, result);
result.warnings.push({
type: 'warning',
nodeId: node.id,
nodeName: node.name,
message: 'Webhook node without error handling. Consider adding "onError: \'continueRegularOutput\'" to prevent workflow failures from blocking webhook responses.'
});
} else if (errorProneNodeTypes.some(db => normalizedType.includes(db) && ['postgres', 'mysql', 'mongodb'].includes(db))) {
result.warnings.push({
type: 'warning',
@@ -1595,52 +1555,6 @@ export class WorkflowValidator {
}
/**
* Check webhook-specific error handling requirements
*
* Webhooks have special error handling requirements:
* - respondToWebhook nodes (response nodes) don't need error handling
* - Webhook nodes with responseNode mode REQUIRE onError to ensure responses
* - Regular webhook nodes should have error handling to prevent blocking
*
* @param node - The webhook node to check
* @param normalizedType - Normalized node type for comparison
* @param result - Validation result to add errors/warnings to
*/
private checkWebhookErrorHandling(
node: WorkflowNode,
normalizedType: string,
result: WorkflowValidationResult
): void {
// respondToWebhook nodes are response nodes (endpoints), not triggers
// They're the END of execution, not controllers of flow - skip error handling check
if (normalizedType.includes('respondtowebhook')) {
return;
}
// Check for responseNode mode specifically
// responseNode mode requires onError to ensure response is sent even on error
if (node.parameters?.responseMode === 'responseNode') {
if (!node.onError && !node.continueOnFail) {
result.errors.push({
type: 'error',
nodeId: node.id,
nodeName: node.name,
message: 'responseNode mode requires onError: "continueRegularOutput"'
});
}
return;
}
// Regular webhook nodes without responseNode mode
result.warnings.push({
type: 'warning',
nodeId: node.id,
nodeName: node.name,
message: 'Webhook node without error handling. Consider adding "onError: \'continueRegularOutput\'" to prevent workflow failures from blocking webhook responses.'
});
}
/**
* Generate error handling suggestions based on all nodes
*/

View File

@@ -37,135 +37,12 @@ export class TelemetryConfigManager {
/**
* Generate a deterministic anonymous user ID based on machine characteristics
* Uses Docker/cloud-specific method for containerized environments
*/
private generateUserId(): string {
// Use boot_id for all Docker/cloud environments (stable across container updates)
if (process.env.IS_DOCKER === 'true' || this.isCloudEnvironment()) {
return this.generateDockerStableId();
}
// Local installations use file-based method with hostname
const machineId = `${hostname()}-${platform()}-${arch()}-${homedir()}`;
return createHash('sha256').update(machineId).digest('hex').substring(0, 16);
}
/**
* Generate stable user ID for Docker/cloud environments
* Priority: boot_id → combined signals → generic fallback
*/
private generateDockerStableId(): string {
// Priority 1: Try boot_id (stable across container recreations)
const bootId = this.readBootId();
if (bootId) {
const fingerprint = `${bootId}-${platform()}-${arch()}`;
return createHash('sha256').update(fingerprint).digest('hex').substring(0, 16);
}
// Priority 2: Try combined host signals
const combinedFingerprint = this.generateCombinedFingerprint();
if (combinedFingerprint) {
return combinedFingerprint;
}
// Priority 3: Generic Docker ID (allows aggregate statistics)
const genericId = `docker-${platform()}-${arch()}`;
return createHash('sha256').update(genericId).digest('hex').substring(0, 16);
}
/**
* Read host boot_id from /proc (available in Linux containers)
* Returns null if not available or invalid format
*/
private readBootId(): string | null {
try {
const bootIdPath = '/proc/sys/kernel/random/boot_id';
if (!existsSync(bootIdPath)) {
return null;
}
const bootId = readFileSync(bootIdPath, 'utf-8').trim();
// Validate UUID format (8-4-4-4-12 hex digits)
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
if (!uuidRegex.test(bootId)) {
return null;
}
return bootId;
} catch (error) {
// File not readable or other error
return null;
}
}
/**
* Generate fingerprint from combined host signals
* Fallback for environments where boot_id is not available
*/
private generateCombinedFingerprint(): string | null {
try {
const signals: string[] = [];
// CPU cores (stable)
if (existsSync('/proc/cpuinfo')) {
const cpuinfo = readFileSync('/proc/cpuinfo', 'utf-8');
const cores = (cpuinfo.match(/processor\s*:/g) || []).length;
if (cores > 0) {
signals.push(`cores:${cores}`);
}
}
// Memory (stable)
if (existsSync('/proc/meminfo')) {
const meminfo = readFileSync('/proc/meminfo', 'utf-8');
const totalMatch = meminfo.match(/MemTotal:\s+(\d+)/);
if (totalMatch) {
signals.push(`mem:${totalMatch[1]}`);
}
}
// Kernel version (stable)
if (existsSync('/proc/version')) {
const version = readFileSync('/proc/version', 'utf-8');
const kernelMatch = version.match(/Linux version ([\d.]+)/);
if (kernelMatch) {
signals.push(`kernel:${kernelMatch[1]}`);
}
}
// Platform and arch
signals.push(platform(), arch());
// Need at least 3 signals for reasonable uniqueness
if (signals.length < 3) {
return null;
}
const fingerprint = signals.join('-');
return createHash('sha256').update(fingerprint).digest('hex').substring(0, 16);
} catch (error) {
return null;
}
}
/**
* Check if running in a cloud environment
*/
private isCloudEnvironment(): boolean {
return !!(
process.env.RAILWAY_ENVIRONMENT ||
process.env.RENDER ||
process.env.FLY_APP_NAME ||
process.env.HEROKU_APP_NAME ||
process.env.AWS_EXECUTION_ENV ||
process.env.KUBERNETES_SERVICE_HOST ||
process.env.GOOGLE_CLOUD_PROJECT ||
process.env.AZURE_FUNCTIONS_ENVIRONMENT
);
}
/**
* Load configuration from disk or create default
*/

View File

@@ -1,298 +0,0 @@
/**
* Early Error Logger (v2.18.3)
* Captures errors that occur BEFORE the main telemetry system is ready
* Uses direct Supabase insert to bypass batching and ensure immediate persistence
*
* CRITICAL FIXES:
* - Singleton pattern to prevent multiple instances
* - Defensive initialization (safe defaults before any throwing operation)
* - Timeout wrapper for Supabase operations (5s max)
* - Shared sanitization utilities (DRY principle)
*/
import { createClient, SupabaseClient } from '@supabase/supabase-js';
import { TelemetryConfigManager } from './config-manager';
import { TELEMETRY_BACKEND } from './telemetry-types';
import { StartupCheckpoint, isValidCheckpoint, getCheckpointDescription } from './startup-checkpoints';
import { sanitizeErrorMessageCore } from './error-sanitization-utils';
import { logger } from '../utils/logger';
/**
* Timeout wrapper for async operations
* Prevents hanging if Supabase is unreachable
*/
async function withTimeout<T>(promise: Promise<T>, timeoutMs: number, operation: string): Promise<T | null> {
try {
const timeoutPromise = new Promise<T>((_, reject) => {
setTimeout(() => reject(new Error(`${operation} timeout after ${timeoutMs}ms`)), timeoutMs);
});
return await Promise.race([promise, timeoutPromise]);
} catch (error) {
logger.debug(`${operation} failed or timed out:`, error);
return null;
}
}
export class EarlyErrorLogger {
// Singleton instance
private static instance: EarlyErrorLogger | null = null;
// DEFENSIVE INITIALIZATION: Initialize all fields to safe defaults FIRST
// This ensures the object is in a valid state even if initialization fails
private enabled: boolean = false; // Safe default: disabled
private supabase: SupabaseClient | null = null; // Safe default: null
private userId: string | null = null; // Safe default: null
private checkpoints: StartupCheckpoint[] = [];
private startTime: number = Date.now();
private initPromise: Promise<void>;
/**
* Private constructor - use getInstance() instead
* Ensures only one instance exists per process
*/
private constructor() {
// Kick off async initialization without blocking
this.initPromise = this.initialize();
}
/**
* Get singleton instance
* Safe to call from anywhere - initialization errors won't crash caller
*/
static getInstance(): EarlyErrorLogger {
if (!EarlyErrorLogger.instance) {
EarlyErrorLogger.instance = new EarlyErrorLogger();
}
return EarlyErrorLogger.instance;
}
/**
* Async initialization logic
* Separated from constructor to prevent throwing before safe defaults are set
*/
private async initialize(): Promise<void> {
try {
// Validate backend configuration before using
if (!TELEMETRY_BACKEND.URL || !TELEMETRY_BACKEND.ANON_KEY) {
logger.debug('Telemetry backend not configured, early error logger disabled');
this.enabled = false;
return;
}
// Check if telemetry is disabled by user
const configManager = TelemetryConfigManager.getInstance();
const isEnabled = configManager.isEnabled();
if (!isEnabled) {
logger.debug('Telemetry disabled by user, early error logger will not send events');
this.enabled = false;
return;
}
// Initialize Supabase client for direct inserts
this.supabase = createClient(
TELEMETRY_BACKEND.URL,
TELEMETRY_BACKEND.ANON_KEY,
{
auth: {
persistSession: false,
autoRefreshToken: false,
},
}
);
// Get user ID from config manager
this.userId = configManager.getUserId();
// Mark as enabled only after successful initialization
this.enabled = true;
logger.debug('Early error logger initialized successfully');
} catch (error) {
// Initialization failed - ensure safe state
logger.debug('Early error logger initialization failed:', error);
this.enabled = false;
this.supabase = null;
this.userId = null;
}
}
/**
* Wait for initialization to complete (for testing)
* Not needed in production - all methods handle uninitialized state gracefully
*/
async waitForInit(): Promise<void> {
await this.initPromise;
}
/**
* Log a checkpoint as the server progresses through startup
* FIRE-AND-FORGET: Does not block caller (no await needed)
*/
logCheckpoint(checkpoint: StartupCheckpoint): void {
if (!this.enabled) {
return;
}
try {
// Validate checkpoint
if (!isValidCheckpoint(checkpoint)) {
logger.warn(`Invalid checkpoint: ${checkpoint}`);
return;
}
// Add to internal checkpoint list
this.checkpoints.push(checkpoint);
logger.debug(`Checkpoint passed: ${checkpoint} (${getCheckpointDescription(checkpoint)})`);
} catch (error) {
// Don't throw - we don't want checkpoint logging to crash the server
logger.debug('Failed to log checkpoint:', error);
}
}
/**
* Log a startup error with checkpoint context
* This is the main error capture mechanism
* FIRE-AND-FORGET: Does not block caller
*/
logStartupError(checkpoint: StartupCheckpoint, error: unknown): void {
if (!this.enabled || !this.supabase || !this.userId) {
return;
}
// Run async operation without blocking caller
this.logStartupErrorAsync(checkpoint, error).catch((logError) => {
// Swallow errors - telemetry must never crash the server
logger.debug('Failed to log startup error:', logError);
});
}
/**
* Internal async implementation with timeout wrapper
*/
private async logStartupErrorAsync(checkpoint: StartupCheckpoint, error: unknown): Promise<void> {
try {
// Sanitize error message using shared utilities (v2.18.3)
let errorMessage = 'Unknown error';
if (error instanceof Error) {
errorMessage = error.message;
if (error.stack) {
errorMessage = error.stack;
}
} else if (typeof error === 'string') {
errorMessage = error;
} else {
errorMessage = String(error);
}
const sanitizedError = sanitizeErrorMessageCore(errorMessage);
// Extract error type if it's an Error object
let errorType = 'unknown';
if (error instanceof Error) {
errorType = error.name || 'Error';
} else if (typeof error === 'string') {
errorType = 'string_error';
}
// Create startup_error event
const event = {
user_id: this.userId!,
event: 'startup_error',
properties: {
checkpoint,
errorMessage: sanitizedError,
errorType,
checkpointsPassed: this.checkpoints,
checkpointsPassedCount: this.checkpoints.length,
startupDuration: Date.now() - this.startTime,
platform: process.platform,
arch: process.arch,
nodeVersion: process.version,
isDocker: process.env.IS_DOCKER === 'true',
},
created_at: new Date().toISOString(),
};
// Direct insert to Supabase with timeout (5s max)
const insertOperation = async () => {
return await this.supabase!
.from('events')
.insert(event)
.select()
.single();
};
const result = await withTimeout(insertOperation(), 5000, 'Startup error insert');
if (result && 'error' in result && result.error) {
logger.debug('Failed to insert startup error event:', result.error);
} else if (result) {
logger.debug(`Startup error logged for checkpoint: ${checkpoint}`);
}
} catch (logError) {
// Don't throw - telemetry failures should never crash the server
logger.debug('Failed to log startup error:', logError);
}
}
/**
* Log successful startup completion
* Called when all checkpoints have been passed
* FIRE-AND-FORGET: Does not block caller
*/
logStartupSuccess(checkpoints: StartupCheckpoint[], durationMs: number): void {
if (!this.enabled) {
return;
}
try {
// Store checkpoints for potential session_start enhancement
this.checkpoints = checkpoints;
logger.debug(`Startup successful: ${checkpoints.length} checkpoints passed in ${durationMs}ms`);
// We don't send a separate event here - this data will be included
// in the session_start event sent by the main telemetry system
} catch (error) {
logger.debug('Failed to log startup success:', error);
}
}
/**
* Get the list of checkpoints passed so far
*/
getCheckpoints(): StartupCheckpoint[] {
return [...this.checkpoints];
}
/**
* Get startup duration in milliseconds
*/
getStartupDuration(): number {
return Date.now() - this.startTime;
}
/**
* Get startup data for inclusion in session_start event
*/
getStartupData(): { durationMs: number; checkpoints: StartupCheckpoint[] } | null {
if (!this.enabled) {
return null;
}
return {
durationMs: this.getStartupDuration(),
checkpoints: this.getCheckpoints(),
};
}
/**
* Check if early logger is enabled
*/
isEnabled(): boolean {
return this.enabled && this.supabase !== null && this.userId !== null;
}
}

View File

@@ -1,75 +0,0 @@
/**
* Shared Error Sanitization Utilities
* Used by both error-sanitizer.ts and event-tracker.ts to avoid code duplication
*
* Security patterns from v2.15.3 with ReDoS fix from v2.18.3
*/
import { logger } from '../utils/logger';
/**
* Core error message sanitization with security-focused patterns
*
* Sanitization order (critical for preventing leakage):
* 1. Early truncation (ReDoS prevention)
* 2. Stack trace limitation
* 3. URLs (most encompassing) - fully redact
* 4. Specific credentials (AWS, GitHub, JWT, Bearer)
* 5. Emails (after URLs)
* 6. Long keys and tokens
* 7. Generic credential patterns
* 8. Final truncation
*
* @param errorMessage - Raw error message to sanitize
* @returns Sanitized error message safe for telemetry
*/
export function sanitizeErrorMessageCore(errorMessage: string): string {
try {
// Early truncate to prevent ReDoS and performance issues
const maxLength = 1500;
const trimmed = errorMessage.length > maxLength
? errorMessage.substring(0, maxLength)
: errorMessage;
// Handle stack traces - keep only first 3 lines (message + top stack frames)
const lines = trimmed.split('\n');
let sanitized = lines.slice(0, 3).join('\n');
// Sanitize sensitive data in correct order to prevent leakage
// 1. URLs first (most encompassing) - fully redact to prevent path leakage
sanitized = sanitized.replace(/https?:\/\/\S+/gi, '[URL]');
// 2. Specific credential patterns (before generic patterns)
sanitized = sanitized
.replace(/AKIA[A-Z0-9]{16}/g, '[AWS_KEY]')
.replace(/ghp_[a-zA-Z0-9]{36,}/g, '[GITHUB_TOKEN]')
.replace(/eyJ[a-zA-Z0-9_-]+\.eyJ[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+/g, '[JWT]')
.replace(/Bearer\s+[^\s]+/gi, 'Bearer [TOKEN]');
// 3. Emails (after URLs to avoid partial matches)
sanitized = sanitized.replace(/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g, '[EMAIL]');
// 4. Long keys and quoted tokens
sanitized = sanitized
.replace(/\b[a-zA-Z0-9_-]{32,}\b/g, '[KEY]')
.replace(/(['"])[a-zA-Z0-9_-]{16,}\1/g, '$1[TOKEN]$1');
// 5. Generic credential patterns (after specific ones to avoid conflicts)
// FIX (v2.18.3): Replaced negative lookbehind with simpler regex to prevent ReDoS
sanitized = sanitized
.replace(/password\s*[=:]\s*\S+/gi, 'password=[REDACTED]')
.replace(/api[_-]?key\s*[=:]\s*\S+/gi, 'api_key=[REDACTED]')
.replace(/\btoken\s*[=:]\s*[^\s;,)]+/gi, 'token=[REDACTED]'); // Simplified regex (no negative lookbehind)
// Final truncate to 500 chars
if (sanitized.length > 500) {
sanitized = sanitized.substring(0, 500) + '...';
}
return sanitized;
} catch (error) {
logger.debug('Error message sanitization failed:', error);
return '[SANITIZATION_FAILED]';
}
}

View File

@@ -1,65 +0,0 @@
/**
* Error Sanitizer for Startup Errors (v2.18.3)
* Extracts and sanitizes error messages with security-focused patterns
* Now uses shared sanitization utilities to avoid code duplication
*/
import { logger } from '../utils/logger';
import { sanitizeErrorMessageCore } from './error-sanitization-utils';
/**
* Extract error message from unknown error type
* Safely handles Error objects, strings, and other types
*/
export function extractErrorMessage(error: unknown): string {
try {
if (error instanceof Error) {
// Include stack trace if available (will be truncated later)
return error.stack || error.message || 'Unknown error';
}
if (typeof error === 'string') {
return error;
}
if (error && typeof error === 'object') {
// Try to extract message from object
const errorObj = error as any;
if (errorObj.message) {
return String(errorObj.message);
}
if (errorObj.error) {
return String(errorObj.error);
}
// Fall back to JSON stringify with truncation
try {
return JSON.stringify(error).substring(0, 500);
} catch {
return 'Error object (unstringifiable)';
}
}
return String(error);
} catch (extractError) {
logger.debug('Error during message extraction:', extractError);
return 'Error message extraction failed';
}
}
/**
* Sanitize startup error message to remove sensitive data
* Now uses shared sanitization core from error-sanitization-utils.ts (v2.18.3)
* This eliminates code duplication and the ReDoS vulnerability
*/
export function sanitizeStartupError(errorMessage: string): string {
return sanitizeErrorMessageCore(errorMessage);
}
/**
* Combined operation: Extract and sanitize error message
* This is the main entry point for startup error processing
*/
export function processStartupError(error: unknown): string {
const message = extractErrorMessage(error);
return sanitizeStartupError(message);
}

View File

@@ -1,7 +1,6 @@
/**
* Event Tracker for Telemetry (v2.18.3)
* Event Tracker for Telemetry
* Handles all event tracking logic extracted from TelemetryManager
* Now uses shared sanitization utilities to avoid code duplication
*/
import { TelemetryEvent, WorkflowTelemetry } from './telemetry-types';
@@ -12,7 +11,6 @@ import { TelemetryError, TelemetryErrorType } from './telemetry-error';
import { logger } from '../utils/logger';
import { existsSync, readFileSync } from 'fs';
import { resolve } from 'path';
import { sanitizeErrorMessageCore } from './error-sanitization-utils';
export class TelemetryEventTracker {
private rateLimiter: TelemetryRateLimiter;
@@ -138,9 +136,6 @@ export class TelemetryEventTracker {
context: this.sanitizeContext(context),
tool: toolName ? toolName.replace(/[^a-zA-Z0-9_-]/g, '_') : undefined,
error: errorMessage ? this.sanitizeErrorMessage(errorMessage) : undefined,
// Add environment context for better error analysis
mcpMode: process.env.MCP_MODE || 'stdio',
platform: process.platform
}, false); // Skip rate limiting for errors
}
@@ -170,13 +165,9 @@ export class TelemetryEventTracker {
}
/**
* Track session start with optional startup tracking data (v2.18.2)
* Track session start
*/
trackSessionStart(startupData?: {
durationMs?: number;
checkpoints?: string[];
errorCount?: number;
}): void {
trackSessionStart(): void {
if (!this.isEnabled()) return;
this.trackEvent('session_start', {
@@ -184,44 +175,9 @@ export class TelemetryEventTracker {
platform: process.platform,
arch: process.arch,
nodeVersion: process.version,
isDocker: process.env.IS_DOCKER === 'true',
cloudPlatform: this.detectCloudPlatform(),
mcpMode: process.env.MCP_MODE || 'stdio',
// NEW: Startup tracking fields (v2.18.2)
startupDurationMs: startupData?.durationMs,
checkpointsPassed: startupData?.checkpoints,
startupErrorCount: startupData?.errorCount || 0,
});
}
/**
* Track startup completion (v2.18.2)
* Called after first successful tool call to confirm server is functional
*/
trackStartupComplete(): void {
if (!this.isEnabled()) return;
this.trackEvent('startup_completed', {
version: this.getPackageVersion(),
});
}
/**
* Detect cloud platform from environment variables
* Returns platform name or null if not in cloud
*/
private detectCloudPlatform(): string | null {
if (process.env.RAILWAY_ENVIRONMENT) return 'railway';
if (process.env.RENDER) return 'render';
if (process.env.FLY_APP_NAME) return 'fly';
if (process.env.HEROKU_APP_NAME) return 'heroku';
if (process.env.AWS_EXECUTION_ENV) return 'aws';
if (process.env.KUBERNETES_SERVICE_HOST) return 'kubernetes';
if (process.env.GOOGLE_CLOUD_PROJECT) return 'gcp';
if (process.env.AZURE_FUNCTIONS_ENVIRONMENT) return 'azure';
return null;
}
/**
* Track search queries
*/
@@ -476,10 +432,53 @@ export class TelemetryEventTracker {
/**
* Sanitize error message
* Now uses shared sanitization core from error-sanitization-utils.ts (v2.18.3)
* This eliminates code duplication and the ReDoS vulnerability
*/
private sanitizeErrorMessage(errorMessage: string): string {
return sanitizeErrorMessageCore(errorMessage);
try {
// Early truncate to prevent ReDoS and performance issues
const maxLength = 1500;
const trimmed = errorMessage.length > maxLength
? errorMessage.substring(0, maxLength)
: errorMessage;
// Handle stack traces - keep only first 3 lines (message + top stack frames)
const lines = trimmed.split('\n');
let sanitized = lines.slice(0, 3).join('\n');
// Sanitize sensitive data in correct order to prevent leakage
// 1. URLs first (most encompassing) - fully redact to prevent path leakage
sanitized = sanitized.replace(/https?:\/\/\S+/gi, '[URL]');
// 2. Specific credential patterns (before generic patterns)
sanitized = sanitized
.replace(/AKIA[A-Z0-9]{16}/g, '[AWS_KEY]')
.replace(/ghp_[a-zA-Z0-9]{36,}/g, '[GITHUB_TOKEN]')
.replace(/eyJ[a-zA-Z0-9_-]+\.eyJ[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+/g, '[JWT]')
.replace(/Bearer\s+[^\s]+/gi, 'Bearer [TOKEN]');
// 3. Emails (after URLs to avoid partial matches)
sanitized = sanitized.replace(/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g, '[EMAIL]');
// 4. Long keys and quoted tokens
sanitized = sanitized
.replace(/\b[a-zA-Z0-9_-]{32,}\b/g, '[KEY]')
.replace(/(['"])[a-zA-Z0-9_-]{16,}\1/g, '$1[TOKEN]$1');
// 5. Generic credential patterns (after specific ones to avoid conflicts)
sanitized = sanitized
.replace(/password\s*[=:]\s*\S+/gi, 'password=[REDACTED]')
.replace(/api[_-]?key\s*[=:]\s*\S+/gi, 'api_key=[REDACTED]')
.replace(/(?<!Bearer\s)token\s*[=:]\s*\S+/gi, 'token=[REDACTED]'); // Negative lookbehind to avoid Bearer tokens
// Final truncate to 500 chars
if (sanitized.length > 500) {
sanitized = sanitized.substring(0, 500) + '...';
}
return sanitized;
} catch (error) {
logger.debug('Error message sanitization failed:', error);
return '[SANITIZATION_FAILED]';
}
}
}

View File

@@ -104,33 +104,12 @@ const performanceMetricPropertiesSchema = z.object({
metadata: z.record(z.any()).optional()
});
// Schema for startup_error event properties (v2.18.2)
const startupErrorPropertiesSchema = z.object({
checkpoint: z.string().max(100),
errorMessage: z.string().max(500),
errorType: z.string().max(100),
checkpointsPassed: z.array(z.string()).max(20),
checkpointsPassedCount: z.number().int().min(0).max(20),
startupDuration: z.number().min(0).max(300000), // Max 5 minutes
platform: z.string().max(50),
arch: z.string().max(50),
nodeVersion: z.string().max(50),
isDocker: z.boolean()
});
// Schema for startup_completed event properties (v2.18.2)
const startupCompletedPropertiesSchema = z.object({
version: z.string().max(50)
});
// Map of event names to their specific schemas
const EVENT_SCHEMAS: Record<string, z.ZodSchema<any>> = {
'tool_used': toolUsagePropertiesSchema,
'search_query': searchQueryPropertiesSchema,
'validation_details': validationDetailsPropertiesSchema,
'performance_metric': performanceMetricPropertiesSchema,
'startup_error': startupErrorPropertiesSchema,
'startup_completed': startupCompletedPropertiesSchema,
};
/**

View File

@@ -1,133 +0,0 @@
/**
* Startup Checkpoint System
* Defines checkpoints throughout the server initialization process
* to identify where failures occur
*/
/**
* Startup checkpoint constants
* These checkpoints mark key stages in the server initialization process
*/
export const STARTUP_CHECKPOINTS = {
/** Process has started, very first checkpoint */
PROCESS_STARTED: 'process_started',
/** About to connect to database */
DATABASE_CONNECTING: 'database_connecting',
/** Database connection successful */
DATABASE_CONNECTED: 'database_connected',
/** About to check n8n API configuration (if applicable) */
N8N_API_CHECKING: 'n8n_api_checking',
/** n8n API is configured and ready (if applicable) */
N8N_API_READY: 'n8n_api_ready',
/** About to initialize telemetry system */
TELEMETRY_INITIALIZING: 'telemetry_initializing',
/** Telemetry system is ready */
TELEMETRY_READY: 'telemetry_ready',
/** About to start MCP handshake */
MCP_HANDSHAKE_STARTING: 'mcp_handshake_starting',
/** MCP handshake completed successfully */
MCP_HANDSHAKE_COMPLETE: 'mcp_handshake_complete',
/** Server is fully ready to handle requests */
SERVER_READY: 'server_ready',
} as const;
/**
* Type for checkpoint names
*/
export type StartupCheckpoint = typeof STARTUP_CHECKPOINTS[keyof typeof STARTUP_CHECKPOINTS];
/**
* Checkpoint data structure
*/
export interface CheckpointData {
name: StartupCheckpoint;
timestamp: number;
success: boolean;
error?: string;
}
/**
* Get all checkpoint names in order
*/
export function getAllCheckpoints(): StartupCheckpoint[] {
return Object.values(STARTUP_CHECKPOINTS);
}
/**
* Find which checkpoint failed based on the list of passed checkpoints
* Returns the first checkpoint that was not passed
*/
export function findFailedCheckpoint(passedCheckpoints: string[]): StartupCheckpoint {
const allCheckpoints = getAllCheckpoints();
for (const checkpoint of allCheckpoints) {
if (!passedCheckpoints.includes(checkpoint)) {
return checkpoint;
}
}
// If all checkpoints were passed, the failure must have occurred after SERVER_READY
// This would be an unexpected post-initialization failure
return STARTUP_CHECKPOINTS.SERVER_READY;
}
/**
* Validate if a string is a valid checkpoint
*/
export function isValidCheckpoint(checkpoint: string): checkpoint is StartupCheckpoint {
return getAllCheckpoints().includes(checkpoint as StartupCheckpoint);
}
/**
* Get human-readable description for a checkpoint
*/
export function getCheckpointDescription(checkpoint: StartupCheckpoint): string {
const descriptions: Record<StartupCheckpoint, string> = {
[STARTUP_CHECKPOINTS.PROCESS_STARTED]: 'Process initialization started',
[STARTUP_CHECKPOINTS.DATABASE_CONNECTING]: 'Connecting to database',
[STARTUP_CHECKPOINTS.DATABASE_CONNECTED]: 'Database connection established',
[STARTUP_CHECKPOINTS.N8N_API_CHECKING]: 'Checking n8n API configuration',
[STARTUP_CHECKPOINTS.N8N_API_READY]: 'n8n API ready',
[STARTUP_CHECKPOINTS.TELEMETRY_INITIALIZING]: 'Initializing telemetry system',
[STARTUP_CHECKPOINTS.TELEMETRY_READY]: 'Telemetry system ready',
[STARTUP_CHECKPOINTS.MCP_HANDSHAKE_STARTING]: 'Starting MCP protocol handshake',
[STARTUP_CHECKPOINTS.MCP_HANDSHAKE_COMPLETE]: 'MCP handshake completed',
[STARTUP_CHECKPOINTS.SERVER_READY]: 'Server fully initialized and ready',
};
return descriptions[checkpoint] || 'Unknown checkpoint';
}
/**
* Get the next expected checkpoint after the given one
* Returns null if this is the last checkpoint
*/
export function getNextCheckpoint(current: StartupCheckpoint): StartupCheckpoint | null {
const allCheckpoints = getAllCheckpoints();
const currentIndex = allCheckpoints.indexOf(current);
if (currentIndex === -1 || currentIndex === allCheckpoints.length - 1) {
return null;
}
return allCheckpoints[currentIndex + 1];
}
/**
* Calculate completion percentage based on checkpoints passed
*/
export function getCompletionPercentage(passedCheckpoints: string[]): number {
const totalCheckpoints = getAllCheckpoints().length;
const passedCount = passedCheckpoints.length;
return Math.round((passedCount / totalCheckpoints) * 100);
}

View File

@@ -3,8 +3,6 @@
* Centralized type definitions for the telemetry system
*/
import { StartupCheckpoint } from './startup-checkpoints';
export interface TelemetryEvent {
user_id: string;
event: string;
@@ -12,51 +10,6 @@ export interface TelemetryEvent {
created_at?: string;
}
/**
* Startup error event - captures pre-handshake failures
*/
export interface StartupErrorEvent extends TelemetryEvent {
event: 'startup_error';
properties: {
checkpoint: StartupCheckpoint;
errorMessage: string;
errorType: string;
checkpointsPassed: StartupCheckpoint[];
checkpointsPassedCount: number;
startupDuration: number;
platform: string;
arch: string;
nodeVersion: string;
isDocker: boolean;
};
}
/**
* Startup completed event - confirms server is functional
*/
export interface StartupCompletedEvent extends TelemetryEvent {
event: 'startup_completed';
properties: {
version: string;
};
}
/**
* Enhanced session start properties with startup tracking
*/
export interface SessionStartProperties {
version: string;
platform: string;
arch: string;
nodeVersion: string;
isDocker: boolean;
cloudPlatform: string | null;
// NEW: Startup tracking fields (v2.18.2)
startupDurationMs?: number;
checkpointsPassed?: StartupCheckpoint[];
startupErrorCount?: number;
}
export interface WorkflowTelemetry {
user_id: string;
workflow_hash: string;

View File

@@ -45,22 +45,19 @@ export class TemplateFetcher {
* Fetch all templates and filter to last 12 months
* This fetches ALL pages first, then applies date filter locally
*/
async fetchTemplates(progressCallback?: (current: number, total: number) => void, sinceDate?: Date): Promise<TemplateWorkflow[]> {
async fetchTemplates(progressCallback?: (current: number, total: number) => void): Promise<TemplateWorkflow[]> {
const allTemplates = await this.fetchAllTemplates(progressCallback);
// Use provided date or default to 12 months ago
const cutoffDate = sinceDate || (() => {
const oneYearAgo = new Date();
oneYearAgo.setMonth(oneYearAgo.getMonth() - 12);
return oneYearAgo;
})();
// Apply date filter locally after fetching all
const oneYearAgo = new Date();
oneYearAgo.setMonth(oneYearAgo.getMonth() - 12);
const recentTemplates = allTemplates.filter((w: TemplateWorkflow) => {
const createdDate = new Date(w.createdAt);
return createdDate >= cutoffDate;
return createdDate >= oneYearAgo;
});
logger.info(`Filtered to ${recentTemplates.length} templates since ${cutoffDate.toISOString().split('T')[0]} (out of ${allTemplates.length} total)`);
logger.info(`Filtered to ${recentTemplates.length} templates from last 12 months (out of ${allTemplates.length} total)`);
return recentTemplates;
}

View File

@@ -64,33 +64,54 @@ export class TemplateRepository {
} else {
// Create FTS5 virtual table
logger.info('Creating FTS5 virtual table for templates...');
/**
* @security SQL: Static CREATE TABLE statement with no user input.
* Template literal used for multi-line formatting only.
* See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-01)
*/
// eslint-disable-next-line no-restricted-syntax
this.db.exec(`
CREATE VIRTUAL TABLE IF NOT EXISTS templates_fts USING fts5(
name, description, content=templates
);
`);
// Create triggers to keep FTS5 in sync
/**
* @security SQL: Static CREATE TRIGGER statement with no user input.
* Template literal used for multi-line formatting only.
*/
// eslint-disable-next-line no-restricted-syntax
this.db.exec(`
CREATE TRIGGER IF NOT EXISTS templates_ai AFTER INSERT ON templates BEGIN
INSERT INTO templates_fts(rowid, name, description)
VALUES (new.id, new.name, new.description);
END;
`);
/**
* @security SQL: Static CREATE TRIGGER statement with no user input.
* Template literal used for multi-line formatting only.
*/
// eslint-disable-next-line no-restricted-syntax
this.db.exec(`
CREATE TRIGGER IF NOT EXISTS templates_au AFTER UPDATE ON templates BEGIN
UPDATE templates_fts SET name = new.name, description = new.description
WHERE rowid = new.id;
END;
`);
/**
* @security SQL: Static CREATE TRIGGER statement with no user input.
* Template literal used for multi-line formatting only.
*/
// eslint-disable-next-line no-restricted-syntax
this.db.exec(`
CREATE TRIGGER IF NOT EXISTS templates_ad AFTER DELETE ON templates BEGIN
DELETE FROM templates_fts WHERE rowid = old.id;
END;
`);
logger.info('FTS5 support enabled for template search');
}
} catch (error: any) {
@@ -442,19 +463,7 @@ export class TemplateRepository {
const rows = this.db.prepare('SELECT id FROM templates').all() as { id: number }[];
return new Set(rows.map(r => r.id));
}
/**
* Get the most recent template creation date
* Used in update mode to fetch only newer templates
*/
getMostRecentTemplateDate(): Date | null {
const result = this.db.prepare('SELECT MAX(created_at) as max_date FROM templates').get() as { max_date: string | null } | undefined;
if (!result || !result.max_date) {
return null;
}
return new Date(result.max_date);
}
/**
* Check if a template exists in the database
*/
@@ -536,8 +545,14 @@ export class TemplateRepository {
try {
// Clear existing FTS data
this.db.exec('DELETE FROM templates_fts');
// Repopulate from templates table
/**
* @security SQL: Static INSERT-SELECT statement with no user input.
* Template literal used for multi-line formatting only.
* See: https://github.com/czlonkowski/n8n-mcp/issues/265 (HIGH-01)
*/
// eslint-disable-next-line no-restricted-syntax
this.db.exec(`
INSERT INTO templates_fts(rowid, name, description)
SELECT id, name, description FROM templates

View File

@@ -319,38 +319,22 @@ export class TemplateService {
// Get existing template IDs if in update mode
let existingIds: Set<number> = new Set();
let sinceDate: Date | undefined;
if (mode === 'update') {
existingIds = this.repository.getExistingTemplateIds();
logger.info(`Update mode: Found ${existingIds.size} existing templates in database`);
// Get most recent template date and fetch only templates from last 2 weeks
const mostRecentDate = this.repository.getMostRecentTemplateDate();
if (mostRecentDate) {
// Fetch templates from 2 weeks before the most recent template
sinceDate = new Date(mostRecentDate);
sinceDate.setDate(sinceDate.getDate() - 14);
logger.info(`Update mode: Fetching templates since ${sinceDate.toISOString().split('T')[0]} (2 weeks before most recent)`);
} else {
// No templates yet, fetch from last 2 weeks
sinceDate = new Date();
sinceDate.setDate(sinceDate.getDate() - 14);
logger.info(`Update mode: No existing templates, fetching from last 2 weeks`);
}
} else {
// Clear existing templates in rebuild mode
this.repository.clearTemplates();
logger.info('Rebuild mode: Cleared existing templates');
}
// Fetch template list
logger.info(`Fetching template list from n8n.io (mode: ${mode})`);
const templates = await fetcher.fetchTemplates((current, total) => {
progressCallback?.('Fetching template list', current, total);
}, sinceDate);
});
logger.info(`Found ${templates.length} templates matching date criteria`);
logger.info(`Found ${templates.length} templates from last 12 months`);
// Filter to only new templates if in update mode
let templatesToFetch = templates;

View File

@@ -1,6 +1,3 @@
// Export n8n node type definitions and utilities
export * from './node-types';
export interface MCPServerConfig {
port: number;
host: string;

View File

@@ -1,220 +0,0 @@
/**
* TypeScript type definitions for n8n node parsing
*
* This file provides strong typing for node classes and instances,
* preventing bugs like the v2.17.4 baseDescription issue where
* TypeScript couldn't catch property name mistakes due to `any` types.
*
* @module types/node-types
* @since 2.17.5
*/
// Import n8n's official interfaces
import type {
IVersionedNodeType,
INodeType,
INodeTypeBaseDescription,
INodeTypeDescription
} from 'n8n-workflow';
/**
* Represents a node class that can be either:
* - A constructor function that returns INodeType
* - A constructor function that returns IVersionedNodeType
* - An already-instantiated node instance
*
* This covers all patterns we encounter when loading nodes from n8n packages.
*/
export type NodeClass =
| (new () => INodeType)
| (new () => IVersionedNodeType)
| INodeType
| IVersionedNodeType;
/**
* Instance of a versioned node type with all properties accessible.
*
* This represents nodes that use n8n's VersionedNodeType pattern,
* such as AI Agent, HTTP Request, Slack, etc.
*
* @property currentVersion - The computed current version (defaultVersion ?? max(nodeVersions))
* @property description - Base description stored as 'description' (NOT 'baseDescription')
* @property nodeVersions - Map of version numbers to INodeType implementations
*
* @example
* ```typescript
* const aiAgent = new AIAgentNode() as VersionedNodeInstance;
* console.log(aiAgent.currentVersion); // 2.2
* console.log(aiAgent.description.defaultVersion); // 2.2
* console.log(aiAgent.nodeVersions[1]); // INodeType for version 1
* ```
*/
export interface VersionedNodeInstance extends IVersionedNodeType {
currentVersion: number;
description: INodeTypeBaseDescription;
nodeVersions: {
[version: number]: INodeType;
};
}
/**
* Instance of a regular (non-versioned) node type.
*
* This represents simple nodes that don't use versioning,
* such as Edit Fields, Set, Code (v1), etc.
*/
export interface RegularNodeInstance extends INodeType {
description: INodeTypeDescription;
}
/**
* Union type for any node instance (versioned or regular).
*
* Use this when you need to handle both types of nodes.
*/
export type NodeInstance = VersionedNodeInstance | RegularNodeInstance;
/**
* Type guard to check if a node is a VersionedNodeType instance.
*
* This provides runtime type safety and enables TypeScript to narrow
* the type within conditional blocks.
*
* @param node - The node instance to check
* @returns True if node is a VersionedNodeInstance
*
* @example
* ```typescript
* const instance = new nodeClass();
* if (isVersionedNodeInstance(instance)) {
* // TypeScript knows instance is VersionedNodeInstance here
* console.log(instance.currentVersion);
* console.log(instance.nodeVersions);
* }
* ```
*/
export function isVersionedNodeInstance(node: any): node is VersionedNodeInstance {
return (
node !== null &&
typeof node === 'object' &&
'nodeVersions' in node &&
'currentVersion' in node &&
'description' in node &&
typeof node.currentVersion === 'number'
);
}
/**
* Type guard to check if a value is a VersionedNodeType class.
*
* This checks the constructor name pattern used by n8n's VersionedNodeType.
*
* @param nodeClass - The class or value to check
* @returns True if nodeClass is a VersionedNodeType constructor
*
* @example
* ```typescript
* if (isVersionedNodeClass(nodeClass)) {
* // It's a VersionedNodeType class
* const instance = new nodeClass() as VersionedNodeInstance;
* }
* ```
*/
export function isVersionedNodeClass(nodeClass: any): boolean {
return (
typeof nodeClass === 'function' &&
nodeClass.prototype?.constructor?.name === 'VersionedNodeType'
);
}
/**
* Safely instantiate a node class with proper error handling.
*
* Some nodes require specific parameters or environment setup to instantiate.
* This helper provides safe instantiation with fallback to null on error.
*
* @param nodeClass - The node class or instance to instantiate
* @returns The instantiated node or null if instantiation fails
*
* @example
* ```typescript
* const instance = instantiateNode(nodeClass);
* if (instance) {
* // Successfully instantiated
* const version = isVersionedNodeInstance(instance)
* ? instance.currentVersion
* : instance.description.version;
* }
* ```
*/
export function instantiateNode(nodeClass: NodeClass): NodeInstance | null {
try {
if (typeof nodeClass === 'function') {
return new nodeClass();
}
// Already an instance
return nodeClass;
} catch (e) {
// Some nodes require parameters to instantiate
return null;
}
}
/**
* Safely get a node instance, handling both classes and instances.
*
* This is a non-throwing version that returns undefined on failure.
*
* @param nodeClass - The node class or instance
* @returns The node instance or undefined
*/
export function getNodeInstance(nodeClass: NodeClass): NodeInstance | undefined {
const instance = instantiateNode(nodeClass);
return instance ?? undefined;
}
/**
* Extract description from a node class or instance.
*
* Handles both versioned and regular nodes, with fallback logic.
*
* @param nodeClass - The node class or instance
* @returns The node description or empty object on failure
*/
export function getNodeDescription(
nodeClass: NodeClass
): INodeTypeBaseDescription | INodeTypeDescription {
// Try to get description from instance first
try {
const instance = instantiateNode(nodeClass);
if (instance) {
// For VersionedNodeType, description is the baseDescription
if (isVersionedNodeInstance(instance)) {
return instance.description;
}
// For regular nodes, description is the full INodeTypeDescription
return instance.description;
}
} catch (e) {
// Ignore instantiation errors
}
// Fallback to static properties
if (typeof nodeClass === 'object' && 'description' in nodeClass) {
return nodeClass.description;
}
// Last resort: empty description
return {
displayName: '',
name: '',
group: [],
description: '',
version: 1,
defaults: { name: '', color: '' },
inputs: [],
outputs: [],
properties: []
} as any; // Type assertion needed for fallback case
}

View File

@@ -1,7 +1,7 @@
import { promises as fs } from 'fs';
import path from 'path';
import { logger } from './logger';
import { spawnSync } from 'child_process';
import { execSync } from 'child_process';
// Enhanced documentation structure with rich content
export interface EnhancedNodeDocumentation {
@@ -61,136 +61,36 @@ export interface DocumentationMetadata {
export class EnhancedDocumentationFetcher {
private docsPath: string;
private readonly docsRepoUrl = 'https://github.com/n8n-io/n8n-docs.git';
private docsRepoUrl = 'https://github.com/n8n-io/n8n-docs.git';
private cloned = false;
constructor(docsPath?: string) {
// SECURITY: Validate and sanitize docsPath to prevent command injection
// See: https://github.com/czlonkowski/n8n-mcp/issues/265 (CRITICAL-01 Part 2)
const defaultPath = path.join(__dirname, '../../temp', 'n8n-docs');
if (!docsPath) {
this.docsPath = defaultPath;
} else {
// SECURITY: Block directory traversal and malicious paths
const sanitized = this.sanitizePath(docsPath);
if (!sanitized) {
logger.error('Invalid docsPath rejected in constructor', { docsPath });
throw new Error('Invalid docsPath: path contains disallowed characters or patterns');
}
// SECURITY: Verify path is absolute and within allowed boundaries
const absolutePath = path.resolve(sanitized);
// Block paths that could escape to sensitive directories
if (absolutePath.startsWith('/etc') ||
absolutePath.startsWith('/sys') ||
absolutePath.startsWith('/proc') ||
absolutePath.startsWith('/var/log')) {
logger.error('docsPath points to system directory - blocked', { docsPath, absolutePath });
throw new Error('Invalid docsPath: cannot use system directories');
}
this.docsPath = absolutePath;
logger.info('docsPath validated and set', { docsPath: this.docsPath });
}
// SECURITY: Validate repository URL is HTTPS
if (!this.docsRepoUrl.startsWith('https://')) {
logger.error('docsRepoUrl must use HTTPS protocol', { url: this.docsRepoUrl });
throw new Error('Invalid repository URL: must use HTTPS protocol');
}
}
/**
* Sanitize path input to prevent command injection and directory traversal
* SECURITY: Part of fix for command injection vulnerability
*/
private sanitizePath(inputPath: string): string | null {
// SECURITY: Reject paths containing any shell metacharacters or control characters
// This prevents command injection even before attempting to sanitize
const dangerousChars = /[;&|`$(){}[\]<>'"\\#\n\r\t]/;
if (dangerousChars.test(inputPath)) {
logger.warn('Path contains shell metacharacters - rejected', { path: inputPath });
return null;
}
// Block directory traversal attempts
if (inputPath.includes('..') || inputPath.startsWith('.')) {
logger.warn('Path traversal attempt blocked', { path: inputPath });
return null;
}
return inputPath;
this.docsPath = docsPath || path.join(__dirname, '../../temp', 'n8n-docs');
}
/**
* Clone or update the n8n-docs repository
* SECURITY: Uses spawnSync with argument arrays to prevent command injection
* See: https://github.com/czlonkowski/n8n-mcp/issues/265 (CRITICAL-01 Part 2)
*/
async ensureDocsRepository(): Promise<void> {
try {
const exists = await fs.access(this.docsPath).then(() => true).catch(() => false);
if (!exists) {
logger.info('Cloning n8n-docs repository...', {
url: this.docsRepoUrl,
path: this.docsPath
});
logger.info('Cloning n8n-docs repository...');
await fs.mkdir(path.dirname(this.docsPath), { recursive: true });
// SECURITY: Use spawnSync with argument array instead of string interpolation
// This prevents command injection even if docsPath or docsRepoUrl are compromised
const cloneResult = spawnSync('git', [
'clone',
'--depth', '1',
this.docsRepoUrl,
this.docsPath
], {
stdio: 'pipe',
encoding: 'utf-8'
execSync(`git clone --depth 1 ${this.docsRepoUrl} ${this.docsPath}`, {
stdio: 'pipe'
});
if (cloneResult.status !== 0) {
const error = cloneResult.stderr || cloneResult.error?.message || 'Unknown error';
logger.error('Git clone failed', {
status: cloneResult.status,
stderr: error,
url: this.docsRepoUrl,
path: this.docsPath
});
throw new Error(`Git clone failed: ${error}`);
}
logger.info('n8n-docs repository cloned successfully');
} else {
logger.info('Updating n8n-docs repository...', { path: this.docsPath });
// SECURITY: Use spawnSync with argument array and cwd option
const pullResult = spawnSync('git', [
'pull',
'--ff-only'
], {
logger.info('Updating n8n-docs repository...');
execSync('git pull --ff-only', {
cwd: this.docsPath,
stdio: 'pipe',
encoding: 'utf-8'
stdio: 'pipe'
});
if (pullResult.status !== 0) {
const error = pullResult.stderr || pullResult.error?.message || 'Unknown error';
logger.error('Git pull failed', {
status: pullResult.status,
stderr: error,
cwd: this.docsPath
});
throw new Error(`Git pull failed: ${error}`);
}
logger.info('n8n-docs repository updated');
}
this.cloned = true;
} catch (error) {
logger.error('Failed to clone/update n8n-docs repository:', error);

View File

@@ -1,109 +0,0 @@
/**
* Utility functions for detecting and handling n8n expressions
*/
/**
* Detects if a value is an n8n expression
*
* n8n expressions can be:
* - Pure expression: `={{ $json.value }}`
* - Mixed content: `=https://api.com/{{ $json.id }}/data`
* - Prefix-only: `=$json.value`
*
* @param value - The value to check
* @returns true if the value is an expression (starts with =)
*/
export function isExpression(value: unknown): value is string {
return typeof value === 'string' && value.startsWith('=');
}
/**
* Detects if a string contains n8n expression syntax {{ }}
*
* This checks for expression markers within the string,
* regardless of whether it has the = prefix.
*
* @param value - The value to check
* @returns true if the value contains {{ }} markers
*/
export function containsExpression(value: unknown): boolean {
if (typeof value !== 'string') {
return false;
}
// Use single regex for better performance than two includes()
return /\{\{.*\}\}/s.test(value);
}
/**
* Detects if a value should skip literal validation
*
* This is the main utility to use before validating values like URLs, JSON, etc.
* It returns true if:
* - The value is an expression (starts with =)
* - OR the value contains expression markers {{ }}
*
* @param value - The value to check
* @returns true if validation should be skipped
*/
export function shouldSkipLiteralValidation(value: unknown): boolean {
return isExpression(value) || containsExpression(value);
}
/**
* Extracts the expression content from a value
*
* If value is `={{ $json.value }}`, returns `$json.value`
* If value is `=$json.value`, returns `$json.value`
* If value is not an expression, returns the original value
*
* @param value - The value to extract from
* @returns The expression content or original value
*/
export function extractExpressionContent(value: string): string {
if (!isExpression(value)) {
return value;
}
const withoutPrefix = value.substring(1); // Remove =
// Check if it's wrapped in {{ }}
const match = withoutPrefix.match(/^\{\{(.+)\}\}$/s);
if (match) {
return match[1].trim();
}
return withoutPrefix;
}
/**
* Checks if a value is a mixed content expression
*
* Mixed content has both literal text and expressions:
* - `Hello {{ $json.name }}!`
* - `https://api.com/{{ $json.id }}/data`
*
* @param value - The value to check
* @returns true if the value has mixed content
*/
export function hasMixedContent(value: unknown): boolean {
// Type guard first to avoid calling containsExpression on non-strings
if (typeof value !== 'string') {
return false;
}
if (!containsExpression(value)) {
return false;
}
// If it's wrapped entirely in {{ }}, it's not mixed
const trimmed = value.trim();
if (trimmed.startsWith('={{') && trimmed.endsWith('}}')) {
// Check if there's only one pair of {{ }}
const count = (trimmed.match(/\{\{/g) || []).length;
if (count === 1) {
return false;
}
}
return true;
}

View File

@@ -1,121 +0,0 @@
/**
* Node Classification Utilities
*
* Provides shared classification logic for workflow nodes.
* Used by validators to consistently identify node types across the codebase.
*
* This module centralizes node type classification to ensure consistent behavior
* between WorkflowValidator and n8n-validation.ts, preventing bugs like sticky
* notes being incorrectly flagged as disconnected nodes.
*/
/**
* Check if a node type is a sticky note (documentation-only node)
*
* Sticky notes are UI-only annotation nodes that:
* - Do not participate in workflow execution
* - Never have connections (by design)
* - Should be excluded from connection validation
* - Serve purely as visual documentation in the workflow canvas
*
* Example sticky note types:
* - 'n8n-nodes-base.stickyNote' (standard format)
* - 'nodes-base.stickyNote' (normalized format)
* - '@n8n/n8n-nodes-base.stickyNote' (scoped format)
*
* @param nodeType - The node type to check (e.g., 'n8n-nodes-base.stickyNote')
* @returns true if the node is a sticky note, false otherwise
*/
export function isStickyNote(nodeType: string): boolean {
const stickyNoteTypes = [
'n8n-nodes-base.stickyNote',
'nodes-base.stickyNote',
'@n8n/n8n-nodes-base.stickyNote'
];
return stickyNoteTypes.includes(nodeType);
}
/**
* Check if a node type is a trigger node
*
* Trigger nodes:
* - Start workflow execution
* - Only need outgoing connections (no incoming connections required)
* - Include webhooks, manual triggers, schedule triggers, etc.
* - Are the entry points for workflow execution
*
* Examples:
* - Webhooks: Listen for HTTP requests
* - Manual triggers: Started manually by user
* - Schedule/Cron triggers: Run on a schedule
*
* @param nodeType - The node type to check
* @returns true if the node is a trigger, false otherwise
*/
export function isTriggerNode(nodeType: string): boolean {
const triggerTypes = [
'n8n-nodes-base.webhook',
'n8n-nodes-base.webhookTrigger',
'n8n-nodes-base.manualTrigger',
'n8n-nodes-base.cronTrigger',
'n8n-nodes-base.scheduleTrigger'
];
return triggerTypes.includes(nodeType);
}
/**
* Check if a node type is non-executable (UI-only)
*
* Non-executable nodes:
* - Do not participate in workflow execution
* - Serve documentation/annotation purposes only
* - Should be excluded from all execution-related validation
* - Should be excluded from statistics like "total executable nodes"
* - Should be excluded from connection validation
*
* Currently includes: sticky notes
*
* Future: May include other annotation/comment nodes if n8n adds them
*
* @param nodeType - The node type to check
* @returns true if the node is non-executable, false otherwise
*/
export function isNonExecutableNode(nodeType: string): boolean {
return isStickyNote(nodeType);
// Future: Add other non-executable node types here
// Example: || isCommentNode(nodeType) || isAnnotationNode(nodeType)
}
/**
* Check if a node type requires incoming connections
*
* Most nodes require at least one incoming connection to receive data,
* but there are two categories of exceptions:
*
* 1. Trigger nodes: Only need outgoing connections
* - They start workflow execution
* - They generate their own data
* - Examples: webhook, manualTrigger, scheduleTrigger
*
* 2. Non-executable nodes: Don't need any connections
* - They are UI-only annotations
* - They don't participate in execution
* - Examples: stickyNote
*
* @param nodeType - The node type to check
* @returns true if the node requires incoming connections, false otherwise
*/
export function requiresIncomingConnection(nodeType: string): boolean {
// Non-executable nodes don't need any connections
if (isNonExecutableNode(nodeType)) {
return false;
}
// Trigger nodes only need outgoing connections
if (isTriggerNode(nodeType)) {
return false;
}
// Regular nodes need incoming connections
return true;
}

View File

@@ -1,208 +0,0 @@
/**
* NPM Version Checker Utility
*
* Checks if the current n8n-mcp version is outdated by comparing
* against the latest version published on npm.
*/
import { logger } from './logger';
/**
* NPM Registry Response structure
* Based on npm registry JSON format for package metadata
*/
interface NpmRegistryResponse {
version: string;
[key: string]: unknown;
}
export interface VersionCheckResult {
currentVersion: string;
latestVersion: string | null;
isOutdated: boolean;
updateAvailable: boolean;
error: string | null;
checkedAt: Date;
updateCommand?: string;
}
// Cache for version check to avoid excessive npm requests
let versionCheckCache: VersionCheckResult | null = null;
let lastCheckTime: number = 0;
const CACHE_TTL_MS = 1 * 60 * 60 * 1000; // 1 hour cache
/**
* Check if current version is outdated compared to npm registry
* Uses caching to avoid excessive npm API calls
*
* @param forceRefresh - Force a fresh check, bypassing cache
* @returns Version check result
*/
export async function checkNpmVersion(forceRefresh: boolean = false): Promise<VersionCheckResult> {
const now = Date.now();
// Return cached result if available and not expired
if (!forceRefresh && versionCheckCache && (now - lastCheckTime) < CACHE_TTL_MS) {
logger.debug('Returning cached npm version check result');
return versionCheckCache;
}
// Get current version from package.json
const packageJson = require('../../package.json');
const currentVersion = packageJson.version;
try {
// Fetch latest version from npm registry
const response = await fetch('https://registry.npmjs.org/n8n-mcp/latest', {
headers: {
'Accept': 'application/json',
},
signal: AbortSignal.timeout(5000) // 5 second timeout
});
if (!response.ok) {
logger.warn('Failed to fetch npm version info', {
status: response.status,
statusText: response.statusText
});
const result: VersionCheckResult = {
currentVersion,
latestVersion: null,
isOutdated: false,
updateAvailable: false,
error: `npm registry returned ${response.status}`,
checkedAt: new Date()
};
versionCheckCache = result;
lastCheckTime = now;
return result;
}
// Parse and validate JSON response
let data: unknown;
try {
data = await response.json();
} catch (error) {
throw new Error('Failed to parse npm registry response as JSON');
}
// Validate response structure
if (!data || typeof data !== 'object' || !('version' in data)) {
throw new Error('Invalid response format from npm registry');
}
const registryData = data as NpmRegistryResponse;
const latestVersion = registryData.version;
// Validate version format (semver: x.y.z or x.y.z-prerelease)
if (!latestVersion || !/^\d+\.\d+\.\d+/.test(latestVersion)) {
throw new Error(`Invalid version format from npm registry: ${latestVersion}`);
}
// Compare versions
const isOutdated = compareVersions(currentVersion, latestVersion) < 0;
const result: VersionCheckResult = {
currentVersion,
latestVersion,
isOutdated,
updateAvailable: isOutdated,
error: null,
checkedAt: new Date(),
updateCommand: isOutdated ? `npm install -g n8n-mcp@${latestVersion}` : undefined
};
// Cache the result
versionCheckCache = result;
lastCheckTime = now;
logger.debug('npm version check completed', {
current: currentVersion,
latest: latestVersion,
outdated: isOutdated
});
return result;
} catch (error) {
logger.warn('Error checking npm version', {
error: error instanceof Error ? error.message : String(error)
});
const result: VersionCheckResult = {
currentVersion,
latestVersion: null,
isOutdated: false,
updateAvailable: false,
error: error instanceof Error ? error.message : 'Unknown error',
checkedAt: new Date()
};
// Cache error result to avoid rapid retry
versionCheckCache = result;
lastCheckTime = now;
return result;
}
}
/**
* Compare two semantic version strings
* Returns: -1 if v1 < v2, 0 if v1 === v2, 1 if v1 > v2
*
* @param v1 - First version (e.g., "1.2.3")
* @param v2 - Second version (e.g., "1.3.0")
* @returns Comparison result
*/
export function compareVersions(v1: string, v2: string): number {
// Remove 'v' prefix if present
const clean1 = v1.replace(/^v/, '');
const clean2 = v2.replace(/^v/, '');
// Split into parts and convert to numbers
const parts1 = clean1.split('.').map(n => parseInt(n, 10) || 0);
const parts2 = clean2.split('.').map(n => parseInt(n, 10) || 0);
// Compare each part
for (let i = 0; i < Math.max(parts1.length, parts2.length); i++) {
const p1 = parts1[i] || 0;
const p2 = parts2[i] || 0;
if (p1 < p2) return -1;
if (p1 > p2) return 1;
}
return 0; // Versions are equal
}
/**
* Clear the version check cache (useful for testing)
*/
export function clearVersionCheckCache(): void {
versionCheckCache = null;
lastCheckTime = 0;
}
/**
* Format version check result as a user-friendly message
*
* @param result - Version check result
* @returns Formatted message
*/
export function formatVersionMessage(result: VersionCheckResult): string {
if (result.error) {
return `Version check failed: ${result.error}. Current version: ${result.currentVersion}`;
}
if (!result.latestVersion) {
return `Current version: ${result.currentVersion} (latest version unknown)`;
}
if (result.isOutdated) {
return `⚠️ Update available! Current: ${result.currentVersion} → Latest: ${result.latestVersion}`;
}
return `✓ You're up to date! Current version: ${result.currentVersion}`;
}

View File

@@ -4,17 +4,6 @@ import { SQLiteStorageService } from '../../src/services/sqlite-storage-service'
import { NodeFactory } from '../factories/node-factory';
import { PropertyDefinitionFactory } from '../factories/property-definition-factory';
/**
* Database Query Performance Benchmarks
*
* NOTE: These benchmarks use MOCK DATA (500 artificial test nodes)
* created with factories, not the real production database.
*
* This is useful for tracking database layer performance in isolation,
* but may not reflect real-world performance characteristics.
*
* For end-to-end MCP tool performance with real data, see mcp-tools.bench.ts
*/
describe('Database Query Performance', () => {
let repository: NodeRepository;
let storage: SQLiteStorageService;

View File

@@ -1,3 +1,7 @@
// Export all benchmark suites
// Note: Some benchmarks are temporarily disabled due to API changes
// export * from './node-loading.bench';
export * from './database-queries.bench';
export * from './mcp-tools.bench';
// export * from './search-operations.bench';
// export * from './validation-performance.bench';
// export * from './mcp-tools.bench';

View File

@@ -1,169 +0,0 @@
import { bench, describe } from 'vitest';
import { NodeRepository } from '../../src/database/node-repository';
import { createDatabaseAdapter } from '../../src/database/database-adapter';
import { EnhancedConfigValidator } from '../../src/services/enhanced-config-validator';
import { PropertyFilter } from '../../src/services/property-filter';
import path from 'path';
/**
* MCP Tool Performance Benchmarks
*
* These benchmarks measure end-to-end performance of actual MCP tool operations
* using the REAL production database (data/nodes.db with 525+ nodes).
*
* Unlike database-queries.bench.ts which uses mock data, these benchmarks
* reflect what AI assistants actually experience when calling MCP tools,
* making this the most meaningful performance metric for the system.
*/
describe('MCP Tool Performance (Production Database)', () => {
let repository: NodeRepository;
beforeAll(async () => {
// Use REAL production database
const dbPath = path.join(__dirname, '../../data/nodes.db');
const db = await createDatabaseAdapter(dbPath);
repository = new NodeRepository(db);
// Initialize similarity services for validation
EnhancedConfigValidator.initializeSimilarityServices(repository);
});
/**
* search_nodes - Most frequently used tool for node discovery
*
* This measures:
* - Database FTS5 full-text search
* - Result filtering and ranking
* - Response serialization
*
* Target: <20ms for common queries
*/
bench('search_nodes - common query (http)', async () => {
await repository.searchNodes('http', 'OR', 20);
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
bench('search_nodes - AI agent query (slack message)', async () => {
await repository.searchNodes('slack send message', 'AND', 10);
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
/**
* get_node_essentials - Fast retrieval of node configuration
*
* This measures:
* - Database node lookup
* - Property filtering (essentials only)
* - Response formatting
*
* Target: <10ms for most nodes
*/
bench('get_node_essentials - HTTP Request node', async () => {
const node = await repository.getNodeByType('n8n-nodes-base.httpRequest');
if (node && node.properties) {
PropertyFilter.getEssentials(node.properties, node.nodeType);
}
}, {
iterations: 200,
warmupIterations: 20,
warmupTime: 500,
time: 3000
});
bench('get_node_essentials - Slack node', async () => {
const node = await repository.getNodeByType('n8n-nodes-base.slack');
if (node && node.properties) {
PropertyFilter.getEssentials(node.properties, node.nodeType);
}
}, {
iterations: 200,
warmupIterations: 20,
warmupTime: 500,
time: 3000
});
/**
* list_nodes - Initial exploration/listing
*
* This measures:
* - Database query with pagination
* - Result serialization
* - Category filtering
*
* Target: <15ms for first page
*/
bench('list_nodes - first 50 nodes', async () => {
await repository.getAllNodes(50);
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
bench('list_nodes - AI tools only', async () => {
await repository.getAIToolNodes();
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
/**
* validate_node_operation - Configuration validation
*
* This measures:
* - Schema lookup
* - Validation logic execution
* - Error message formatting
*
* Target: <15ms for simple validations
*/
bench('validate_node_operation - HTTP Request (minimal)', async () => {
const node = await repository.getNodeByType('n8n-nodes-base.httpRequest');
if (node && node.properties) {
EnhancedConfigValidator.validateWithMode(
'n8n-nodes-base.httpRequest',
{},
node.properties,
'operation',
'ai-friendly'
);
}
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
bench('validate_node_operation - HTTP Request (with params)', async () => {
const node = await repository.getNodeByType('n8n-nodes-base.httpRequest');
if (node && node.properties) {
EnhancedConfigValidator.validateWithMode(
'n8n-nodes-base.httpRequest',
{
requestMethod: 'GET',
url: 'https://api.example.com',
authentication: 'none'
},
node.properties,
'operation',
'ai-friendly'
);
}
}, {
iterations: 100,
warmupIterations: 10,
warmupTime: 500,
time: 3000
});
});

View File

@@ -0,0 +1,47 @@
import { bench, describe } from 'vitest';
/**
* Sample benchmark to verify the setup works correctly
*/
describe('Sample Benchmarks', () => {
bench('array sorting - small', () => {
const arr = Array.from({ length: 100 }, () => Math.random());
arr.sort((a, b) => a - b);
}, {
iterations: 1000,
warmupIterations: 100
});
bench('array sorting - large', () => {
const arr = Array.from({ length: 10000 }, () => Math.random());
arr.sort((a, b) => a - b);
}, {
iterations: 100,
warmupIterations: 10
});
bench('string concatenation', () => {
let str = '';
for (let i = 0; i < 1000; i++) {
str += 'a';
}
}, {
iterations: 1000,
warmupIterations: 100
});
bench('object creation', () => {
const objects = [];
for (let i = 0; i < 1000; i++) {
objects.push({
id: i,
name: `Object ${i}`,
value: Math.random(),
timestamp: Date.now()
});
}
}, {
iterations: 1000,
warmupIterations: 100
});
});

View File

@@ -1,277 +0,0 @@
# AI Validation Integration Tests
Comprehensive integration tests for AI workflow validation introduced in v2.17.0.
## Overview
These tests validate ALL AI validation operations against a REAL n8n instance. They verify:
- AI Agent validation rules
- Chat Trigger validation constraints
- Basic LLM Chain validation requirements
- AI Tool sub-node validation (HTTP Request, Code, Vector Store, Workflow, Calculator)
- End-to-end workflow validation
- Multi-error detection
- Node type normalization (bug fix validation)
## Test Files
### 1. `helpers.ts`
Utility functions for creating AI workflow components:
- `createAIAgentNode()` - AI Agent with configurable options
- `createChatTriggerNode()` - Chat Trigger with streaming modes
- `createBasicLLMChainNode()` - Basic LLM Chain
- `createLanguageModelNode()` - OpenAI/Anthropic models
- `createHTTPRequestToolNode()` - HTTP Request Tool
- `createCodeToolNode()` - Code Tool
- `createVectorStoreToolNode()` - Vector Store Tool
- `createWorkflowToolNode()` - Workflow Tool
- `createCalculatorToolNode()` - Calculator Tool
- `createMemoryNode()` - Buffer Window Memory
- `createRespondNode()` - Respond to Webhook
- `createAIConnection()` - AI connection helper (reversed for langchain)
- `createMainConnection()` - Standard n8n connection
- `mergeConnections()` - Merge multiple connection objects
- `createAIWorkflow()` - Complete workflow builder
### 2. `ai-agent-validation.test.ts` (7 tests)
Tests AI Agent validation:
- ✅ Detects missing language model (MISSING_LANGUAGE_MODEL error)
- ✅ Validates AI Agent with language model connected
- ✅ Detects tool connections correctly (no false warnings)
- ✅ Validates streaming mode constraints (Chat Trigger)
- ✅ Validates AI Agent own streamResponse setting
- ✅ Detects multiple memory connections (error)
- ✅ Validates complete AI workflow (all components)
### 3. `chat-trigger-validation.test.ts` (5 tests)
Tests Chat Trigger validation:
- ✅ Detects streaming to non-AI-Agent (STREAMING_WRONG_TARGET error)
- ✅ Detects missing connections (MISSING_CONNECTIONS error)
- ✅ Validates valid streaming setup
- ✅ Validates lastNode mode with AI Agent
- ✅ Detects streaming agent with output connection
### 4. `llm-chain-validation.test.ts` (6 tests)
Tests Basic LLM Chain validation:
- ✅ Detects missing language model (MISSING_LANGUAGE_MODEL error)
- ✅ Detects missing prompt text (MISSING_PROMPT_TEXT error)
- ✅ Validates complete LLM Chain
- ✅ Validates LLM Chain with memory
- ✅ Detects multiple language models (error - no fallback support)
- ✅ Detects tools connection (TOOLS_NOT_SUPPORTED error)
### 5. `ai-tool-validation.test.ts` (9 tests)
Tests AI Tool validation:
**HTTP Request Tool:**
- ✅ Detects missing toolDescription (MISSING_TOOL_DESCRIPTION)
- ✅ Detects missing URL (MISSING_URL)
- ✅ Validates valid HTTP Request Tool
**Code Tool:**
- ✅ Detects missing code (MISSING_CODE)
- ✅ Validates valid Code Tool
**Vector Store Tool:**
- ✅ Detects missing toolDescription
- ✅ Validates valid Vector Store Tool
**Workflow Tool:**
- ✅ Detects missing workflowId (MISSING_WORKFLOW_ID)
- ✅ Validates valid Workflow Tool
**Calculator Tool:**
- ✅ Validates Calculator Tool (no configuration needed)
### 6. `e2e-validation.test.ts` (5 tests)
End-to-end validation tests:
- ✅ Validates and creates complex AI workflow (7 nodes, all components)
- ✅ Detects multiple validation errors (5+ errors in one workflow)
- ✅ Validates streaming workflow without main output
- ✅ Validates non-streaming workflow with main output
- ✅ Tests node type normalization (v2.17.0 bug fix validation)
## Running Tests
### Run All AI Validation Tests
```bash
npm test -- tests/integration/ai-validation --run
```
### Run Specific Test Suite
```bash
npm test -- tests/integration/ai-validation/ai-agent-validation.test.ts --run
npm test -- tests/integration/ai-validation/chat-trigger-validation.test.ts --run
npm test -- tests/integration/ai-validation/llm-chain-validation.test.ts --run
npm test -- tests/integration/ai-validation/ai-tool-validation.test.ts --run
npm test -- tests/integration/ai-validation/e2e-validation.test.ts --run
```
### Prerequisites
1. **n8n Instance**: Real n8n instance required (not mocked)
2. **Environment Variables**:
```env
N8N_API_URL=http://localhost:5678
N8N_API_KEY=your-api-key
TEST_CLEANUP=true # Auto-cleanup test workflows (default: true)
```
3. **Build**: Run `npm run build` before testing
## Test Infrastructure
### Cleanup
- All tests use `TestContext` for automatic workflow cleanup
- Workflows are tagged with `mcp-integration-test` and `ai-validation`
- Cleanup runs in `afterEach` hooks
- Orphaned workflow cleanup runs in `afterAll` (non-CI only)
### Workflow Naming
- All test workflows use timestamps: `[MCP-TEST] Description 1696723200000`
- Prevents name collisions
- Easy identification in n8n UI
### Connection Patterns
- **Main connections**: Standard n8n flow (A → B)
- **AI connections**: Reversed flow (Language Model → AI Agent)
- Uses helper functions to ensure correct connection structure
## Key Validation Checks
### AI Agent
- Language model connections (1 or 2 for fallback)
- Output parser configuration
- Prompt type validation (auto vs define)
- System message recommendations
- Streaming mode constraints (CRITICAL)
- Memory connections (0-1 max)
- Tool connections
- maxIterations validation
### Chat Trigger
- responseMode validation (streaming vs lastNode)
- Streaming requires AI Agent target
- AI Agent in streaming mode: NO main output allowed
### Basic LLM Chain
- Exactly 1 language model (no fallback)
- Memory connections (0-1 max)
- No tools support (error if connected)
- Prompt configuration validation
### AI Tools
- HTTP Request Tool: requires toolDescription + URL
- Code Tool: requires jsCode
- Vector Store Tool: requires toolDescription + vector store connection
- Workflow Tool: requires workflowId
- Calculator Tool: no configuration required
## Validation Error Codes
Tests verify these error codes are correctly detected:
- `MISSING_LANGUAGE_MODEL` - No language model connected
- `MISSING_TOOL_DESCRIPTION` - Tool missing description
- `MISSING_URL` - HTTP tool missing URL
- `MISSING_CODE` - Code tool missing code
- `MISSING_WORKFLOW_ID` - Workflow tool missing ID
- `MISSING_PROMPT_TEXT` - Prompt type=define but no text
- `MISSING_CONNECTIONS` - Chat Trigger has no output
- `STREAMING_WITH_MAIN_OUTPUT` - AI Agent in streaming mode with main output
- `STREAMING_WRONG_TARGET` - Chat Trigger streaming to non-AI-Agent
- `STREAMING_AGENT_HAS_OUTPUT` - Streaming agent has output connection
- `MULTIPLE_LANGUAGE_MODELS` - LLM Chain with multiple models
- `MULTIPLE_MEMORY_CONNECTIONS` - Multiple memory connected
- `TOOLS_NOT_SUPPORTED` - Basic LLM Chain with tools
- `TOO_MANY_LANGUAGE_MODELS` - AI Agent with 3+ models
- `FALLBACK_MISSING_SECOND_MODEL` - needsFallback=true but 1 model
- `MULTIPLE_OUTPUT_PARSERS` - Multiple output parsers
## Bug Fix Validation
### v2.17.0 Node Type Normalization
Test 5 in `e2e-validation.test.ts` validates the fix for node type normalization:
- Creates AI Agent + OpenAI Model + HTTP Request Tool
- Connects tool via ai_tool connection
- Verifies NO false "no tools connected" warning
- Validates workflow is valid
This test would have caught the bug where:
```typescript
// BUG: Incorrect comparison
sourceNode.type === 'nodes-langchain.chatTrigger' // ❌ Never matches
// FIX: Use normalizer
NodeTypeNormalizer.normalizeToFullForm(sourceNode.type) === 'nodes-langchain.chatTrigger' // ✅ Works
```
## Success Criteria
All tests should:
- ✅ Create workflows in real n8n
- ✅ Validate using actual MCP tools (handleValidateWorkflow)
- ✅ Verify validation results match expected outcomes
- ✅ Clean up after themselves (no orphaned workflows)
- ✅ Run in under 30 seconds each
- ✅ Be deterministic (no flakiness)
## Test Coverage
Total: **32 tests** covering:
- **7 AI Agent tests** - Complete AI Agent validation logic
- **5 Chat Trigger tests** - Streaming mode and connection validation
- **6 Basic LLM Chain tests** - LLM Chain constraints and requirements
- **9 AI Tool tests** - All AI tool sub-node types
- **5 E2E tests** - Complex workflows and multi-error detection
## Coverage Summary
### Validation Features Tested
- ✅ Language model connections (required, fallback)
- ✅ Output parser configuration
- ✅ Prompt type validation
- ✅ System message checks
- ✅ Streaming mode constraints
- ✅ Memory connections (single)
- ✅ Tool connections
- ✅ maxIterations validation
- ✅ Chat Trigger modes (streaming, lastNode)
- ✅ Tool description requirements
- ✅ Tool-specific parameters (URL, code, workflowId)
- ✅ Multi-error detection
- ✅ Node type normalization
- ✅ Connection validation (missing, invalid)
### Edge Cases Tested
- ✅ Empty/missing required fields
- ✅ Invalid configurations
- ✅ Multiple connections (when not allowed)
- ✅ Streaming with main output (forbidden)
- ✅ Tool connections to non-agent nodes
- ✅ Fallback model configuration
- ✅ Complex workflows with all components
## Recommendations
### Additional Tests (Future)
1. **Performance tests** - Validate large AI workflows (20+ nodes)
2. **Credential validation** - Test with invalid/missing credentials
3. **Expression validation** - Test n8n expressions in AI node parameters
4. **Cross-version tests** - Test different node typeVersions
5. **Concurrent validation** - Test multiple workflows in parallel
### Test Maintenance
- Update tests when new AI nodes are added
- Add tests for new validation rules
- Keep helpers.ts updated with new node types
- Verify error codes match specification
## Notes
- Tests create real workflows in n8n (not mocked)
- Each test is independent (no shared state)
- Workflows are automatically cleaned up
- Tests use actual MCP validation handlers
- All AI connection types are tested
- Streaming mode validation is comprehensive
- Node type normalization is validated

View File

@@ -1,336 +0,0 @@
# AI Validation Integration Tests - Test Report
**Date**: 2025-10-07
**Version**: v2.17.0
**Purpose**: Comprehensive integration testing for AI validation operations
## Executive Summary
Created **32 comprehensive integration tests** across **5 test suites** that validate ALL AI validation operations introduced in v2.17.0. These tests run against a REAL n8n instance and verify end-to-end functionality.
## Test Suite Structure
### Files Created
1. **helpers.ts** (19 utility functions)
- AI workflow component builders
- Connection helpers
- Workflow creation utilities
2. **ai-agent-validation.test.ts** (7 tests)
- AI Agent validation rules
- Language model connections
- Tool detection
- Streaming mode constraints
- Memory connections
- Complete workflow validation
3. **chat-trigger-validation.test.ts** (5 tests)
- Streaming mode validation
- Target node validation
- Connection requirements
- lastNode vs streaming modes
4. **llm-chain-validation.test.ts** (6 tests)
- Basic LLM Chain requirements
- Language model connections
- Prompt validation
- Tools not supported
- Memory support
5. **ai-tool-validation.test.ts** (9 tests)
- HTTP Request Tool validation
- Code Tool validation
- Vector Store Tool validation
- Workflow Tool validation
- Calculator Tool validation
6. **e2e-validation.test.ts** (5 tests)
- Complex workflow validation
- Multi-error detection
- Streaming workflows
- Non-streaming workflows
- Node type normalization fix validation
7. **README.md** - Complete test documentation
8. **TEST_REPORT.md** - This report
## Test Coverage
### Validation Features Tested ✅
#### AI Agent (7 tests)
- ✅ Missing language model detection (MISSING_LANGUAGE_MODEL)
- ✅ Language model connection validation (1 or 2 for fallback)
- ✅ Tool connection detection (NO false warnings)
- ✅ Streaming mode constraints (Chat Trigger)
- ✅ Own streamResponse setting validation
- ✅ Multiple memory detection (error)
- ✅ Complete workflow with all components
#### Chat Trigger (5 tests)
- ✅ Streaming to non-AI-Agent detection (STREAMING_WRONG_TARGET)
- ✅ Missing connections detection (MISSING_CONNECTIONS)
- ✅ Valid streaming setup
- ✅ LastNode mode validation
- ✅ Streaming agent with output (error)
#### Basic LLM Chain (6 tests)
- ✅ Missing language model detection
- ✅ Missing prompt text detection (MISSING_PROMPT_TEXT)
- ✅ Complete LLM Chain validation
- ✅ Memory support validation
- ✅ Multiple models detection (no fallback support)
- ✅ Tools connection detection (TOOLS_NOT_SUPPORTED)
#### AI Tools (9 tests)
- ✅ HTTP Request Tool: toolDescription + URL validation
- ✅ Code Tool: code requirement validation
- ✅ Vector Store Tool: toolDescription validation
- ✅ Workflow Tool: workflowId validation
- ✅ Calculator Tool: no configuration needed
#### End-to-End (5 tests)
- ✅ Complex workflow creation (7 nodes)
- ✅ Multiple error detection (5+ errors)
- ✅ Streaming workflow validation
- ✅ Non-streaming workflow validation
-**Node type normalization bug fix validation**
## Error Codes Validated
All tests verify correct error code detection:
| Error Code | Description | Test Coverage |
|------------|-------------|---------------|
| MISSING_LANGUAGE_MODEL | No language model connected | ✅ AI Agent, LLM Chain |
| MISSING_TOOL_DESCRIPTION | Tool missing description | ✅ HTTP Tool, Vector Tool |
| MISSING_URL | HTTP tool missing URL | ✅ HTTP Tool |
| MISSING_CODE | Code tool missing code | ✅ Code Tool |
| MISSING_WORKFLOW_ID | Workflow tool missing ID | ✅ Workflow Tool |
| MISSING_PROMPT_TEXT | Prompt type=define but no text | ✅ AI Agent, LLM Chain |
| MISSING_CONNECTIONS | Chat Trigger has no output | ✅ Chat Trigger |
| STREAMING_WITH_MAIN_OUTPUT | AI Agent streaming with output | ✅ AI Agent |
| STREAMING_WRONG_TARGET | Chat Trigger streaming to non-agent | ✅ Chat Trigger |
| STREAMING_AGENT_HAS_OUTPUT | Streaming agent has output | ✅ Chat Trigger |
| MULTIPLE_LANGUAGE_MODELS | LLM Chain with multiple models | ✅ LLM Chain |
| MULTIPLE_MEMORY_CONNECTIONS | Multiple memory connected | ✅ AI Agent |
| TOOLS_NOT_SUPPORTED | Basic LLM Chain with tools | ✅ LLM Chain |
## Bug Fix Validation
### v2.17.0 Node Type Normalization Fix
**Test**: `e2e-validation.test.ts` - Test 5
**Bug**: Incorrect node type comparison causing false "no tools" warnings:
```typescript
// BEFORE (BUG):
sourceNode.type === 'nodes-langchain.chatTrigger' // ❌ Never matches @n8n/n8n-nodes-langchain.chatTrigger
// AFTER (FIX):
NodeTypeNormalizer.normalizeToFullForm(sourceNode.type) === 'nodes-langchain.chatTrigger' // ✅ Works
```
**Test Validation**:
1. Creates workflow: AI Agent + OpenAI Model + HTTP Request Tool
2. Connects tool via ai_tool connection
3. Validates workflow is VALID
4. Verifies NO false "no tools connected" warning
**Result**: ✅ Test would have caught this bug if it existed before the fix
## Test Infrastructure
### Helper Functions (19 total)
#### Node Creators
- `createAIAgentNode()` - AI Agent with all options
- `createChatTriggerNode()` - Chat Trigger with streaming modes
- `createBasicLLMChainNode()` - Basic LLM Chain
- `createLanguageModelNode()` - OpenAI/Anthropic models
- `createHTTPRequestToolNode()` - HTTP Request Tool
- `createCodeToolNode()` - Code Tool
- `createVectorStoreToolNode()` - Vector Store Tool
- `createWorkflowToolNode()` - Workflow Tool
- `createCalculatorToolNode()` - Calculator Tool
- `createMemoryNode()` - Buffer Window Memory
- `createRespondNode()` - Respond to Webhook
#### Connection Helpers
- `createAIConnection()` - AI connection (reversed for langchain)
- `createMainConnection()` - Standard n8n connection
- `mergeConnections()` - Merge multiple connection objects
#### Workflow Builders
- `createAIWorkflow()` - Complete workflow builder
- `waitForWorkflow()` - Wait for operations
### Test Features
1. **Real n8n Integration**
- All tests use real n8n API (not mocked)
- Creates actual workflows
- Validates using real MCP handlers
2. **Automatic Cleanup**
- TestContext tracks all created workflows
- Automatic cleanup in afterEach
- Orphaned workflow cleanup in afterAll
- Tagged with `mcp-integration-test` and `ai-validation`
3. **Independent Tests**
- No shared state between tests
- Each test creates its own workflows
- Timestamped workflow names prevent collisions
4. **Deterministic Execution**
- No race conditions
- Explicit connection structures
- Proper async handling
## Running the Tests
### Prerequisites
```bash
# Environment variables required
export N8N_API_URL=http://localhost:5678
export N8N_API_KEY=your-api-key
export TEST_CLEANUP=true # Optional, defaults to true
# Build first
npm run build
```
### Run Commands
```bash
# Run all AI validation tests
npm test -- tests/integration/ai-validation --run
# Run specific suite
npm test -- tests/integration/ai-validation/ai-agent-validation.test.ts --run
npm test -- tests/integration/ai-validation/chat-trigger-validation.test.ts --run
npm test -- tests/integration/ai-validation/llm-chain-validation.test.ts --run
npm test -- tests/integration/ai-validation/ai-tool-validation.test.ts --run
npm test -- tests/integration/ai-validation/e2e-validation.test.ts --run
```
### Expected Results
- **Total Tests**: 32
- **Expected Pass**: 32
- **Expected Fail**: 0
- **Duration**: ~30-60 seconds (depends on n8n response time)
## Test Quality Metrics
### Coverage
-**100% of AI validation rules** covered
-**All error codes** validated
-**All AI node types** tested
-**Streaming modes** comprehensively tested
-**Connection patterns** fully validated
### Edge Cases
- ✅ Empty/missing required fields
- ✅ Invalid configurations
- ✅ Multiple connections (when not allowed)
- ✅ Streaming with main output (forbidden)
- ✅ Tool connections to non-agent nodes
- ✅ Fallback model configuration
- ✅ Complex workflows with all components
### Reliability
- ✅ Deterministic (no flakiness)
- ✅ Independent (no test dependencies)
- ✅ Clean (automatic resource cleanup)
- ✅ Fast (under 30 seconds per test)
## Gaps and Future Improvements
### Potential Additional Tests
1. **Performance Tests**
- Large AI workflows (20+ nodes)
- Bulk validation operations
- Concurrent workflow validation
2. **Credential Tests**
- Invalid/missing credentials
- Expired credentials
- Multiple credential types
3. **Expression Tests**
- n8n expressions in AI node parameters
- Expression validation in tool parameters
- Dynamic prompt generation
4. **Version Tests**
- Different node typeVersions
- Version compatibility
- Migration validation
5. **Advanced Scenarios**
- Nested workflows with AI nodes
- AI nodes in sub-workflows
- Complex connection patterns
- Multiple AI Agents in one workflow
### Recommendations
1. **Maintain test helpers** - Update when new AI nodes are added
2. **Add regression tests** - For each bug fix, add a test that would catch it
3. **Monitor test execution time** - Keep tests under 30 seconds each
4. **Expand error scenarios** - Add more edge cases as they're discovered
5. **Document test patterns** - Help future developers understand test structure
## Conclusion
### ✅ Success Criteria Met
1. **Comprehensive Coverage**: 32 tests covering all AI validation operations
2. **Real Integration**: All tests use real n8n API, not mocks
3. **Validation Accuracy**: All error codes and validation rules tested
4. **Bug Prevention**: Tests would have caught the v2.17.0 normalization bug
5. **Clean Infrastructure**: Automatic cleanup, independent tests, deterministic
6. **Documentation**: Complete README and this report
### 📊 Final Statistics
- **Total Test Files**: 5
- **Total Tests**: 32
- **Helper Functions**: 19
- **Error Codes Tested**: 13+
- **AI Node Types Covered**: 13+ (Agent, Trigger, Chain, 5 Tools, 2 Models, Memory, Respond)
- **Documentation Files**: 2 (README.md, TEST_REPORT.md)
### 🎯 Key Achievement
**These tests would have caught the node type normalization bug** that was fixed in v2.17.0. The test suite validates that:
- AI tools are correctly detected
- No false "no tools connected" warnings
- Node type normalization works properly
- All validation rules function end-to-end
This comprehensive test suite provides confidence that:
1. All AI validation operations work correctly
2. Future changes won't break existing functionality
3. New bugs will be caught before deployment
4. The validation logic matches the specification
## Files Created
```
tests/integration/ai-validation/
├── helpers.ts # 19 utility functions
├── ai-agent-validation.test.ts # 7 tests
├── chat-trigger-validation.test.ts # 5 tests
├── llm-chain-validation.test.ts # 6 tests
├── ai-tool-validation.test.ts # 9 tests
├── e2e-validation.test.ts # 5 tests
├── README.md # Complete documentation
└── TEST_REPORT.md # This report
```
**Total Lines of Code**: ~2,500+ lines
**Documentation**: ~500+ lines
**Test Coverage**: 100% of AI validation features

Some files were not shown because too many files have changed in this diff Show More