N8n MCP Server Bpj

🚀 n8n MCP 服務器

n8n MCP 服務器是一個模型上下文協議（MCP）服務器，它允許 AI 助手藉助自然語言與 n8n 工作流展開交互，為工作流管理提供了便捷途徑。

🚀 快速開始

此 MCP 服務器為 AI 助手提供了管理 n8n 工作流及其執行的工具和資源。它使助手能夠：

• 列出、創建、更新和刪除工作流
• 啟用和禁用工作流
• 執行工作流並監控其狀態
• 訪問工作流信息和執行統計

✨ 主要特性

• 支持 AI 助手通過自然語言與 n8n 工作流交互。
• 提供全面的工作流管理功能，包括創建、更新、刪除等。
• 可執行工作流並監控其狀態，還能訪問工作流信息和執行統計。

📦 安裝指南

先決條件

• Node.js 18 或更高版本
• 已啟用 API 訪問的 n8n 實例

從 npm 安裝

npm install -g n8n-mcp-server

從源代碼安裝

# 克隆倉庫
git clone https://github.com/leonardsellem/n8n-mcp-server.git
cd n8n-mcp-server

# 安裝依賴項
npm install

# 構建項目
npm run build

# 可選：全局安裝
npm install -g .

📚 詳細文檔

配置

在運行服務器的目錄中創建一個 .env 文件，使用 .env.example 作為模板：

cp .env.example .env

配置以下環境變量：

• N8N_API_URL: n8n 實例的 URL（例如 http://localhost:3000）
• N8N_API_KEY: n8n 的 API 密鑰

使用方法

💻 使用示例

基礎用法

// 工作流管理
const result = await useWorkflowList();
// 返回所有工作流列表

const workflow = await useWorkflowGet('id');
// 獲取特定工作流的詳細信息

const new_workflow = {
  name: 'New Workflow',
  nodes: [],
  edges: []
};
const result = await useWorkflowCreate(new_workflow);
// 創建新工作流

const updated_workflow = {
  id: 'workflow-id',
  name: 'Updated Workflow'
};
const result = await useWorkflowUpdate('workflow-id', updated_workflow);
// 更新現有工作流

await useWorkflowDelete('workflow-id');
// 刪除工作流

// 執行管理
const data = {
  input: 'Hello, World!'
};
const execution_result = await useExecutionRun('workflow-id', data);
// 通過 API 執行工作流

const webhook_result = await useRunWebhook('webhook-id', {
  prompt: '觸發網絡鉤子'
});
// 通過網絡鉤子執行工作流

await useExecutionStop('execution-id');
// 停止正在運行的執行

// 資源訪問
const result = await getResource('n8n://workflows/list');
// 獲取所有工作流列表

const workflow_details = await getResource(`n8n://workflow/${workflowId}`);
// 獲取特定工作流的詳細信息

const execution_list = await getResource(`n8n://executions/${workflowId}`);
// 獲取工作流的所有執行

const execution_details = await getResource(`n8n://execution/${executionId}`);
// 獲取特定執行的詳細信息

開發

構建

npm run build

開發模式運行

npm run dev

測試

npm test

代碼規範

npm run lint

📄 許可證

本項目採用 MIT 許可證。