N8n Workflow Validator

🚀 n8n 主控服务器（MCP）

本项目为 n8n 打造了主控服务器（Master Control Program），提供一系列工具用于验证工作流，助您遵循最佳实践，优化自动化项目。

🚀 快速开始

先决条件

• Node.js (v16 或更高版本)
• pnpm (v7 或更高版本)
• 一个 n8n 实例（本地或远程，例如您在 Cloudron 上的实例，地址为 n8n.bienquoi.com）

安装

1. 克隆此仓库或导航到项目目录。
2. 安装依赖项：

pnpm install

3. 配置环境变量：

cp .env.example .env

修改 .env 文件中的内容以反映您连接到 n8n API 的信息。

使用

构建项目

pnpm build

启动服务器

pnpm start

主控服务器将可通过地址 http://localhost:3000 访问（或在 .env 文件中指定的端口）。

与 Claude Desktop 结合使用

要将此 MCP 服务器与 Claude Desktop 配合使用，请配置 %APPDATA%/Claude/ 目录中的 claude_desktop_config.json 文件：

{
  "mcpServers": {
    "n8n-mcp-server": {
      "command": "node",
      "args": ["/绝对路径/mcp-n8n-server/dist/server.js"]
    }
  }
}

✨ 主要特性

• 工作流验证：检查您的工作流是否符合最佳实践，涵盖命名约定、错误处理、安全性、性能和文档等方面。
• NextJS 集成：为您的 n8n 工作流生成 NextJS 应用程序的集成，包括自动生成 API 路由、创建 OpenAPI/Swagger 文档、自动生成 TypeScript 类型以及提供方便的 API 客户端以简化集成。
• 工作流管理：与您的 n8n 工作流交互（列出、获取、创建、更新、删除、导出、导入）。
• n8n API 访问：直接访问 n8n 的 API 以执行高级操作。
• 工作流模板：使用现成的模板处理各种用例，特别是 Google 日历。

💻 使用示例

工作流验证工具

// 示例用法：
{
  "workflow": "{...}",
  "validators": ["naming", "errorHandling", "security"],
  "strictness": "high"
}

NextJS 集成工具

// 示例用法：
{
  "workflowId": "123",
  "outputDir": "./my-nextjs-app/pages/api",
  "generateTypes": true,
  "generateOpenAPI": true
}

工作流管理工具

// 示例用法：
{
  "workflow": "{...}",
  "action": "create", // 可选操作：create, update, delete, list, get
  "parameters": {
    "name": "new_workflow"
  }
}

📚 详细文档

项目结构

├── src/
│   ├── server.ts       # 主服务器文件
│   └── tools/
│       ├── workflow-validator.ts     # 工作流验证工具
│       ├── nextjs-integration.ts    # NextJS 集成工具
│       └── workflow-manager.ts      # 工作流管理工具
├── package.json        # 项目依赖和脚本
├── pnpm-lock.yaml      # pnpm 锁文件
└── .env.example        # 环境变量示例文件

🤝 贡献

欢迎贡献！请随时打开问题或拉取请求。

📄 许可证

MIT