{"_id":"@algabis/auto-n8n","_rev":"3-21fe5e7af4642b66edd5e67b4cac4720","name":"@algabis/auto-n8n","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@algabis/auto-n8n","version":"1.0.0","keywords":["auto-n8n","n8n","mcp","model-context-protocol","workflow","automation","api","typescript","claude","cursor","windsurf"],"author":{"name":"Auto-n8n Team"},"license":"AGPL-3.0","_id":"@algabis/auto-n8n@1.0.0","maintainers":[{"name":"algabis","email":"Algabis@hotmail.com"}],"homepage":"https://github.com/your-org/auto-n8n#readme","bugs":{"url":"https://github.com/your-org/auto-n8n/issues"},"dist":{"shasum":"068dfc228cdedc24705e611e4703bf7385abdc11","tarball":"https://registry.npmjs.org/@algabis/auto-n8n/-/auto-n8n-1.0.0.tgz","fileCount":54,"integrity":"sha512-omBF7Iq3LslEY4JGQvrir4qU1oR0iduDT9GFarjrUJPgTjgQMviDXYGu8FGmPc1QHr9SSUx6pAoBy2PM2cOq3Q==","signatures":[{"sig":"MEUCIQCR5WR7A7zMyf7WxHMF++AWGDxOtuIWoycRBksOvbrS8AIgVYh7Ao88OnZ8Mu1end1Xyh+8f6HTT8fFypzFRZkHpjk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":992978},"main":"dist/server.js","type":"module","types":"./dist/server.d.ts","engines":{"node":">=18.0.0"},"gitHead":"5b81ca8ab08f42219a8874413942230ebf00acb6","scripts":{"dev":"tsx watch src/server.ts","lint":"eslint src/**/*.ts","test":"jest","build":"tsc","setup":"node setup.js","start":"node dist/server.js","format":"prettier --write src/**/*.ts","build:alt":"node build.cjs","start:prod":"npm run build:alt && npm run start","test:watch":"jest --watch","type-check":"tsc --noEmit"},"_npmUser":{"name":"algabis","email":"Algabis@hotmail.com"},"repository":{"url":"git+https://github.com/your-org/auto-n8n.git","type":"git"},"_npmVersion":"10.8.1","description":"Model Context Protocol server for automated n8n workflow management","directories":{},"_nodeVersion":"18.17.1","dependencies":{"zod":"^3.25.42","axios":"^1.9.0","dotenv":"^16.5.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","jest":"^29.7.0","eslint":"^8.52.0","prettier":"^3.0.0","typescript":"^5.8.3","@types/jest":"^29.5.0","@types/node":"^20.17.57","@typescript-eslint/parser":"^6.9.0","@typescript-eslint/eslint-plugin":"^6.9.0"},"_npmOperationalInternal":{"tmp":"tmp/auto-n8n_1.0.0_1748857219554_0.8439375465283259","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@algabis/auto-n8n","version":"1.0.1","keywords":["auto-n8n","n8n","mcp","model-context-protocol","workflow","automation","api","typescript","claude","cursor","windsurf"],"author":{"name":"Auto-n8n Team"},"license":"AGPL-3.0","_id":"@algabis/auto-n8n@1.0.1","maintainers":[{"name":"algabis","email":"Algabis@hotmail.com"}],"homepage":"https://github.com/algabis/auto-n8n#readme","bugs":{"url":"https://github.com/algabis/auto-n8n/issues"},"dist":{"shasum":"90cf44105f2791e8ce167bdaddea7ce4ef51bd4e","tarball":"https://registry.npmjs.org/@algabis/auto-n8n/-/auto-n8n-1.0.1.tgz","fileCount":54,"integrity":"sha512-AOazMowsqRCqaHQaKsGvsa9cp1IfjKZbG4sMGu34aMJas3OuEJXMfx70SRZMLSdTpODdbW2MnoHIjTMxC33lMA==","signatures":[{"sig":"MEUCIG9vuY8vDHZWudRbRRj+xKKtmRqK9tPbI4ArZk2yxjF9AiEA/tmyyrpOJqjHiTAsmlPfeZIu2GzkXvizXFJmFuGHR6Y=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":992973},"main":"dist/server.js","type":"module","types":"./dist/server.d.ts","engines":{"node":">=18.0.0"},"gitHead":"db9afe103a07533554dae27046f4f83eda0105de","scripts":{"dev":"tsx watch src/server.ts","lint":"eslint src/**/*.ts","test":"jest","build":"tsc","setup":"node setup.js","start":"node dist/server.js","format":"prettier --write src/**/*.ts","build:alt":"node build.cjs","start:prod":"npm run build:alt && npm run start","test:watch":"jest --watch","type-check":"tsc --noEmit"},"_npmUser":{"name":"algabis","email":"Algabis@hotmail.com"},"repository":{"url":"git+https://github.com/algabis/auto-n8n.git","type":"git"},"_npmVersion":"10.8.1","description":"Model Context Protocol server for automated n8n workflow management","directories":{},"_nodeVersion":"18.17.1","dependencies":{"zod":"^3.25.42","axios":"^1.9.0","dotenv":"^16.5.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","jest":"^29.7.0","eslint":"^8.52.0","prettier":"^3.0.0","typescript":"^5.8.3","@types/jest":"^29.5.0","@types/node":"^20.17.57","@typescript-eslint/parser":"^6.9.0","@typescript-eslint/eslint-plugin":"^6.9.0"},"_npmOperationalInternal":{"tmp":"tmp/auto-n8n_1.0.1_1748857787946_0.5406504571861557","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@algabis/auto-n8n","version":"1.0.2","description":"Model Context Protocol server for automated n8n workflow management","main":"dist/server.js","type":"module","scripts":{"build":"tsc","build:alt":"node build.cjs","setup":"node setup.js","start":"node dist/server.js","dev":"tsx watch src/server.ts","lint":"eslint src/**/*.ts","format":"prettier --write src/**/*.ts","test":"jest","test:watch":"jest --watch","type-check":"tsc --noEmit","start:prod":"npm run build:alt && npm run start"},"keywords":["auto-n8n","n8n","mcp","model-context-protocol","workflow","automation","api","typescript","claude","cursor","windsurf"],"author":{"name":"Auto-n8n Team"},"license":"AGPL-3.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0","axios":"^1.9.0","dotenv":"^16.5.0","zod":"^3.25.42"},"devDependencies":{"@types/jest":"^29.5.0","@types/node":"^20.17.57","@typescript-eslint/eslint-plugin":"^6.9.0","@typescript-eslint/parser":"^6.9.0","eslint":"^8.52.0","jest":"^29.7.0","prettier":"^3.0.0","tsx":"^4.0.0","typescript":"^5.8.3"},"engines":{"node":">=18.0.0"},"repository":{"type":"git","url":"git+https://github.com/algabis/auto-n8n.git"},"bugs":{"url":"https://github.com/algabis/auto-n8n/issues"},"homepage":"https://github.com/algabis/auto-n8n#readme","_id":"@algabis/auto-n8n@1.0.2","gitHead":"908dc41d69fdcaeb09c82deef6330cfd10b73803","types":"./dist/server.d.ts","_nodeVersion":"18.17.1","_npmVersion":"10.8.1","dist":{"integrity":"sha512-YS7yxt5yhNHdF0XtFMe+ggBqzNe3Ebfms5bSauCRVv6ODNsjx3+ZMLXFtmcUe5DS3/P6tcyclNaL8WjnlJoHLQ==","shasum":"d596dd0431bb0aaf5308010063d08a80497d53c4","tarball":"https://registry.npmjs.org/@algabis/auto-n8n/-/auto-n8n-1.0.2.tgz","fileCount":51,"unpackedSize":956148,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIAda3YgxTRaP9dNSnFur5S/lHglCBibxlmHP7OzFKaEjAiBU44sY6gBwQDs6KtFLbziG2JO4Tx1SH98NxoR7U5x8Pg=="}]},"_npmUser":{"name":"algabis","email":"Algabis@hotmail.com"},"directories":{},"maintainers":[{"name":"algabis","email":"Algabis@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/auto-n8n_1.0.2_1748858383397_0.29646317298742697"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-02T09:40:19.461Z","modified":"2025-06-02T09:59:43.778Z","1.0.0":"2025-06-02T09:40:19.801Z","1.0.1":"2025-06-02T09:49:48.173Z","1.0.2":"2025-06-02T09:59:43.622Z"},"bugs":{"url":"https://github.com/algabis/auto-n8n/issues"},"author":{"name":"Auto-n8n Team"},"license":"AGPL-3.0","homepage":"https://github.com/algabis/auto-n8n#readme","keywords":["auto-n8n","n8n","mcp","model-context-protocol","workflow","automation","api","typescript","claude","cursor","windsurf"],"repository":{"type":"git","url":"git+https://github.com/algabis/auto-n8n.git"},"description":"Model Context Protocol server for automated n8n workflow management","maintainers":[{"name":"algabis","email":"Algabis@hotmail.com"}],"readme":"# Auto-n8n\r\n\r\nA comprehensive Model Context Protocol (MCP) server for automated n8n workflow management. This server enables AI assistants to interact with self-hosted n8n instances through a standardized protocol, providing tools for workflow management, execution monitoring, and system administration.\r\n\r\n## Features\r\n\r\n### 🔧 Workflow Management\r\n- List, create, update, and delete workflows\r\n- Activate/deactivate workflows\r\n- Transfer workflows between projects (Enterprise)\r\n- Manage workflow tags and organization\r\n- **Smart workflow examples search** - Find real working workflows by node types or keywords\r\n\r\n### 📊 Execution Monitoring\r\n- Monitor workflow executions in real-time\r\n- View detailed execution logs and debugging information\r\n- Track execution performance and duration\r\n- Delete execution history\r\n\r\n### 🏷️ Organization & Management\r\n- Tag management for workflow organization\r\n- Environment variable management\r\n- Project management (Enterprise features)\r\n- Credential management with security\r\n\r\n### 🔒 Security & Auditing\r\n- Generate comprehensive security audit reports\r\n- Identify security risks and vulnerabilities\r\n- Monitor unused credentials and abandoned workflows\r\n- Database and filesystem security analysis\r\n\r\n### 👥 User Management (Enterprise)\r\n- List and manage users in your n8n instance\r\n- Create and invite new team members\r\n- Manage user roles and permissions\r\n- Delete user accounts\r\n\r\n### 🔄 Source Control Integration\r\n- Pull changes from connected Git repositories\r\n- Sync workflows and configurations\r\n- Manage environment variables during deployment\r\n- Handle merge conflicts and versioning\r\n\r\n## Installation\r\n\r\n### Prerequisites\r\n- Self-hosted n8n instance with API access\r\n- n8n API key\r\n- **Option 1 (Docker - Recommended)**: Docker and Docker Compose\r\n- **Option 2 (Native)**: Node.js 18.0.0 or higher, npm or yarn\r\n\r\n## 🐳 Docker Installation (Recommended)\r\n\r\n### Quick Start\r\n1. **Clone the repository:**\r\n```bash\r\ngit clone https://github.com/algabis/auto-n8n\r\ncd auto-n8n\r\n```\r\n\r\n2. **Configure environment variables:**\r\nCreate a `.env` file in the project root:\r\n```env\r\n# n8n API Configuration (REQUIRED)\r\n# ⚠️ IMPORTANT: Do NOT include /api/v1/ in the URL\r\nN8N_BASE_URL=https://your-n8n-instance.com\r\nN8N_API_KEY=your-api-key-here\r\n\r\n# Optional Configuration\r\nREQUEST_TIMEOUT=30000\r\nMAX_RETRY_ATTEMPTS=3\r\nLOG_LEVEL=info\r\n```\r\n\r\n3. **Build and run with Docker Compose:**\r\n```bash\r\n# Quick setup (build + run)\r\nmake setup\r\n\r\n# Or manually:\r\ndocker-compose up --build -d\r\n```\r\n\r\n4. **Check status:**\r\n```bash\r\nmake status\r\n# or\r\ndocker-compose ps\r\n```\r\n\r\n### 🧪 **Testing Tools Immediately**\r\n\r\nOnce the server is running, **5 tools work immediately** without needing n8n API configuration:\r\n\r\n```bash\r\n# Test that the server and tools are working\r\n# You can try these in your MCP client right away:\r\n\r\n# 1. Browse node categories\r\nTool: node_categories, Parameters: {}\r\n\r\n# 2. List webhook-related nodes  \r\nTool: node_types_list, Parameters: {\"search\": \"webhook\"}\r\n\r\n# 3. Get detailed webhook node info\r\nTool: node_type_info, Parameters: {\"nodeType\": \"n8n-nodes-base.webhook\"}\r\n\r\n# 4. Get a workflow example\r\nTool: workflow_examples, Parameters: {\"useCase\": \"simple-webhook\"}\r\n```\r\n\r\nThe other **35 tools require a connected n8n instance** with API credentials configured.\r\n\r\n### Docker Commands\r\n\r\n```bash\r\n# Build the image\r\nmake build\r\n\r\n# Run in background\r\nmake run\r\n\r\n# Run in foreground (with logs)\r\nmake run-fg\r\n\r\n# View logs\r\nmake logs\r\n\r\n# Stop container\r\nmake stop\r\n\r\n# Restart\r\nmake restart\r\n\r\n# Get shell access\r\nmake shell\r\n\r\n# Clean up everything\r\nmake clean\r\n\r\n# Test the image\r\nmake test-image\r\n```\r\n\r\n### Alternative Installation Methods\r\n\r\n#### Quick Comparison\r\n\r\n| Method | Best For | Pros | Cons |\r\n|--------|----------|------|------|\r\n| **Deployment Scripts** | First-time users, Production | Auto-validation, Error handling, Cross-platform | Requires script execution permissions |\r\n| **Docker Compose** | Development, Simple setups | Easy configuration, Built-in services | Manual validation needed |\r\n| **Make Commands** | Linux/Mac developers | Simple commands, Traditional workflow | Linux/Mac only |\r\n| **Direct Docker** | Advanced users, Custom setups | Full control, Minimal dependencies | Manual configuration required |\r\n| **Native Installation** | Development, Debugging | Direct access, Fast iteration | Manual dependency management |\r\n\r\n#### Method 1: Deployment Scripts (Recommended)\r\nUse our intelligent deployment scripts with built-in validation and error handling.\r\n\r\n**Features:**\r\n- ✅ Automatic Docker installation validation\r\n- ✅ Environment variable validation\r\n- ✅ n8n API connectivity testing\r\n- ✅ Colored output and progress indicators\r\n- ✅ Comprehensive error handling\r\n- ✅ Cross-platform support\r\n\r\n**Linux/Mac:**\r\n```bash\r\n# Make script executable (first time only)\r\nchmod +x deploy.sh\r\n\r\n# Quick setup with validation\r\n./deploy.sh setup\r\n\r\n# Other commands\r\n./deploy.sh logs      # View logs\r\n./deploy.sh stop      # Stop container\r\n./deploy.sh restart   # Restart container\r\n./deploy.sh status    # Check container status\r\n./deploy.sh shell     # Get shell access\r\n./deploy.sh clean     # Complete cleanup\r\n./deploy.sh help      # Show all commands\r\n```\r\n\r\n**Windows PowerShell:**\r\n```powershell\r\n# Quick setup with validation\r\n.\\deploy.ps1 setup\r\n\r\n# Other commands\r\n.\\deploy.ps1 logs      # View logs\r\n.\\deploy.ps1 stop      # Stop container\r\n.\\deploy.ps1 restart   # Restart container\r\n.\\deploy.ps1 status    # Check container status\r\n.\\deploy.ps1 shell     # Get shell access\r\n.\\deploy.ps1 clean     # Complete cleanup\r\n.\\deploy.ps1 help      # Show all commands\r\n```\r\n\r\n#### Method 2: Direct Docker Run\r\n```bash\r\n# Build and run manually\r\ndocker build -t auto-n8n .\r\ndocker run -d --name auto-n8n-server \\\r\n  --env-file .env \\\r\n  --restart unless-stopped \\\r\n  auto-n8n:latest\r\n```\r\n\r\n#### Method 3: Using Make (Linux/Mac)\r\n```bash\r\n# All-in-one setup\r\nmake setup\r\n\r\n# Individual commands\r\nmake build     # Build image\r\nmake run       # Start container\r\nmake logs      # View logs\r\nmake stop      # Stop container\r\nmake clean     # Cleanup everything\r\n```\r\n\r\n## 📦 Native Installation\r\n\r\n### Setup\r\n\r\n1. **Clone and install dependencies:**\r\n```bash\r\ngit clone https://github.com/algabis/auto-n8n\r\ncd auto-n8n\r\nnpm install\r\n```\r\n\r\n2. **Configure environment variables:**\r\nCreate a `.env` file (same as Docker setup above)\r\n\r\n3. **Build the project:**\r\n```bash\r\nnpm run build\r\n```\r\n\r\n4. **Start the server:**\r\n```bash\r\nnpm start\r\n```\r\n\r\nFor development with auto-reload:\r\n```bash\r\nnpm run dev\r\n```\r\n\r\n## Configuration\r\n\r\n### n8n API Setup\r\n1. Access your n8n instance admin panel\r\n2. Navigate to Settings → API\r\n3. Generate a new API key\r\n4. Copy the API key to your `.env` file\r\n\r\n### Environment Variables\r\n| Variable | Description | Default | Validation |\r\n|----------|-------------|---------|------------|\r\n| `N8N_BASE_URL` | Base URL of your n8n instance ⚠️ **Do NOT include `/api/v1`** | Required | Must start with http:// or https:// |\r\n| `N8N_API_KEY` | n8n API key for authentication | Required | Must not be empty |\r\n| `REQUEST_TIMEOUT` | API request timeout in milliseconds | 30000 | Optional |\r\n| `MAX_RETRY_ATTEMPTS` | Number of retry attempts for failed requests | 3 | Optional |\r\n| `LOG_LEVEL` | Logging level (info, debug, warn, error) | info | Optional |\r\n\r\n#### ⚠️ **Important URL Configuration**\r\n- ✅ **Correct**: `N8N_BASE_URL=https://your-n8n-instance.com`\r\n- ❌ **Wrong**: `N8N_BASE_URL=https://your-n8n-instance.com/api/v1/`\r\n\r\nThe MCP server automatically appends `/api/v1/` to API requests. Including it in your base URL will cause \"Resource not found\" errors.\r\n\r\n### Automatic Validation\r\nWhen using deployment scripts, the following validations are performed:\r\n- ✅ Docker installation and daemon status\r\n- ✅ Required environment variables presence\r\n- ✅ n8n URL format validation\r\n- ✅ Optional API connectivity test\r\n- ✅ Container health monitoring\r\n\r\n## Available Tools (40 Total)\r\n\r\nAuto-n8n provides exactly **40 MCP tools** to stay within LLM compatibility limits. The tools are organized into two categories:\r\n\r\n### ✅ **Immediate Access Tools (5 Tools)**\r\nThese tools work immediately without requiring n8n API connection:\r\n\r\n#### `node_categories`\r\nList all node categories with descriptions and node counts.\r\n```json\r\n{}\r\n```\r\n\r\n#### `node_types_list`\r\nList all available built-in n8n node types with categories and descriptions.\r\n```json\r\n{\r\n  \"category\": \"Core\",\r\n  \"search\": \"webhook\"\r\n}\r\n```\r\n\r\n#### `node_type_info`\r\nGet detailed information about a specific node type including parameters and usage.\r\n```json\r\n{\r\n  \"nodeType\": \"n8n-nodes-base.openai\"\r\n}\r\n```\r\n\r\n#### `workflow_examples`\r\nGet example workflow structures for common use cases.\r\n```json\r\n{\r\n  \"useCase\": \"simple-webhook\"\r\n}\r\n```\r\n\r\n#### `workflow_examples_search`\r\n🆕 **Smart search through real working workflow examples**. Find workflows that use specific nodes or match keywords. Perfect for learning how nodes are actually implemented.\r\n```json\r\n{\r\n  \"nodeTypes\": [\"n8n-nodes-base.openai\", \"n8n-nodes-base.slack\"],\r\n  \"keywords\": [\"ai\", \"automation\"],\r\n  \"maxExamples\": 2,\r\n  \"includeFullWorkflow\": false\r\n}\r\n```\r\n\r\n**Use these immediate access tools when you need to:**\r\n- 📚 Learn about n8n nodes and their capabilities\r\n- 🔍 Find workflow examples and implementation patterns\r\n- 📖 Understand node parameters and configurations\r\n- 🏗️ Design workflows before implementing them\r\n\r\n### 🔌 **n8n API Tools (35 Tools)**\r\nThese tools require a connected n8n instance with valid API credentials:\r\n\r\n#### **Workflow Management (8 tools)**\r\n- `workflow_list` - List all workflows with filtering options\r\n- `workflow_get` - Get detailed workflow information  \r\n- `workflow_create` - Create new workflows programmatically\r\n- `workflow_update` - Update existing workflow properties\r\n- `workflow_delete` - Delete workflows permanently\r\n- `workflow_transfer` - Transfer workflows between projects\r\n- `workflow_activate` - Activate workflows for automatic execution\r\n- `workflow_deactivate` - Deactivate workflows to stop execution\r\n\r\n#### **Execution Monitoring (3 tools)**\r\n- `execution_list` - Monitor workflow executions with filtering\r\n- `execution_get` - Get detailed execution information for debugging\r\n- `execution_delete` - Delete execution records\r\n\r\n#### **Tag Management (7 tools)**\r\n- `tag_list` - List all available tags for organization\r\n- `tag_create` - Create new tags for organizing workflows\r\n- `tag_get` - Get detailed information about specific tags\r\n- `tag_update` - Update existing tag names\r\n- `tag_delete` - Delete tags permanently\r\n- `workflow_tags_get` - Get all tags assigned to a workflow\r\n- `workflow_tags_update` - Update tags assigned to workflows\r\n\r\n#### **Variable Management (4 tools)**\r\n- `variable_list` - List all environment variables\r\n- `variable_create` - Create new environment variables\r\n- `variable_update` - Update existing environment variables\r\n- `variable_delete` - Delete environment variables\r\n\r\n#### **Project Management (4 tools)**\r\n- `project_list` - List all projects\r\n- `project_create` - Create new projects\r\n- `project_update` - Update project properties\r\n- `project_delete` - Delete projects\r\n\r\n#### **User Management (5 tools)**\r\n- `user_list` - List all users in the n8n instance\r\n- `user_get` - Get detailed user information\r\n- `user_create` - Create new users and send invitations\r\n- `user_role_change` - Change user roles and permissions\r\n- `user_delete` - Delete user accounts\r\n\r\n#### **Security & Administration (2 tools)**\r\n- `audit_generate` - Generate comprehensive security audit reports\r\n- `source_control_pull` - Pull changes from connected Git repositories\r\n\r\n#### **Credential Management (2 tools)**\r\n- `credential_create` - Create new credentials for workflow authentication\r\n- `credential_delete` - Delete credentials permanently\r\n\r\n### 📝 **Example Usage**\r\n\r\n#### Workflow Management\r\n```json\r\n// List active workflows\r\n{\r\n  \"tool\": \"workflow_list\",\r\n  \"args\": {\r\n    \"active\": true,\r\n    \"limit\": 10\r\n  }\r\n}\r\n\r\n// Create a simple webhook workflow\r\n{\r\n  \"tool\": \"workflow_create\", \r\n  \"args\": {\r\n    \"name\": \"My Webhook Handler\",\r\n    \"nodes\": [\r\n      {\r\n        \"name\": \"Webhook\",\r\n        \"type\": \"n8n-nodes-base.webhook\",\r\n        \"parameters\": {\r\n          \"httpMethod\": \"POST\",\r\n          \"path\": \"my-webhook\"\r\n        },\r\n        \"position\": [0, 0]\r\n      }\r\n    ],\r\n    \"connections\": {},\r\n    \"settings\": {\r\n      \"saveExecutionProgress\": false,\r\n      \"saveManualExecutions\": false,\r\n      \"saveDataErrorExecution\": \"all\",\r\n      \"saveDataSuccessExecution\": \"all\"\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n#### Monitoring & Debugging\r\n```json\r\n// Monitor failed executions\r\n{\r\n  \"tool\": \"execution_list\",\r\n  \"args\": {\r\n    \"status\": \"error\",\r\n    \"limit\": 20,\r\n    \"includeData\": false\r\n  }\r\n}\r\n\r\n// Get detailed execution data for debugging\r\n{\r\n  \"tool\": \"execution_get\",\r\n  \"args\": {\r\n    \"id\": \"execution-id-here\",\r\n    \"includeData\": true\r\n  }\r\n}\r\n```\r\n\r\n## MCP Client Integration\r\n\r\n### Claude Desktop\r\n\r\n#### Native Installation (Recommended)\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"node\",\r\n      \"args\": [\"/absolute/path/to/auto-n8n/dist/server.js\"],\r\n      \"env\": {\r\n        \"N8N_BASE_URL\": \"https://your-n8n-instance.com\",\r\n        \"N8N_API_KEY\": \"your-api-key-here\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**Windows Example:**\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"node\",\r\n      \"args\": [\"D:\\\\projects\\\\auto-n8n\\\\dist\\\\server.js\"],\r\n      \"env\": {\r\n        \"N8N_BASE_URL\": \"https://your-n8n-instance.com\",\r\n        \"N8N_API_KEY\": \"your-api-key-here\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**Linux/Mac Example:**\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"node\",\r\n      \"args\": [\"/home/user/auto-n8n/dist/server.js\"],\r\n      \"env\": {\r\n        \"N8N_BASE_URL\": \"https://your-n8n-instance.com\",\r\n        \"N8N_API_KEY\": \"your-api-key-here\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n#### Docker Installation\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"docker\",\r\n      \"args\": [\r\n        \"run\", \"--rm\", \"-i\",\r\n        \"--env-file\", \"/path/to/your/.env\",\r\n        \"auto-n8n:latest\"\r\n      ]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n#### Docker Compose\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"docker-compose\",\r\n      \"args\": [\r\n        \"-f\", \"/path/to/auto-n8n/docker-compose.yml\",\r\n        \"run\", \"--rm\", \"auto-n8n\"\r\n      ]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Cursor IDE\r\n\r\nFor Cursor IDE, place the configuration in `~/.cursor/mcp.json` (Linux/Mac) or `C:\\Users\\<username>\\.cursor\\mcp.json` (Windows):\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"auto-n8n\": {\r\n      \"command\": \"node\",\r\n      \"args\": [\"/absolute/path/to/auto-n8n/dist/server.js\"],\r\n      \"env\": {\r\n        \"N8N_BASE_URL\": \"https://your-n8n-instance.com\",\r\n        \"N8N_API_KEY\": \"your-api-key-here\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**⚠️ Important**: \r\n- Use **absolute paths** in the `args` field - relative paths and `cwd` may not work reliably\r\n- Include environment variables directly in the `env` object\r\n- **Do NOT include `/api/v1/` in N8N_BASE_URL** - use just the domain\r\n- Restart Cursor completely after modifying `mcp.json`\r\n\r\n### Other MCP Clients\r\nThe server implements the standard MCP protocol and works with:\r\n- **Windsurf**: Integrated workflow management\r\n- **n8n Native MCP Nodes**: n8n 1.88.0+ includes built-in MCP Server Trigger and MCP Client Tool nodes\r\n- Any MCP-compatible client\r\n\r\n### n8n Native MCP Integration\r\nAs of n8n 1.88.0, n8n includes native MCP support:\r\n- **MCP Server Trigger**: Exposes n8n workflows as MCP tools\r\n- **MCP Client Tool**: Connects n8n to external MCP servers\r\n\r\nThis project complements n8n's native MCP by providing comprehensive API management capabilities.\r\n\r\n## API Limitations\r\n\r\n⚠️ **Important**: The n8n API does not support direct workflow execution. Workflows can only be executed through:\r\n- Webhook triggers\r\n- Schedule triggers\r\n- Manual execution in the n8n UI\r\n- External triggers configured in the workflow\r\n\r\nThis MCP server focuses on workflow management, monitoring, and administration rather than direct execution.\r\n\r\n## Development\r\n\r\n### Project Structure\r\n```\r\nauto-n8n/\r\n├── src/\r\n│   ├── server.ts              # Main MCP server implementation\r\n│   ├── n8n-client.ts          # n8n API client\r\n│   ├── utils/\r\n│   │   └── validation.ts      # Input validation schemas\r\n│   └── types/                 # TypeScript type definitions\r\n├── examples/\r\n│   ├── workflows/             # Real workflow examples for search\r\n│   └── README.md              # Workflow examples documentation\r\n├── dist/                      # Compiled JavaScript output\r\n├── package.json\r\n├── tsconfig.json\r\n├── quick-start.md             # Quick setup guide\r\n├── TROUBLESHOOTING.md         # Comprehensive troubleshooting\r\n└── README.md\r\n```\r\n\r\n### Building\r\n```bash\r\nnpm run build\r\n```\r\n\r\n### Development Mode\r\n```bash\r\nnpm run dev\r\n```\r\n\r\n### Code Style\r\n```bash\r\nnpm run lint\r\nnpm run format\r\n```\r\n\r\n## Error Handling\r\n\r\nThe server includes comprehensive error handling:\r\n- API authentication errors\r\n- Rate limiting protection\r\n- Network timeout handling\r\n- Input validation with detailed error messages\r\n- Graceful degradation for missing permissions\r\n\r\n## Security Considerations\r\n\r\n- API keys are never logged or exposed\r\n- All inputs are validated before processing\r\n- Minimum required permissions principle\r\n- Secure credential handling\r\n- Audit trail for all operations\r\n\r\n## Troubleshooting\r\n\r\n### Common Issues\r\n\r\n1. **Authentication Failed**\r\n   - Verify your n8n API key is correct\r\n   - Check that API access is enabled in n8n settings\r\n   - Ensure the API key has sufficient permissions\r\n\r\n2. **Connection Timeout**\r\n   - Verify your n8n instance is accessible\r\n   - Check network connectivity\r\n   - Increase `REQUEST_TIMEOUT` if needed\r\n\r\n3. **Permission Denied**\r\n   - Some features require n8n Enterprise (projects, user management)\r\n   - Verify API key has appropriate scopes\r\n\r\n4. **Docker Issues**\r\n   - Ensure Docker Desktop is running\r\n   - Check that `.env` file exists and contains valid values\r\n   - Try rebuilding the image: `make build` or `docker-compose build`\r\n   - View container logs: `make logs` or `docker-compose logs auto-n8n`\r\n\r\n5. **Deployment Script Issues**\r\n   - **Linux/Mac**: Make script executable: `chmod +x deploy.sh`\r\n   - **Windows**: Enable script execution: `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`\r\n   - **Environment validation fails**: Check your `.env` file format and required variables\r\n   - **Docker not found**: Ensure Docker is installed and in your system PATH\r\n\r\n## Contributing\r\n\r\n1. Fork the repository\r\n2. Create a feature branch\r\n3. Make your changes\r\n4. Add tests if applicable\r\n5. Submit a pull request\r\n\r\n## License\r\n\r\nThis project is licensed under the **GNU Affero General Public License v3.0**.\r\n\r\n### What this means:\r\n- ✅ **Free to use** for personal and non-commercial projects\r\n- ✅ **Free to modify** and create derivative works\r\n- ✅ **Free to distribute** under the same license terms\r\n- ⚠️ **Commercial use requires** that the entire application be open-sourced under AGPL\r\n- ⚠️ **SaaS/hosting requires** that all source code be made available to users\r\n\r\n### Why AGPL?\r\nThis license ensures that improvements and derivative works remain open and free for the community while preventing proprietary commercialization without giving back.\r\n\r\n**For commercial licensing inquiries**, please contact the project maintainers.\r\n\r\nSee the [LICENSE](LICENSE) file for the full license text.\r\n\r\n## Support\r\n\r\nFor issues and questions:\r\n1. Check the troubleshooting section\r\n2. Review n8n API documentation\r\n3. Open an issue on the repository\r\n\r\n---\r\n\r\n**Note**: This server requires a self-hosted n8n instance with API access. n8n Cloud instances may have different API capabilities and limitations. ","readmeFilename":"README.md"}