Herramientas MCP n8n

Implementación de un servidor del Protocolo de Contexto de Modelo (MCP) para la integración de la API n8n. Este proyecto permite una integración fluida entre los flujos de trabajo n8n y los asistentes de IA mediante el protocolo MCP.

Características

• Implementación completa de la API pública de n8n (v1.1.1)
• Herramientas MCP para todos los puntos finales de API
• Servidor API RESTful con documentación Swagger
• Arquitectura modular para extensibilidad
• middleware de autenticación

Estructura

El proyecto está organizado en los siguientes componentes:

• api/endpoints/ : Implementaciones de puntos finales de API para cada tipo de recurso
• api/schemas/ : Definiciones de esquemas del modelo de datos
• api/tools/ : Implementaciones de herramientas MCP para cada tipo de recurso
• api/index.js : Punto de entrada del servidor principal
• api/config.js : Ajustes de configuración

Empezando

Prerrequisitos

• Node.js (v14 o superior)
• npm o hilo
• Una instancia n8n con una clave API

Instalación

Como paquete

De la fuente

1. Clonar el repositorio:
   git clone https://github.com/yourusername/n8n-mcp-tools.git cd n8n-mcp-tools
2. Instalar dependencias:
   npm install
3. Crea un archivo .env con tu configuración:
   N8N_API_BASE_URL=https://your-n8n-instance.com/api/v1 N8N_API_KEY=your-api-key PORT=3000
4. Iniciar el servidor:
   npm start
5. Acceda a la documentación de la API:
   http://localhost:3000/api-docs

Herramientas MCP

Las herramientas MCP permiten a los asistentes de IA interactuar con n8n mediante lenguaje natural. A continuación, se muestran algunos ejemplos:

Herramientas de usuario

• get-users : obtiene todos los usuarios de la instancia n8n
• get-user : Obtener un usuario específico por ID o correo electrónico
• create-users : Crea uno o más usuarios
• delete-user : Eliminar un usuario por ID o correo electrónico
• change-user-role : Cambiar el rol global de un usuario

Herramientas de flujo de trabajo

• get-workflows : obtiene todos los flujos de trabajo de la instancia n8n
• get-workflow : Obtener un flujo de trabajo específico por ID
• create-workflow : Crea un nuevo flujo de trabajo
• update-workflow : Actualizar un flujo de trabajo existente
• delete-workflow : eliminar un flujo de trabajo por ID
• activate-workflow : Activar un flujo de trabajo
• deactivate-workflow : Desactivar un flujo de trabajo
• get-workflow-tags : Obtener etiquetas para un flujo de trabajo
• update-workflow-tags : Actualizar etiquetas para un flujo de trabajo
• transfer-workflow : Transferir un flujo de trabajo a otro proyecto

Y muchas más herramientas para credenciales, ejecuciones, etiquetas, variables, proyectos y funcionalidad de auditoría.

Configuración

El servidor se puede configurar utilizando variables de entorno o modificando api/config.js :

• N8N_API_BASE_URL : URL base para la API n8n
• N8N_API_KEY : Clave API para autenticación
• PORT : Puerto donde se ejecutará el servidor
• HOST : Host al que vincular el servidor
• LOG_LEVEL : Nivel de registro (información, error, depuración)
• MCP_SOCKET_PATH : Ruta para el socket MCP (para transporte STDIO)
• MCP_USE_TCP : si se debe utilizar TCP para el transporte MCP
• MCP_TCP_PORT : puerto TCP para transporte MCP
• MCP_TCP_HOST : host TCP para transporte MCP

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Publicación

Si está contribuyendo a este paquete y necesita publicar una nueva versión:

1. Actualice la versión en package.json:
   npm version patch # for bug fixes npm version minor # for new features npm version major # for breaking changes
2. Publicar en npm:
   npm publish
3. El script de postversión enviará automáticamente la nueva versión a GitHub.

Contribuyendo

¡Agradecemos sus contribuciones! Consulte nuestra Guía de Contribución para más detalles.

Registro de cambios

Consulte el archivo CHANGELOG.md para obtener detalles sobre los cambios para cada versión.