关于 n8n-mcp-server
n8n-mcp-server 为 MCP 客户端提供执行和管理 n8n 工作流的接口,采用 JSON-RPC 2.0,并通过环境变量配置。
主要功能
- 01JSON-RPC 2.0 API
- 02执行和管理工作流
- 03基于环境变量配置
- 04日志记录
- 05Docker 支持
适用场景
- 01通过 MCP 客户端运行 n8n 工作流
- 02通过 MCP 客户端管理工作流
MCP 相关
它通过 JSON-RPC 2.0 向 MCP 客户端提供 n8n 工作流工具,支持列出和调用工具。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
还没有获取到工具列表
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
n8n-mcp-server
用于 n8n 工作流自动化的模型-控制器-提供者(MCP)服务实现。此服务通过 JSON-RPC 协议提供标准化接口,用于执行和管理 n8n 工作流。
功能
- 符合 JSON-RPC 2.0 标准的 API
- 工作流执行和管理
- 基于环境变量的配置
- 支持 TypeScript
- 全面的日志记录
- 支持 Docker
前提条件
- Node.js >= 14.0.0
- 正在运行且可访问的 n8n 实例
- n8n API 密钥
安装
- 克隆代码仓库:
git clone https://github.com/S17S17/n8n-mcp-server.git
cd n8n-mcp-server
- 安装依赖:
npm install
- 配置环境变量:
cp .env.example .env
# Edit .env with your configuration
配置
可通过环境变量配置此服务。所有可用选项请参见 .env.example。
必需的环境变量:
N8N_URL:n8n 实例 API 的 URLN8N_API_KEY:你的 n8n API 密钥N8N_API_HEADER:API 密钥的请求头名称(默认值:X-N8N-API-KEY)
使用方法
启动服务
有多种启动方式可供选择:
# Standard start
npm start
# Development mode with hot reload
npm run start:dev
# Simple mode (minimal features)
npm run start:simple
# Debug mode
npm run debug
Docker 支持
使用 Docker 构建并运行:
docker build -t n8n-mcp-server .
docker run -p 3000:3000 --env-file .env n8n-mcp-server
或使用 Docker Compose:
docker-compose up
API 文档
此服务实现了 JSON-RPC 2.0 接口,包含以下方法:
initialize:初始化服务连接shutdown:正常关闭服务listTools:列出可用的工作流工具callTool:执行指定的工作流工具
详细的 API 文档请参见 API.md。
开发
从源代码构建
npm run build
运行测试
npm test
代码检查
npm run lint
参与贡献
- Fork 此代码仓库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交更改(
git commit -m 'Add some amazing feature') - 将分支推送到远程仓库(
git push origin feature/amazing-feature) - 发起 Pull Request
许可证
此项目基于 MIT 许可证授权,详情请参见 LICENSE 文件。
支持
如需支持,请在 GitHub 代码仓库中提交 issue。
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。