yangjifangruby/n8n-mcp-server
3.2
If you are the rightful owner of n8n-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
N8N MCP Server is a server based on the Model Context Protocol (MCP) that connects the N8N workflow automation platform with Trae AI agents.
Tools
4
Resources
0
Prompts
0
N8N MCP Server
项目介绍
N8N MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,用于连接 N8N 工作流自动化平台与 Trae AI 智能体。通过 MCP 协议,AI 智能体可以直接操作 N8N 工作流,实现自动化任务的创建、管理和执行。
主要功能
- 🔗 MCP 协议支持:实现标准的 Model Context Protocol 接口
- 🚀 N8N 集成:完整的 N8N API 客户端,支持工作流操作
- 📋 工作流管理:获取、创建、执行和管理 N8N 工作流
- 🔧 RESTful API:提供 HTTP 接口用于健康检查和工具列表
- 🐳 Docker 支持:容器化部署,易于扩展和维护
- 🔒 安全认证:支持 N8N API Key 认证
技术架构
┌─────────────────┐ MCP Protocol ┌─────────────────┐ N8N API ┌─────────────────┐
│ Trae AI │ ◄─────────────────► │ MCP Server │ ◄────────────► │ N8N Platform │
│ 智能体 │ │ │ │ 工作流平台 │
└─────────────────┘ └─────────────────┘ └─────────────────┘
核心组件
- MCP Server (
src/mcp-server.js
):实现 MCP 协议的服务器端 - N8N Client (
src/n8n-client.js
):N8N API 客户端封装 - Express Server (
src/server.js
):HTTP 服务器,提供健康检查等接口 - Test Connection (
src/test-connection.js
):连接测试工具
安装部署
环境要求
- Node.js 18+
- N8N 实例(本地或远程)
本地安装
-
克隆项目
git clone https://gitee.com/yangjifangruby/n8n-mcp-server.git cd n8n-mcp-server
-
安装依赖
npm install
-
配置环境变量
cp .env.example .env # 编辑 .env 文件,配置 N8N 连接信息
-
启动服务
npm start # 生产模式 npm run dev # 开发模式(热重载) npm test # 测试连接 npm run mcp # 仅启动 MCP 服务器
Docker 部署
-
构建镜像
docker build -t n8n-mcp-server .
-
运行容器
docker run -d \ --name n8n-mcp-server \ -p 3000:3000 \ -e N8N_BASE_URL=http://your-n8n-instance:5678 \ -e N8N_API_KEY=your-api-key \ n8n-mcp-server
使用说明
环境变量配置
变量名 | 描述 | 默认值 | 必需 |
---|---|---|---|
N8N_BASE_URL | N8N 实例地址 | http://localhost:5678 | 否 |
N8N_API_KEY | N8N API 密钥 | - | 是 |
PORT | 服务端口 | 3000 | 否 |
MCP 工具列表
服务器提供以下 MCP 工具:
list_workflows
:获取工作流列表create_simple_workflow
:创建简单工作流execute_workflow
:执行工作流get_workflow_executions
:获取执行历史
API 接口
GET /health
:健康检查GET /mcp/tools
:获取 MCP 工具列表
连接测试
npm test
开发指南
项目结构
n8n-mcp-server/
├── src/
│ ├── mcp-server.js # MCP 协议服务器
│ ├── n8n-client.js # N8N API 客户端
│ ├── server.js # Express HTTP 服务器
│ └── test-connection.js # 连接测试工具
├── Dockerfile # Docker 构建文件
├── docker-compose.yml # Docker Compose 配置
├── package.json # 项目配置
└── README.md # 项目文档
添加新的 MCP 工具
- 在
src/mcp-server.js
中的tools/list
处理器添加工具定义 - 在
tools/call
处理器中添加工具实现 - 在
src/n8n-client.js
中添加对应的 N8N API 调用方法
参与贡献
- Fork 本仓库
- 创建特性分支 (
git checkout -b feature/AmazingFeature
) - 提交更改 (
git commit -m 'Add some AmazingFeature'
) - 推送到分支 (
git push origin feature/AmazingFeature
) - 创建 Pull Request
许可证
本项目采用 MIT 许可证 - 查看 文件了解详情。
相关链接
支持
如果您在使用过程中遇到问题,请:
- 查看 Issues 中是否有类似问题
- 创建新的 Issue 描述您的问题
- 联系项目维护者