n8n MCP 工具

用于 n8n API 集成的模型上下文协议 (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（v14 或更高版本）
• npm 或 yarn
• 具有 API 密钥的 n8n 实例

安装

作为一个包

从源头

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 ：日志级别（信息、错误、调试）
• 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 # for bug fixes npm version minor # for new features npm version major # for breaking changes
2. 发布到 npm：
   npm publish
3. postversion 脚本会自动将新版本推送到 GitHub。

贡献

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

变更日志

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