N8n MCP Server 4p8

🚀 n8n-mcp-server

An Model-Controller-Provider (MCP) server implemented for n8n workflow automation. This server provides standardized interfaces through the JSON-RPC protocol for executing and managing n8n workflows.

✨ Features

• API compliant with JSON-RPC 2.0 standard
• Support for workflow execution and management
• Environment configuration support
• TypeScript support
• Comprehensive logging
• Docker support

📦 Installation

Prerequisites

• Node.js >= 14.0.0
• A running and accessible n8n instance
• n8n API key

Steps

1. Clone the repository:

git clone https://github.com/S17S17/n8n-mcp-server.git
cd n8n-mcp-server

2. Install dependencies:

npm install

3. Configure environment variables:

cp .env.example .env
# Edit the .env file to set your configuration

📚 Documentation

Configuration

Configure the server via environment variables. Refer to .env.example for all available options.

Required environment variables:

• N8N_URL: The URL of the n8n instance API
• N8N_API_KEY: Your n8n API key
• N8N_API_HEADER: The header name for the API key (Default: X-N8N-API-KEY)

Usage

Start the server

Multiple startup options are provided:

# Standard startup
npm start

# Development mode with hot reloading
npm run start:dev

# Simple mode (minimal features)
npm run start:simple

# Debug mode
npm run debug

Docker support

Build and run using Docker:

docker build -t n8n-mcp-server .
docker run -p 3000:3000 --env-file .env n8n-mcp-server

Or use Docker Compose:

docker-compose up

📄 API Documentation

The server implements a JSON-RPC 2.0 interface with the following methods:

• initialize: Initialize the server connection
• shutdown: Gracefully shut down the server
• listTools: List available workflow tools
• callTool: Execute a specific workflow tool

Refer to API.md for detailed API documentation.

🔧 Technical Details

Build from source code

npm run build

Run tests

npm test

Format check

npm run lint

🤝 Contribution

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing features')
4. Push to the branch (git push origin feature/amazing-feature)
5. Submit a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🛠️ Support

For support, please open an issue in the GitHub repository.