N8n Workflow Validator

🚀 n8n Master Control Program (MCP)

This project is a Master Control Program (MCP) created for n8n. It offers a set of tools to validate workflows and assist you in following best practices, thereby optimizing your automation projects.

🚀 Quick Start

This MCP provides a range of features to enhance your n8n experience. It helps you validate workflows, integrate with NextJS, manage workflows, access the n8n API, and use workflow templates.

✨ Features

• Workflow Validation: Check if your workflows adhere to best practices, including:
  • Naming conventions
  • Error handling
  • Security
  • Performance
  • Documentation
• NextJS Integration: Generate integrations for NextJS applications from your n8n workflows, including:
  • Automatic generation of API routes
  • Creation of OpenAPI/Swagger documentation
  • Automatic generation of TypeScript types
  • Provision of a convenient API client for simplified integration
• Workflow Management: Interact with your n8n workflows (list, get, create, update, delete, export, import).
• n8n API Access: Directly access the n8n API for advanced operations.
• Workflow Templates: Use ready - made templates for various use cases, especially for Google Calendar.

📦 Installation

Prerequisites

• Node.js (v16 or higher)
• pnpm (v7 or higher)
• An n8n instance (local or remote, e.g., your instance on Cloudron at n8n.bienquoi.com)

Steps

1. Clone this repository or navigate to the project directory.
2. Install dependencies:

pnpm install

3. Configure environment variables:

cp .env.example .env

Modify the contents of the .env file to reflect your information for connecting to the n8n API.

💻 Usage Examples

Build the Project

pnpm build

Start the Server

pnpm start

The master control server will be accessible at http://localhost:3000 (or the port specified in the .env file).

Use with Claude Desktop

To use this MCP server with Claude Desktop, configure the claude_desktop_config.json file in the %APPDATA%/Claude/ directory:

{
  "mcpServers": {
    "n8n-mcp-server": {
      "command": "node",
      "args": ["/absolute/path/mcp-n8n-server/dist/server.js"]
    }
  }
}

Basic Usage

Here are the basic usage examples for different tools:

Workflow Validation Tool

// Example usage:
{
  "workflow": "{...}",
  "validators": ["naming", "errorHandling", "security"],
  "strictness": "high"
}

NextJS Integration Tool

// Example usage:
{
  "workflowId": "123",
  "outputDir": "./my-nextjs-app/pages/api",
  "generateTypes": true,
  "generateOpenAPI": true
}

Workflow Management Tool

// Example usage:
{
  "workflow": "{...}",
  "action": "create", // Available operations: create, update, delete, list, get
  "parameters": {
    "name": "new_workflow"
  }
}

📚 Documentation

Project Structure

├── src/
│   ├── server.ts       # Main server file
│   └── tools/
│       ├── workflow-validator.ts     # Workflow validation tool
│       ├── nextjs-integration.ts    # NextJS integration tool
│       └── workflow-manager.ts      # Workflow management tool
├── package.json        # Project dependencies and scripts
├── pnpm-lock.yaml      # pnpm lock file
└── .env.example        # Example environment variable file

🤝 Contribution

Contributions are welcome! Please feel free to open issues or pull requests.

📄 License

MIT