n8n MCP 工具

这是一个用于 n8n API 集成的 Model Context Protocol (MCP) 服务器实现。该项目通过 MCP 协议实现了 n8n 工作流与 AI 助手之间的无缝集成。

特性

• 完整实现 n8n 的公共 API (v1.1.1)
• 为所有 API 端点提供 MCP 工具
• 带有 Swagger 文档的 RESTful API 服务器
• 可扩展的模块化架构
• 认证中间件

结构

项目组织如下：

• api/endpoints/: 每种资源类型的 API 端点实现
• api/schemas/: 数据模型模式定义
• api/tools/: 每种资源类型的 MCP 工具实现
• api/index.js: 主服务器入口点
• api/config.js: 配置设置

开始使用

先决条件

• Node.js (版本 14 或更高)
• npm 或 yarn
• 一个带有 API 密钥的 n8n 实例

安装

作为包安装

# Install globally
npm install -g n8n-mcp-tools

# Create a .env file in your working directory
echo "N8N_API_BASE_URL=https://your-n8n-instance.com/api/v1
N8N_API_KEY=your-api-key
PORT=3000" > .env

# Start the MCP server
n8n-mcp-server

从源代码安装

1. 克隆仓库：

   git clone https://github.com/yourusername/n8n-mcp-tools.git
   cd n8n-mcp-tools
   

2. 安装依赖项：

   npm install
   

3. 创建一个 .env 文件并填写你的配置信息：

   N8N_API_BASE_URL=https://your-n8n-instance.com/api/v1
   N8N_API_KEY=your-api-key
   PORT=3000
   

4. 启动服务器：

   npm start
   

5. 访问 API 文档：

   http://localhost:3000/api-docs
   

MCP 工具

MCP 工具使 AI 助手能够通过自然语言与 n8n 交互。以下是一些示例工具：

用户工具

• get-users: 从 n8n 实例获取所有用户
• get-user: 根据 ID 或电子邮件获取特定用户
• create-users: 创建一个或多个用户
• delete-user: 根据 ID 或电子邮件删除用户
• change-user-role: 更改用户的全局角色

工作流工具

• get-workflows: 从 n8n 实例获取所有工作流
• get-workflow: 根据 ID 获取特定工作流
• create-workflow: 创建新工作流
• update-workflow: 更新现有工作流
• delete-workflow: 根据 ID 删除工作流
• activate-workflow: 激活工作流
• deactivate-workflow: 停用工作流
• get-workflow-tags: 获取工作流标签
• update-workflow-tags: 更新工作流标签
• transfer-workflow: 将工作流转移到另一个项目

还有更多针对凭证、执行、标签、变量、项目和审计功能的工具。

配置

可以通过环境变量或修改 api/config.js 来配置服务器：

• N8N_API_BASE_URL: n8n API 的基础 URL
• N8N_API_KEY: 用于身份验证的 API 密钥
• PORT: 服务器运行的端口
• HOST: 服务器绑定的主机
• LOG_LEVEL: 日志级别（info, error, debug）
• MCP_SOCKET_PATH: MCP 套接字的路径（用于 STDIO 传输）
• MCP_USE_TCP: 是否使用 TCP 进行 MCP 传输
• MCP_TCP_PORT: MCP 传输的 TCP 端口
• MCP_TCP_HOST: MCP 传输的 TCP 主机

许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

发布

如果您正在为这个包做贡献并需要发布新版本：

1. 更新 package.json 中的版本：

   npm version patch  # 用于修复 bug
   npm version minor  # 用于新增功能
   npm version major  # 用于破坏性变更
   

2. 发布到 npm：

   npm publish
   

3. postversion 脚本会自动将新版本推送到 GitHub。

贡献

欢迎贡献！详情请参阅我们的 贡献指南。

变更日志

有关每个版本的更改详情，请参阅 CHANGELOG.md 文件。