🚀 n8n-mcp-server
n8n-mcp-server 是一个为 n8n 工作流自动化量身打造的 Model-Controller-Provider (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
# 编辑 .env 文件以设置您的配置
📚 详细文档
配置说明
通过环境变量对服务器进行配置。请查看 .env.example 了解所有可用选项。所需环境变量如下：
| 属性 | 详情 |
|---|---|
| N8N_URL | n8n 实例 API 的 URL |
| N8N_API_KEY | 您的 n8n API 密钥 |
| N8N_API_HEADER | API 密钥的头名称（默认：X-N8N-API-KEY） |
使用说明
启动服务器
提供多种启动选项：
# 标准启动
npm start
# 开发模式，带有热重载
npm run start:dev
# 简单模式（功能最少）
npm run start:simple
# 调试模式
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.md 了解详细 API 文档。
开发说明
从源代码构建
npm run build
运行测试
npm test
格式检查
npm run lint
贡献说明
- 叉克隆仓库
- 创建功能分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m '添加一些精彩的特性') - 推送到分支 (
git push origin feature/amazing-feature) - 提交 Pull Request
📄 许可证
该项目在 MIT 许可证下发行——请查看 LICENSE 文件以获取详细信息。
支持
如需支持，请在 GitHub 仓库中打开一个问题。