n8n MCP Server

by leonardsellem
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Uses .env files for configuration of the MCP server, allowing setting of n8n API URL, API key, and debug options.

  • Used for cloning the repository during source installation of the MCP server.

  • Provides access to the source code repository for manual installation and development of the MCP server.

Servidor MCP n8n

Un servidor de Protocolo de Contexto de Modelo (MCP) que permite a los asistentes de IA interactuar con flujos de trabajo n8n a través del lenguaje natural.

Descripción general

Este servidor MCP proporciona herramientas y recursos para que los asistentes de IA gestionen los flujos de trabajo y las ejecuciones de n8n. Permite a los asistentes:

  • Enumerar, crear, actualizar y eliminar flujos de trabajo
  • Activar y desactivar flujos de trabajo
  • Ejecutar flujos de trabajo y supervisar su estado
  • Acceder a la información del flujo de trabajo y a las estadísticas de ejecución

Instalación

Prerrequisitos

  • Node.js 18 o posterior
  • Instancia n8n con acceso API habilitado

Instalar desde npm

npm install -g n8n-mcp-server

Instalar desde la fuente

# Clone the repository git clone https://github.com/leonardsellem/n8n-mcp-server.git cd n8n-mcp-server # Install dependencies npm install # Build the project npm run build # Optional: Install globally npm install -g .

Configuración

Crea un archivo .env en el directorio donde ejecutarás el servidor, usando .env.example como plantilla:

cp .env.example .env

Configure las siguientes variables de entorno:

VariableDescripciónEjemplo
N8N_API_URLURL completa de la API n8n, incluido /api/v1http://localhost:5678/api/v1
N8N_API_KEYClave API para autenticarse con n8nn8n_api_...
N8N_WEBHOOK_USERNAMENombre de usuario para la autenticación de webhook (si se utilizan webhooks)username
N8N_WEBHOOK_PASSWORDContraseña para la autenticación del webhookpassword
DEBUGHabilitar el registro de depuración (opcional)true o false

Generar una clave API n8n

  1. Abra su instancia n8n en un navegador
  2. Vaya a Configuración > API > Claves API
  3. Cree una nueva clave API con los permisos adecuados
  4. Copia la clave a tu archivo .env

Uso

Ejecución del servidor

Desde el directorio de instalación:

n8n-mcp-server

O si se instala globalmente:

n8n-mcp-server

Integración con asistentes de IA

Después de compilar el servidor ( npm run build ), debes configurar tu asistente de IA (como VS Code con la extensión Claude o la aplicación Claude Desktop) para ejecutarlo. Esto suele implicar editar un archivo de configuración JSON.

Ejemplo de configuración (por ejemplo, en VS Code settings.json o Claude Desktop claude_desktop_config.json ):

{ "mcpServers": { // Give your server a unique name "n8n-local": { // Use 'node' to execute the built JavaScript file "command": "node", // Provide the *absolute path* to the built index.js file "args": [ "/path/to/your/cloned/n8n-mcp-server/build/index.js" // On Windows, use double backslashes: // "C:\\path\\to\\your\\cloned\\n8n-mcp-server\\build\\index.js" ], // Environment variables needed by the server "env": { "N8N_API_URL": "http://your-n8n-instance:5678/api/v1", // Replace with your n8n URL "N8N_API_KEY": "YOUR_N8N_API_KEY", // Replace with your key // Add webhook credentials only if you plan to use webhook tools // "N8N_WEBHOOK_USERNAME": "your_webhook_user", // "N8N_WEBHOOK_PASSWORD": "your_webhook_password" }, // Ensure the server is enabled "disabled": false, // Default autoApprove settings "autoApprove": [] } // ... other servers might be configured here } }

Puntos clave:

  • Reemplace /path/to/your/cloned/n8n-mcp-server/ con la ruta absoluta real donde clonó y construyó el repositorio.
  • Utilice el separador de ruta correcto para su sistema operativo (barras diagonales / para macOS/Linux, barras diagonales inversas dobles \\ para Windows).
  • Asegúrese de proporcionar la N8N_API_URL correcta (incluido /api/v1 ) y N8N_API_KEY .
  • Es necesario construir el servidor ( npm run build ) antes de que el asistente pueda ejecutar el archivo build/index.js .

Herramientas disponibles

El servidor proporciona las siguientes herramientas:

Uso de webhooks

Este servidor MCP permite ejecutar flujos de trabajo mediante webhooks n8n. Para usar esta funcionalidad:

  1. Cree un flujo de trabajo activado por webhook en n8n.
  2. Configure la autenticación básica en su nodo webhook.
  3. Utilice la herramienta run_webhook para activar el flujo de trabajo, pasando solo el nombre del flujo de trabajo.

Ejemplo:

const result = await useRunWebhook({ workflowName: "hello-world", // Will call <n8n-url>/webhook/hello-world data: { prompt: "Hello from AI assistant!" } });

La autenticación del webhook se gestiona automáticamente mediante las variables de entorno N8N_WEBHOOK_USERNAME y N8N_WEBHOOK_PASSWORD .

Gestión del flujo de trabajo

  • workflow_list : Lista todos los flujos de trabajo
  • workflow_get : Obtener detalles de un flujo de trabajo específico
  • workflow_create : Crea un nuevo flujo de trabajo
  • workflow_update : Actualizar un flujo de trabajo existente
  • workflow_delete : Eliminar un flujo de trabajo
  • workflow_activate : Activar un flujo de trabajo
  • workflow_deactivate : Desactivar un flujo de trabajo

Gestión de la ejecución

  • execution_run : Ejecutar un flujo de trabajo a través de la API
  • run_webhook : Ejecutar un flujo de trabajo a través de un webhook
  • execution_get : Obtener detalles de una ejecución específica
  • execution_list : Lista las ejecuciones de un flujo de trabajo
  • execution_stop : Detener una ejecución en ejecución

Recursos

El servidor proporciona los siguientes recursos:

  • n8n://workflows/list : Lista de todos los flujos de trabajo
  • n8n://workflow/{id} : Detalles de un flujo de trabajo específico
  • n8n://executions/{workflowId} : Lista de ejecuciones para un flujo de trabajo
  • n8n://execution/{id} : Detalles de una ejecución específica

Desarrollo

Edificio

npm run build

Ejecutando en modo de desarrollo

npm run dev

Pruebas

npm test

Pelusa

npm run lint

Licencia

Instituto Tecnológico de Massachusetts (MIT)

-
security - not tested
F
license - not found
-
quality - not tested

Un servidor de protocolo de contexto de modelo que permite a los asistentes de IA interactuar con flujos de trabajo n8n a través del lenguaje natural, admitiendo acciones como enumerar, crear, actualizar, ejecutar y supervisar flujos de trabajo.

  1. Overview
    1. Installation
      1. Prerequisites
      2. Install from npm
      3. Install from source
    2. Configuration
      1. Generating an n8n API Key
    3. Usage
      1. Running the Server
      2. Integrating with AI Assistants
    4. Available Tools
      1. Using Webhooks
      2. Workflow Management
      3. Execution Management
    5. Resources
      1. Development
        1. Building
        2. Running in Development Mode
        3. Testing
        4. Linting
      2. License
        ID: bysl8wgg6t