项目简介
'n8n-mcp-server-custom' 是一个基于 Model Context Protocol (MCP) 的自定义服务器,它允许大型语言模型 (LLM) 客户端(如Antigravity AI助手)通过一套标准化的工具接口,与 n8n 自动化平台进行深度交互和控制。
该项目旨在解决官方 n8n MCP 服务器与特定LLM客户端的兼容性问题,并提供了27个基于 n8n REST API 的核心工具,覆盖工作流管理、执行、变量、凭证等多个方面。通过部署此服务器,你的AI助手将能够像控制台一样管理你的 n8n 实例。
主要功能点
- 27项 n8n 工具集成: 提供对 n8n 实例的全面控制,包括工作流的创建、读取、更新、删除、执行、激活/停用,以及对执行记录、环境变量、凭证、节点类型、标签和系统信息的管理。
- 为 Antigravity 优化: 专为 Antigravity AI 助手设计和测试,解决了官方服务器存在的 EOF 错误,确保了无缝兼容性。
- 安全认证: 支持基于 API 密钥的身份验证,不将敏感凭证硬编码在代码中,通过环境变量安全配置。
- 易于部署: 基于 Node.js 和 TypeScript 构建,提供清晰的安装、配置和运行指南。
- JSON-RPC 通信: 通过标准 JSON-RPC 协议与 LLM 客户端通信,确保互操作性。
安装步骤
在本地计算机上安装并启动这个 MCP 服务器,以便你的 AI 客户端可以连接它:
-
克隆仓库: 打开终端或命令行工具,运行以下命令:
git clone https://github.com/burnham/n8n-mcp-server-custom.git cd n8n-mcp-server-custom -
安装依赖: 进入项目目录后,安装所有必需的程序包:
npm install -
配置环境变量:
- 复制 '.env.example' 文件为 '.env':
cp .env.example .env - 编辑新创建的 '.env' 文件,填入你的 n8n 实例的 URL 和 API 密钥。例如:
N8N_API_URL=https://your-instance.n8n.cloud N8N_API_KEY=your_api_key_here- 'N8N_API_URL' 是你的 n8n 实例的访问地址,请确保没有末尾斜杠。
- 'N8N_API_KEY' 是你在 n8n 实例中“设置 (Settings)” -> “API” 部分生成的 API 密钥。
- 复制 '.env.example' 文件为 '.env':
-
编译项目: 运行以下命令编译 TypeScript 代码:
npm run build这将生成一个 'dist' 文件夹,其中包含可执行的 JavaScript 文件。
服务器配置 (供MCP客户端使用)
MCP客户端(如 Antigravity)需要配置此 MCP 服务器的启动命令和参数才能与其建立连接。以下是一个配置示例,您需要根据自己的 MCP 客户端的配置方式进行调整,例如在 Antigravity 的 'mcp_config.json' 文件中:
{ "mcpServers": { "n8n-mcp": { "command": "node", "args": ["/absolute/path/to/n8n-mcp-server-custom/dist/index.js"], "env": { "N8N_API_URL": "https://your-instance.n8n.cloud", "N8N_API_KEY": "your_api_key_here" } } } }
- 'n8n-mcp': 这是你在 MCP 客户端中为此服务器定义的唯一名称。
- 'command': 用于启动 MCP 服务器的可执行程序,通常是 'node'。
- 'args': 传递给 'command' 的参数列表,这里是编译后的服务器主文件 'dist/index.js' 的绝对路径。请务必将 '/absolute/path/to/n8n-mcp-server-custom/' 替换为你实际的项目路径。
- 'env': 环境变量,用于配置 n8n 实例的连接信息。
- 'N8N_API_URL': 你的 n8n 实例的完整 URL,例如 'https://my.n8n.cloud'。
- 'N8N_API_KEY': 你的 n8n API 密钥。
基本使用方法
配置完成后,你的 LLM 客户端(如 Antigravity)将能够通过 MCP 协议与这个 n8n MCP 服务器通信。
- 启动你的 MCP 客户端: 客户端会自动尝试连接并初始化配置的 MCP 服务器。
- AI 调用 n8n 工具: 在 LLM 客户端的交互界面中,AI 将能够识别并调用此服务器提供的27个 n8n 工具。例如,你可以通过自然语言指示 AI “列出所有 n8n 工作流”或“创建一个名为 '每日报告' 的新工作流”。
- 监控 n8n 实例: 通过 AI 助手,你可以查询 n8n 实例的健康状态、版本信息、工作流执行情况等。
信息
分类
开发者工具