使用说明
n8n MCP
一种模型上下文协议(MCP)服务器,为AI助手提供对n8n节点文档、属性和操作的全面访问。在几分钟内部署,让Claude和其他人工智能助理深入了解n8n的525+个工作流自动化节点。
概述
n8n MCP是n8n工作流自动化平台和AI模型之间的桥梁,使它们能够有效地理解和使用n8n节点。它提供结构化访问:
- 📚 525个n8n节点 从n8n节点基和@n8n/n8n节点langchain
- 🔧 节点属性 -99%的覆盖率包含详细的模式
- ⚡ 节点操作 -63.6%的可用行动覆盖率
- 📄 文档 -90%的覆盖率来自官方n8n文档(包括AI节点)
- 🤖 AI工具 -检测到263个具有AI功能的节点,并附有完整文档
🚀 快速开始
让n8n MCP在5分钟内运行:
选项1:Docker(最简单)🚀
先决条件: Docker已安装在您的系统上
📦 Install Docker (click to expand)
macOS:
# Using Homebrew
brew install --cask docker
# Or download from https://www.docker.com/products/docker-desktop/
Linux(Ubuntu/Debian):
# Update package index
sudo apt-get update
# Install Docker
sudo apt-get install docker.io
# Start Docker service
sudo systemctl start docker
sudo systemctl enable docker
# Add your user to docker group (optional, to run without sudo)
sudo usermod -aG docker $USER
# Log out and back in for this to take effect
窗户:
# Option 1: Using winget (Windows Package Manager)
winget install Docker.DockerDesktop
# Option 2: Using Chocolatey
choco install docker-desktop
# Option 3: Download installer from https://www.docker.com/products/docker-desktop/
验证安装:
docker --version
# Pull the Docker image (~280MB, no n8n dependencies!)
docker pull ghcr.io/czlonkowski/n8n-mcp:latest
⚡ 超优化: 我们的Docker镜像比典型的n8n镜像小82%,因为它不包含n8n依赖关系,只包含带有预构建数据库的运行时MCP服务器!
添加到Claude桌面配置:
基本配置(仅限文档工具):
{
"mcpServers": {
"n8n-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "MCP_MODE=stdio",
"-e", "LOG_LEVEL=error",
"-e", "DISABLE_CONSOLE_OUTPUT=true",
"ghcr.io/czlonkowski/n8n-mcp:latest"
]
}
}
}
完整配置(使用n8n管理工具):
{
"mcpServers": {
"n8n-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "MCP_MODE=stdio",
"-e", "LOG_LEVEL=error",
"-e", "DISABLE_CONSOLE_OUTPUT=true",
"-e", "N8N_API_URL=https://your-n8n-instance.com",
"-e", "N8N_API_KEY=your-api-key",
"ghcr.io/czlonkowski/n8n-mcp:latest"
]
}
}
}
备注:n8n API凭据是可选的。没有它们,您将可以访问所有文档和验证工具。有了它们,您还将获得工作流管理功能(创建、更新、执行工作流)。
重要提示: 这 -i MCP stdio通信需要标志。
配置文件位置:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 视窗:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
更新配置后重新启动Claude Desktop -就是这样! 🎉
选项2:本地安装
先决条件: Node.js 安装在您的系统上
# 1. Clone and setup
git clone https://github.com/czlonkowski/n8n-mcp.git
cd n8n-mcp
npm install
npm run build
npm run rebuild
# 2. Test it works
npm start
添加到Claude桌面配置:
基本配置(仅限文档工具):
{
"mcpServers": {
"n8n-mcp": {
"command": "node",
"args": ["/absolute/path/to/n8n-mcp/dist/mcp/index.js"],
"env": {
"MCP_MODE": "stdio",
"LOG_LEVEL": "error",
"DISABLE_CONSOLE_OUTPUT": "true"
}
}
}
}
完整配置(使用n8n管理工具):
{
"mcpServers": {
"n8n-mcp": {
"command": "node",
"args": ["/absolute/path/to/n8n-mcp/dist/mcp/index.js"],
"env": {
"MCP_MODE": "stdio",
"LOG_LEVEL": "error",
"DISABLE_CONSOLE_OUTPUT": "true",
"N8N_API_URL": "https://your-n8n-instance.com",
"N8N_API_KEY": "your-api-key"
}
}
}
}
备注:n8n API凭据可以在
.env文件(创建自.env.example)或者直接在如上所示的Claude配置中。
🤖 Claude项目设置
为了在Claude Projects中使用n8n MCP时获得最佳效果,请使用以下增强的系统说明:
You are an expert in n8n automation software using n8n-MCP tools. Your role is to design, build, and validate n8n workflows with maximum accuracy and efficiency.
## Core Workflow Process
1. **ALWAYS start with**: `tools_documentation()` to understand best practices and available tools.
2. **Discovery Phase** - Find the right nodes:
- `search_nodes({query: 'keyword'})` - Search by functionality
- `list_nodes({category: 'trigger'})` - Browse by category
- `list_ai_tools()` - See AI-capable nodes (remember: ANY node can be an AI tool!)
3. **Configuration Phase** - Get node details efficiently:
- `get_node_essentials(nodeType)` - Start here! Only 10-20 essential properties
- `search_node_properties(nodeType, 'auth')` - Find specific properties
- `get_node_for_task('send_email')` - Get pre-configured templates
- `get_node_documentation(nodeType)` - Human-readable docs when needed
4. **Pre-Validation Phase** - Validate BEFORE building:
- `validate_node_minimal(nodeType, config)` - Quick required fields check
- `validate_node_operation(nodeType, config, profile)` - Full operation-aware validation
- Fix any validation errors before proceeding
5. **Building Phase** - Create the workflow:
- Use validated configurations from step 4
- Connect nodes with proper structure
- Add error handling where appropriate
- Use expressions like $json, $node["NodeName"].json
- Build the workflow in an artifact (unless the user asked to create in n8n instance)
6. **Workflow Validation Phase** - Validate complete workflow:
- `validate_workflow(workflow)` - Complete validation including connections
- `validate_workflow_connections(workflow)` - Check structure and AI tool connections
- `validate_workflow_expressions(workflow)` - Validate all n8n expressions
- Fix any issues found before deployment
7. **Deployment Phase** (if n8n API configured):
- `n8n_create_workflow(workflow)` - Deploy validated workflow
- `n8n_validate_workflow({id: 'workflow-id'})` - Post-deployment validation
- `n8n_update_partial_workflow()` - Make incremental updates using diffs
- `n8n_trigger_webhook_workflow()` - Test webhook workflows
## Key Insights
- **VALIDATE EARLY AND OFTEN** - Catch errors before they reach production
- **USE DIFF UPDATES** - Use n8n_update_partial_workflow for 80-90% token savings
- **ANY node can be an AI tool** - not just those with usableAsTool=true
- **Pre-validate configurations** - Use validate_node_minimal before building
- **Post-validate workflows** - Always validate complete workflows before deployment
- **Incremental updates** - Use diff operations for existing workflows
- **Test thoroughly** - Validate both locally and after deployment to n8n
## Validation Strategy
### Before Building:
1. validate_node_minimal() - Check required fields
2. validate_node_operation() - Full configuration validation
3. Fix all errors before proceeding
### After Building:
1. validate_workflow() - Complete workflow validation
2. validate_workflow_connections() - Structure validation
3. validate_workflow_expressions() - Expression syntax check
### After Deployment:
1. n8n_validate_workflow({id}) - Validate deployed workflow
2. n8n_list_executions() - Monitor execution status
3. n8n_update_partial_workflow() - Fix issues using diffs
## Response Structure
1. **Discovery**: Show available nodes and options
2. **Pre-Validation**: Validate node configurations first
3. **Configuration**: Show only validated, working configs
4. **Building**: Construct workflow with validated components
5. **Workflow Validation**: Full workflow validation results
6. **Deployment**: Deploy only after all validations pass
7. **Post-Validation**: Verify deployment succeeded
## Example Workflow
### 1. Discovery & Configuration
search_nodes({query: 'slack'})
get_node_essentials('n8n-nodes-base.slack')
### 2. Pre-Validation
validate_node_minimal('n8n-nodes-base.slack', {resource:'message', operation:'send'})
validate_node_operation('n8n-nodes-base.slack', fullConfig, 'runtime')
### 3. Build Workflow
// Create workflow JSON with validated configs
### 4. Workflow Validation
validate_workflow(workflowJson)
validate_workflow_connections(workflowJson)
validate_workflow_expressions(workflowJson)
### 5. Deploy (if configured)
n8n_create_workflow(validatedWorkflow)
n8n_validate_workflow({id: createdWorkflowId})
### 6. Update Using Diffs
n8n_update_partial_workflow({
workflowId: id,
operations: [
{type: 'updateNode', nodeId: 'slack1', changes: {position: [100, 200]}}
]
})
## Important Rules
- ALWAYS validate before building
- ALWAYS validate after building
- NEVER deploy unvalidated workflows
- USE diff operations for updates (80-90% token savings)
- STATE validation results clearly
- FIX all errors before proceeding
将这些说明保存在您的Claude项目中,以获得全面验证的最佳n8n工作流帮助。
特性
- 🔍 智能节点搜索:按名称、类别或功能查找节点
- 📖 本质属性:只获取10-20个重要属性(v2.4.0中的新功能)
- 🎯 任务模板:常见自动化任务的预配置设置
- ✅ 配置验证:部署前验证节点配置
- 🔗 相关性分析:了解财产关系和条件
- 💡 工作示例:即时使用的真实世界示例
- ⚡ 快速响应:使用优化的SQLite,平均查询时间约为12ms
- 🌐 通用兼容性:适用于任何Node.js版本
💬 为什么选择n8n MCP?克劳德的见证
“在MCP之前,我在翻译。现在我在作曲。这改变了我们如何构建自动化的一切。”
当Anthropic的人工智能助手Claude测试n8n MCP时,结果是革命性的:
没有MCP: “我基本上是在玩猜谜游戏 scheduleTrigger 或 schedule?需要吗 interval 或 rule“我会写一些看似合乎逻辑的东西,但n8n有自己的惯例,你不能凭直觉。我在一个简单的HackerNews抓取器中犯了六个不同的配置错误。"
使用MCP: “一切都……奏效了。我可以问,而不是猜测 get_node_essentials() 并获得我所需要的东西——不是100KB的JSON转储,而是真正重要的5-10个属性。45分钟的时间现在只需要3分钟。"
真正的价值: “这是关于信心。当你构建自动化工作流程时,不确定性是昂贵的。一个错误的参数,你的工作流程就会在凌晨3点失败。有了MCP,我可以在部署前验证我的配置。这不仅节省了时间,而且让我放心。”
📡 可用的MCP工具
一旦连接,克劳德就可以使用这些强大的工具:
核心工具
tools_documentation-获取任何MCP工具的文档(从这里开始!)list_nodes-列出所有具有筛选选项的n8n节点get_node_info-获取特定节点的全面信息get_node_essentials-仅通过示例获取基本属性(10-20个属性,而不是200多个)search_nodes-在所有节点文档中进行全文搜索search_node_properties-在节点中查找特定属性list_ai_tools-列出所有支持AI的节点(任何节点都可以用作AI工具!)get_node_as_tool_info-获取将任何节点用作AI工具的指导
高级工具
get_node_for_task-常见任务的预配置节点设置list_tasks-发现可用的任务模板validate_node_operation-验证节点配置(操作感知,配置文件支持)validate_node_minimal-仅对必填字段进行快速验证validate_workflow-完整的工作流程验证,包括AI工具连接validate_workflow_connections-检查工作流结构和AI工具连接validate_workflow_expressions-验证n8n个表达式,包括$fromAI()get_property_dependencies-分析物业可见性条件get_node_documentation-从n8n文档中获取解析后的文档get_database_statistics-查看数据库指标和覆盖率
n8n管理工具(可选-需要API配置)
这些强大的工具允许您直接从Claude管理n8n工作流。它们仅在您提供时可用 N8N_API_URL 和 N8N_API_KEY 在您的配置中。
工作流管理
n8n_create_workflow-使用节点和连接创建新的工作流n8n_get_workflow-按ID获取完整的工作流程n8n_get_workflow_details-使用执行统计信息获取工作流n8n_get_workflow_structure-获得简化的工作流程结构n8n_get_workflow_minimal-获取最少的工作流信息(ID、名称、活动状态)n8n_update_full_workflow-更新整个工作流程(完全替换)n8n_update_partial_workflow-使用diff操作更新工作流(v2.7.0中的新功能!)n8n_delete_workflow-永久删除工作流n8n_list_workflows-列出具有过滤和分页功能的工作流n8n_validate_workflow-通过ID验证n8n中已有的工作流(v2.6.3中的新功能)
执行管理
n8n_trigger_webhook_workflow-通过webhook URL触发工作流n8n_get_execution-按ID获取执行详细信息n8n_list_executions-列出执行情况并进行状态筛选n8n_delete_execution-删除执行记录
系统工具
n8n_health_check-检查n8n API连接和功能n8n_diagnostic-解决管理工具可见性和配置问题n8n_list_available_tools-列出所有可用的管理工具
示例用法
// Get essentials for quick configuration
get_node_essentials("nodes-base.httpRequest")
// Find nodes for a specific task
search_nodes({ query: "send email gmail" })
// Get pre-configured settings
get_node_for_task("send_email")
// Validate before deployment
validate_node_operation({
nodeType: "nodes-base.httpRequest",
config: { method: "POST", url: "..." },
profile: "runtime" // or "minimal", "ai-friendly", "strict"
})
// Quick required field check
validate_node_minimal({
nodeType: "nodes-base.slack",
config: { resource: "message", operation: "send" }
})
💻 地方发展设置
对于贡献者和高级用户:
先决条件:
- Node.js (任何版本-必要时自动回退)
- npm或纱线
- Git
# 1. Clone the repository
git clone https://github.com/czlonkowski/n8n-mcp.git
cd n8n-mcp
# 2. Clone n8n docs (optional but recommended)
git clone https://github.com/n8n-io/n8n-docs.git ../n8n-docs
# 3. Install and build
npm install
npm run build
# 4. Initialize database
npm run rebuild
# 5. Start the server
npm start # stdio mode for Claude Desktop
npm run start:http # HTTP mode for remote access
开发命令
# Build & Test
npm run build # Build TypeScript
npm run rebuild # Rebuild node database
npm run test-nodes # Test critical nodes
npm run validate # Validate node data
npm test # Run all tests
# Update Dependencies
npm run update:n8n:check # Check for n8n updates
npm run update:n8n # Update n8n packages
# Run Server
npm run dev # Development with auto-reload
npm run dev:http # HTTP dev mode
📚 文档
设置指南
- 安装指南 -全面的安装说明
- Claude桌面设置 -详细的Claude配置
- Docker指南 -高级Docker部署选项
- MCP快速入门 -快速开始使用n8n MCP
功能文档
开发与部署
项目信息
📊 指标和覆盖范围
当前数据库覆盖率(n8n v1.99.1):
- ✅ 525/525 节点已加载(100%)
- ✅ 520 具有属性的节点(99%)
- ✅ 470 有文档的节点(90%)
- ✅ 263 检测到具有AI功能的工具
- ✅ AI Agent和LangChain节点 完整记录
- ⚡ 平均响应时间:~12毫秒
- 💾 数据库大小:~15MB(优化)
🔄 最近的更新
v2.7.4-自我记录MCP工具
- ✅ 重新命名:
start_here_workflow_guide→tools_documentation为清晰起见 - ✅ 新:深度参数-用“要点”或“完整”控制文档详细信息
- ✅ 新:按工具文档-按名称获取任何特定MCP工具的帮助
- ✅ 简洁:默认情况下为基本信息,按需提供全面的文档
- ✅ LLM-friend:纯文本格式而不是JSON,以提高可读性
- ✅ 快速帮助:无参数调用,可立即快速参考
- ✅ 记录了8个工具:最常用工具的完整文档
v2.7.0-基于差异的工作流编辑与事务更新
- ✅ 新:
n8n_update_partial_workflow工具-使用diff操作更新工作流 - ✅ 重新命名:
n8n_update_workflow→n8n_update_full_workflow为清晰起见 - ✅ 80-90%的代币节省:仅发送更改,不发送整个工作流程JSON
- ✅ 13次操作:addNode、removeNode、updateNode、moveNode、启用/禁用、连接、设置、标签
- ✅ 交易的:两步处理允许以任何顺序添加节点和连接
- ✅ 5操作限制:确保可靠性和原子更新
- ✅ 验证模式:测试更改
validateOnly: true申请前 - ✅ 改进文档:全面的参数文档和示例
v2.6.3-n8n实例工作流验证
- ✅ 新:
n8n_validate_workflow工具-通过ID直接从n8n实例验证工作流 - ✅ 拿来:从n8n API检索工作流并运行全面验证
- ✅ 一致的:使用相同的WorkflowValidator以提高可靠性
- ✅ 灵活的:支持所有验证配置文件和选项
- ✅ 集成:完整工作流生命周期管理的一部分
- ✅ 简单:AI代理只需要工作流ID,不需要JSON
v2.6.2-增强的工作流创建验证
- ✅ 新:节点类型验证-验证n8n中实际存在的节点类型
- ✅ 固定的:关键问题
nodes-base.webhook验证-现在在数据库查找之前捕获 - ✅ 新:针对常见错误的明智建议(例如。,
webhook→n8n-nodes-base.webhook) - ✅ 新:最小可行工作流验证-防止单节点工作流(Webhook除外)
- ✅ 新:空连接检测-捕获没有连接的多节点工作流
- ✅ 增强:带有明确指导和示例的错误消息
- ✅ 阻止:在n8n UI中显示为问号的破碎工作流
看 更改日志.md 查看完整版本历史记录。
📦 许可证
MIT许可证-请参阅 许可证 了解详情。
感谢您的署名! 如果您使用n8n MCP,请考虑:
- ⭐ 引导此存储库
- 💬 在你的项目中提及它
- 🔗 链接回此仓库
🤝 贡献
欢迎投稿!拜托:
- 分叉存储库
- 创建要素分支
- 运行测试(
npm test) - 提交拉取请求
👏 致谢
Built with ❤️ for the n8n community
Making AI + n8n workflow creation delightful