mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-01-30 06:22:04 +00:00
Complete implementation of Phase 1 foundation for n8n API integration tests. Establishes core utilities, fixtures, and infrastructure for testing all 17 n8n API handlers against real n8n instance. Changes: - Add integration test environment configuration to .env.example - Create comprehensive test utilities infrastructure: * credentials.ts: Environment-aware credential management (local .env vs CI secrets) * n8n-client.ts: Singleton API client wrapper with health checks * test-context.ts: Resource tracking and automatic cleanup * cleanup-helpers.ts: Multi-level cleanup strategies (orphaned, age-based, tag-based) * fixtures.ts: 6 pre-built workflow templates (webhook, HTTP, multi-node, error handling, AI, expressions) * factories.ts: Dynamic node/workflow builders with 15+ factory functions * webhook-workflows.ts: Webhook workflow configs and setup instructions - Add npm scripts: * test:integration:n8n: Run n8n API integration tests * test:cleanup:orphans: Clean up orphaned test resources - Create cleanup script for CI/manual use Documentation: - Add comprehensive integration testing plan (550 lines) - Add Phase 1 completion summary with lessons learned Key Features: - Automatic credential detection (CI vs local) - Multi-level cleanup (test, suite, CI, orphan) - 6 workflow fixtures covering common scenarios - 15+ factory functions for dynamic test data - Support for 4 HTTP methods (GET, POST, PUT, DELETE) via pre-activated webhook workflows - TypeScript-first with full type safety - Comprehensive error handling with helpful messages Total: ~1,520 lines of production-ready code + 650 lines of documentation Ready for Phase 2: Workflow creation tests 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
n8n-MCP Documentation
Welcome to the n8n-MCP documentation. This directory contains comprehensive guides for installation, configuration, and troubleshooting.
📚 Documentation Index
Getting Started
- Installation Guide - Comprehensive installation guide covering all methods
- Claude Desktop Setup - Step-by-step guide for Claude Desktop configuration
- Quick Start Tutorial - Basic overview and quick start instructions
Deployment
- HTTP Deployment Guide - Deploy n8n-MCP as an HTTP server for remote access
- Docker Deployment - Complete Docker deployment and configuration guide
- Release Guide - How to create releases and manage Docker tags
Reference
- Troubleshooting Guide - Solutions for common issues and errors
- HTTP Server Fix Documentation - Technical details of v2.3.2 HTTP server fixes
- Docker Optimization Guide - Reference for optimized Docker builds (~150MB)
- Changelog - Version history and release notes
🚀 Quick Links
For Users
For Developers
📋 Environment Variables
Key configuration options:
| Variable | Description | Default |
|---|---|---|
MCP_MODE |
Server mode: stdio or http |
stdio |
USE_FIXED_HTTP |
Use fixed HTTP implementation (v2.3.2+) | true |
AUTH_TOKEN |
Authentication token for HTTP mode | Required |
PORT |
HTTP server port | 3000 |
LOG_LEVEL |
Logging verbosity | info |
See Installation Guide for complete list.
🆘 Getting Help
- Check the Troubleshooting Guide
- Review HTTP Server Fix Documentation for v2.3.2 issues
- Open an issue on GitHub
📝 License
This project uses the Sustainable Use License. See LICENSE for details.