N8n Workflow Validator

🚀 n8n 主控服務器（MCP）

本項目為 n8n 打造了主控服務器（Master Control Program），提供一系列工具用於驗證工作流，助力您遵循最佳實踐，優化自動化項目。

🚀 快速開始

安裝

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 日曆。

📦 安裝指南

先決條件

• 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

高級用法

與 Claude Desktop 結合使用

要將此 MCP 服務器與 Claude Desktop 配合使用，請配置 %APPDATA%/Claude/ 目錄中的 claude_desktop_config.json 文件：

{
  "mcpServers": {
    "n8n-mcp-server": {
      "command": "node",
      "args": ["/絕對路徑/mcp-n8n-server/dist/server.js"]
    }
  }
}

📚 詳細文檔

項目結構

├── src/
│   ├── server.ts       # 主服務器文件
│   └── tools/
│       ├── workflow-validator.ts     # 工作流驗證工具
│       ├── nextjs-integration.ts    # NextJS 集成工具
│       └── workflow-manager.ts      # 工作流管理工具
├── package.json        # 項目依賴和腳本
├── pnpm-lock.yaml      # pnpm 鎖文件
└── .env.example        # 環境變量示例文件

可用工具

1. 工作流驗證工具

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

2. NextJS 集成工具

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

3. 工作流管理工具

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

📄 許可證

本項目採用 MIT 許可證。

貢獻

歡迎貢獻！請隨時打開問題或拉取請求。