N8n MCP Server Bpj

🚀 n8n MCP Server

A Model Context Protocol (MCP) server that allows AI assistants to interact with n8n workflows through natural language.

🚀 Quick Start

This MCP server provides AI assistants with the tools and resources to manage n8n workflows and their execution. It enables assistants to:

• List, create, update, and delete workflows
• Enable and disable workflows
• Execute workflows and monitor their status
• Access workflow information and execution statistics

📦 Installation

Prerequisites

• Node.js 18 or higher
• An n8n instance with API access enabled

Install from npm

npm install -g n8n-mcp-server

Install from source code

# 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 .

🛠️ Configuration

Create a .env file in the directory where the server will run, using .env.example as a template:

cp .env.example .env

Configure the following environment variables:

• N8N_API_URL: The URL of the n8n instance (e.g., http://localhost:3000)
• N8N_API_KEY: The API key for n8n

💻 Usage Examples

Workflow Management

const result = await useWorkflowList();
// Returns a list of all workflows

const workflow = await useWorkflowGet('id');
// Gets detailed information about a specific workflow

const new_workflow = {
  name: 'New Workflow',
  nodes: [],
  edges: []
};
const result = await useWorkflowCreate(new_workflow);
// Creates a new workflow

const updated_workflow = {
  id: 'workflow-id',
  name: 'Updated Workflow'
};
const result = await useWorkflowUpdate('workflow-id', updated_workflow);
// Updates an existing workflow

await useWorkflowDelete('workflow-id');
// Deletes a workflow

Execution Management

const data = {
  input: 'Hello, World!'
};
const execution_result = await useExecutionRun('workflow-id', data);
// Executes a workflow via the API

const webhook_result = await useRunWebhook('webhook-id', {
  prompt: 'Trigger the webhook'
});
// Executes a workflow via a webhook

await useExecutionStop('execution-id');
// Stops a running execution

Resource Access

const result = await getResource('n8n://workflows/list');
// Gets a list of all workflows

const workflow_details = await getResource(`n8n://workflow/${workflowId}`);
// Gets detailed information about a specific workflow

const execution_list = await getResource(`n8n://executions/${workflowId}`);
// Gets all executions of a workflow

const execution_details = await getResource(`n8n://execution/${executionId}`);
// Gets detailed information about a specific execution

🔧 Development

Build

npm run build

Run in development mode

npm run dev

Test

npm test

Code style

npm run lint

📄 License

MIT