工作流集成工具

该工具通过Model Context Protocol (MCP)集成Cursor和Codex与n8n实例,简化团队工作流程的创建和管理。

  • by taylordamaceno
  • Shell
  • 本地部署
  • 更新于
在 GitHub 查看 taylordamaceno/n8n_mcp_workflows

使用说明

MCP n8n+光标+代码

Visao geral

此存储库集中了模型上下文协议 (MCP) 配置,以便将光标和编解码器与 n8n 实例集成。这个想法是简化团队的入职:一个单一的指南涵盖了从n8n的升级到与MCP客户的连接。此外,该项目还作为文档、操作规则和辅助脚本的版本化基础。

关于仓库

  • 它作为一个集合的脚本,MCP清单和共享规则,旨在通过Cursor和Codex使用n8n。
  • 这些文件旨在被任何团队成员快速克隆和适应。
  • 所有内容都避免暴露真实的秘密;在贡献时保持相同的态度。
  • 允许您从 Cursor 或 Codex 发送的自然语言提示符创建和编排 n8n 工作流。

最低要求

  • 启用 MCP 支持的光标 。
  • 已安装的 CLI 编码(如果使用终端流)。
  • Node.js 18 或更高版本以运行软件包 n8n-mcp 通过 npx 或全局安装。
  • 可访问的 n8n 实例,具有基础 URL 和有效的 API 密钥。
  • 设置本地环境变量和编辑文件的权限 ~/.bashrc (或等效)

项目结构

  • .cursor/mcp.json: 光标消耗的 MCP 服务器配置(未版本化;下面的示例)。
  • rules/n8n-mcp.mdc指导两个客户端的 MCP 代理的可选指令。
  • docker-compose.ymln8n的本地堆栈示例,具有默认卷和定义。
  • setup_n8n.sh:引导Linux com Nginx的脚本,让我们加密基本身份验证。

环境变量

在打开 Cursor 或 Codex 之前设置变量,以避免在文件中暴露密钥。

export N8N_API_URL="https://seu-n8n.example.com"
export N8N_API_KEY="SEU_TOKEN_GERADO_NO_N8N"
  • 为每个环境(生产、认证、本地)调整上述值。
  • 将秘密存放在适当的保险箱或管理员中;永远不要承诺真正的价值观。
  • 添加到 RC shell (例如 ~/.bashrc只有当计算机是个人计算机并且变量受到保护时。

配置无光标

  1. 确保工作区有一个文件夹 .cursor/ (版本)。添加到 .gitignore 如果还没有:
    echo ".cursor/mcp.json" >> .gitignore
    
  2. 创建文件 .cursor/mcp.json 指向服务器 n8n-mcp:
    cat > .cursor/mcp.json <<'EOF'
    {
      "mcpServers": {
        "n8n-mcp": {
          "command": "npx",
          "args": ["n8n-mcp"],
          "env": {
            "MCP_MODE": "stdio",
            "LOG_LEVEL": "error",
            "DISABLE_CONSOLE_OUTPUT": "true",
            "N8N_API_URL": "${N8N_API_URL}",
            "N8N_API_KEY": "${N8N_API_KEY}"
          }
        }
      }
    }
    EOF
    
  3. 在仓库中打开光标,然后 Settings > MCP请确认服务器 n8n-mcp 出现在名单上。
  4. 使用简单的提示进行测试,例如: Use o provedor n8n-mcp para listar workflows disponiveis.
  5. 如果需要调试,请更改 LOG_LEVEL 段落 info 然后查看 Cursor 的 MCP 面板。

食品法典委员会

  1. 设置环境变量后,注册 MCP 服务器:
    codex mcp add n8n-mcp \
      --env MCP_MODE=stdio \
      --env LOG_LEVEL=error \
      --env DISABLE_CONSOLE_OUTPUT=true \
      --env N8N_API_URL=$N8N_API_URL \
      --env N8N_API_KEY=$N8N_API_KEY \
      -- npx n8n-mcp
    
  2. 检查注册 :
    codex mcp list
    
  3. 要使用此仓库的规则文件,请根据您的计算机设置路径:
    codex --cd /home/taylao/n8n_mcp_workflows \
      --config experimental_instructions_file='"/home/taylao/n8n_mcp_workflows/rules/n8n-mcp.mdc"'
    
  4. 要永久化,请编辑 ~/.codex/config.toml 定义:
    experimental_instructions_file = "/home/taylao/n8n_mcp_workflows/rules/n8n-mcp.mdc"
    
  5. 执行一个简单的命令(例如: tools_documentation()验证与 MCP 的通信。

共享规则(rules/n8n-mcp.mdc)

文件 .mdc 包含操作指南(工作流命名、验证、标签)。在每台机器上复制或引用此文件以标准化交互。随着团队发展惯例,更新内容。

做n8n的规定

  • 使用 docker-compose.yml 快速上传本地n8n与卷 /home/taylao/mcpn8n/local_n8n/.
  • 执行 setup_n8n.sh 在Linux服务器上,如果您需要安装Nginx,HTTPS(让我们加密)和基本身份验证保护。
  • 总是替换 DOMAIN, EMAIL 和脚本凭据在运行前的实际环境值。

Como subir on 8n

Ambiente本地com Docker编写

  1. 调整音量或变量内 docker-compose.yml 根据你的目录。
  2. 上传容器 :
    docker compose up -d
    
  3. 请检查日志以确认应用程序启动没有错误:
    docker compose logs -f n8n
    
  4. 当您需要关闭:
    docker compose down
    

Servidor Linux(Nginx+HTTPS)

  1. 阿布拉 setup_n8n.sh 个性化 DOMAIN, EMAIL e BASIC_USER 与他们的价值观。
  2. 以 root 或 via 身份运行脚本 sudo:
    sudo bash setup_n8n.sh
    
  3. 脚本在下面创建目录 /opt/n8n上传容器,使用Basic Auth配置Nginx并自动请求Lets Encrypt证书。
  4. 最后,验证在终端上打印的建议测试(HTTP/HTTPS重定向,身份验证和容器日志)。

良好安全实践

  • 从不注册 N8N_API_KEY版本化文件中的密码或令牌。
  • 使用环境变量或保险箱(例如 1Password、Vault、Secrets Manager)来保密。
  • 在不再使用时,从 n8n 面板中撤销旧密钥。
  • 限制对服务器(防火墙,VPN)的访问,并保持可审计的日志。

故障排除

  • curl -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/rest/workflows" 在API中测试直接连接。
  • 如果 Cursor 或 Codex 没有列出服务器,请确认工作区路径和 JSON 语法。 mcp.json.
  • 认证错误通常表明当前的 shell 中没有装入无效或变量密钥 。
  • 调整 LOG_LEVEL 段落 info 在命令/文件中,并观察发出的日志 n8n-mcp.

快速清单

  • []水痘 N8N_API_URL e N8N_API_KEY 只出口到当地环境。
  • [ ] .cursor/mcp.json 由 Git 创建并忽略。
  • [ ] codex mcp add n8n-mcp 执行(如果使用 Codex)。
  • [ ] 档案 rules/n8n-mcp.mdc 参考工具。
  • [ ] 此仓库中没有存储实际密钥或密码 。