๐ Getting Started with n8n Workflow Builder MCP Server
August 4, 2025 ยท View on GitHub
Quick start guide to connect your AI assistant to n8n workflows in under 5 minutes.
๐ Prerequisites
Before you begin, ensure you have:
- Node.js v18.0.0+ installed
- n8n instance running (cloud or self-hosted)
- n8n API key with workflow permissions
- MCP-compatible AI assistant (Claude Desktop, Cline, etc.)
โก Quick Setup (Recommended)
Option 1: Smithery.ai Hosted (Fastest)
- Visit smithery.ai
- Search for "n8n-workflow-builder"
- Configure with your n8n credentials:
- n8n Host:
https://your-n8n-instance.com - API Key:
n8n_api_your_key_here
- n8n Host:
- Connect to your AI assistant
- Test with: "List my n8n workflows"
Option 2: Local Installation
# Install and run
npx @makafeli/n8n-workflow-builder
# Or install globally
npm install -g @makafeli/n8n-workflow-builder
n8n-workflow-builder
๐ Getting Your n8n API Key
For n8n Cloud:
- Login to your n8n Cloud instance
- Go to Settings โ API Keys
- Click Create API Key
- Copy the generated key
For Self-hosted n8n:
- Open your n8n instance
- Navigate to Settings โ API Keys
- Click Create API Key
- Save the key securely
๐ค AI Assistant Configuration
Claude Desktop Setup
Add to your claude_desktop_config.json:
{
"mcpServers": {
"n8n-workflow-builder": {
"command": "npx",
"args": ["@makafeli/n8n-workflow-builder"],
"env": {
"N8N_HOST": "https://your-n8n-instance.com",
"N8N_API_KEY": "your-api-key-here"
}
}
}
}
Cline (VS Code) Setup
Add to your Cline MCP settings:
{
"mcpServers": {
"n8n-workflow-builder": {
"command": "npx",
"args": ["@makafeli/n8n-workflow-builder"],
"env": {
"N8N_HOST": "https://your-n8n-instance.com",
"N8N_API_KEY": "your-api-key-here"
}
}
}
}
๐งช Test Your Setup
Try these commands with your AI assistant:
Basic Commands
"List all my n8n workflows"
"Show me details of workflow [workflow-name]"
"Execute my [workflow-name] workflow"
Advanced Commands
"Create a simple webhook workflow"
"Show me failed workflow executions"
"Activate all inactive workflows"
๐ฏ First Workflow Creation
Ask your AI assistant:
"Create a simple n8n workflow that:
1. Triggers every hour
2. Makes an HTTP request to check a website
3. Sends a notification if the site is down"
The AI will create, configure, and activate the workflow for you!
๐ง Common Configuration Issues
"Connection Refused" Error
- Check: n8n instance is running and accessible
- Verify: N8N_HOST URL is correct (include
/api/v1if needed) - Test: Try accessing your n8n instance in a browser
"Unauthorized" Error
- Check: API key is valid and not expired
- Verify: API key has proper permissions
- Test: Create a new API key if needed
"Server Won't Start" Error
- Check: Node.js version (must be 18+)
- Try:
npm cache clean --force - Reinstall:
npm uninstall -g @makafeli/n8n-workflow-builder && npm install -g @makafeli/n8n-workflow-builder
๐ Next Steps
- Explore Use Cases: Check out USE_CASES.md for real-world examples
- Learn Advanced Features: Read the main README.md for all available tools
- Troubleshooting: See TROUBLESHOOTING.md for detailed help
- Compare Solutions: Review COMPARISON.md to understand advantages
๐ก Pro Tips
- Start Simple: Begin with listing and viewing workflows before creating new ones
- Use Natural Language: Describe what you want in plain English
- Iterate: Ask the AI to modify workflows based on your feedback
- Backup: Always test new workflows before using them in production
- Monitor: Use execution monitoring to track workflow performance
๐ Need Help?
- Documentation: Full README
- Issues: GitHub Issues
- Community: n8n Community
- MCP Docs: Model Context Protocol
Ready to automate? Start with "List my workflows" and let AI take over! ๐