N8n Workflow Builder

🚀 n8n Workflow Builder MCP Server

This project provides an MCP server for managing n8n workflows. It offers functions to list, create, update, delete, activate, and deactivate workflows.

⚠️ Important Note

This version only supports using npm for package management and running the server. (Support for npx will be re - introduced in future versions.)

🚀 Quick Start

Prerequisites

• Node.js (v14+ recommended)
• npm

📦 Installation

1. Clone the repository

Clone the repository from your chosen source. For example:

git clone https://github.com/makafeli/n8n-workflow-builder.git

Then, navigate to the project directory:

cd /root/n8n-workflow-builder

2. Install dependencies

Use npm to install the necessary dependencies:

npm install

This command will download and install all the required packages defined in the package.json file.

3. Build and test

To test and bring the server online, use the following commands:

• Build the project: This compiles the TypeScript files and generates executable JavaScript files in the build directory.

  npm run build
  

• Start the MCP server: Use the following command to start the server:

  npm start
  

The server will start and connect via stdio. You can view a confirmation message in the console indicating that the server has started correctly.

4. Deployment

For testing purposes and to bring the server online, use the above build and start commands. This basic workflow (install, build, start) is currently the recommended approach.

5. Additional configuration

Server configuration is managed through the cline_mcp_settings.json file. Ensure the following environment variables are set correctly:

• N8N_HOST: Your n8n API host URL.
• N8N_API_KEY: Your n8n API key. For example, the configuration in cline_mcp_settings.json:

{
  "n8n-workflow-builder": {
    "command": "node",
    "args": ["/root/n8n-workflow-builder/build/index.js"],
    "env": {
      "N8N_HOST": "https://n8n.io/api/v1/",
      "N8N_API_KEY": "YOUR_N8N_API_KEY_HERE"
    },
    "disabled": false,
    "alwaysAllow": [
      "create_workflow",
      "create_workflow_and_activate",
      "update_workflow",
      "activate_workflow",
      "deactivate_workflow",
      "get_workflow",
      "delete_workflow"
    ],
    "autoApprove": []
  }
}

✨ Features

MCP Tools

The server defines the following tools, which can be accessed via your MCP client:

Workflow Management

• list_workflows: List all workflows in n8n.
• create_workflow: Create a new workflow in n8n.
• get_workflow: Get a workflow by ID.
• update_workflow: Update an existing workflow.
• delete_workflow: Delete a workflow by ID.
• activate_workflow: Activate a workflow by ID.
• deactivate_workflow: Deactivate a workflow by ID.

Execution Management

• list_executions: List all workflow executions with optional filters.
• get_execution: Get detailed information about a specific execution by ID.
• delete_execution: Delete an execution by ID.

MCP Resources

The server also provides the following resources for more efficient context access:

Static Resources

• /workflows: A list of all available workflows in the n8n instance.
• /execution-stats: Summary statistics of workflow executions.

Dynamic Resource Templates

• /workflows/{id}: Detailed information about a specific workflow.
• /executions/{id}: Detailed information about a specific execution.

🔧 Troubleshooting

• Ensure you are using npm (npx is not supported in this version).
• If you encounter any issues, clean the build directory and rebuild:

  npm run clean && npm run build
  

• Verify that the environment variables in cline_mcp_settings.json are correct.

🚧 Future Improvements

• Re - introduce support for npx.
• Add more workflow features.
• Improve server performance and stability.

📄 License

[Insert license information here]

👥 Contributors

[List contributors here]

🔗 Links

[Add relevant links here]