N8N Api MCP

🚀 n8n API MCP 服務器

n8n API MCP 服務器是一個用於與自託管 n8n 實例進行交互的 Model Context Protocol (MCP) 服務器。它能夠執行對 n8n API 的調用，還可以通過本地數據庫搜索 API 端點，並且能存儲和檢索常用或成功的 API 調用，讓自然語言訪問更加快速。

🚀 快速開始

要使用 n8n API MCP 服務器，您需要按照以下步驟進行設置：

1. 克隆倉庫：

   git clone https://github.com/jasondsmith72/N8N-api-MCP.git
   cd N8N-api-MCP
   

2. 安裝依賴項：

   npm install
   

3. 構建服務器：

   npm run build
   

   此步驟會將 TypeScript 代碼編譯為 build 目錄中的 JavaScript。

✨ 主要特性

數據庫

• API 規範數據庫 (api_spec.db)：該數據庫存儲了從 OpenAPI/Swagger JSON 文件加載的 n8n API 端點詳細信息，可用於搜索和詳細工具。
• 快速內存數據庫 (fast_memory.db)：緩存與自然語言查詢相關聯的成功 API 調用，支持快速檢索之前使用的調用，並可提示保存新的成功調用。

工具

• search_api_endpoints：在本地 API 規範數據庫中搜索匹配特定查詢（路徑、摘要、描述、標籤）的端點。
• get_api_endpoint_details：根據路徑和方法從本地 API 規範數據庫檢索特定端點的詳細信息（參數、請求正文、響應）。
• execute_api_call：對配置好的 n8n 實例執行 API 調用。首先檢查快速內存；如果未找到，則在成功後提示保存到快速內存。
• natural_language_api_search：使用自然語言搜索 API 調用。首先檢查快速內存，然後根據查詢回退到基於 OpenAPI 規範數據庫的搜索。
• save_to_fast_memory：手動保存 API 調用（路徑、方法、參數、數據）以及原始自然語言查詢和描述到快速內存數據庫。
• list_fast_memory：列出快速內存數據庫中當前存儲的條目，可選按搜索詞過濾。
• delete_from_fast_memory：通過 ID 刪除快速內存數據庫中的特定條目。
• clear_fast_memory：清除快速內存數據庫中的所有條目。
• load_api_spec_from_json：通過解析 OpenAPI/Swagger JSON 文件加載或更新 API 規範數據庫 (api_spec.db)。
• send_raw_api_request：使用原始請求字符串（例如“GET /workflows?limit=5”）執行 API 調用。與 execute_api_call 使用相同的底層邏輯，包括快速內存檢查和保存提示。

📦 安裝指南

克隆倉庫

git clone https://github.com/jasondsmith72/N8N-api-MCP.git
cd N8N-api-MCP

安裝依賴項

npm install

構建服務器

npm run build

📚 詳細文檔

配置

此服務器需要環境變量以連接到您的 n8n 實例，這些通常在 MCP 客戶端配置文件（例如 cline_mcp_settings.json）中設置：

• N8N_URL：n8n 實例的基 URL（例如 http://your-n8n.example.com）。如果沒有設置，默認為 http://localhost:5678。
• N8N_API_KEY：您的 n8n API 密鑰，用於身份驗證。

加載 API 規範

在使用搜索工具 (search_api_endpoints, natural_language_api_search) 之前，需要先填充 API 規範數據庫：

1. 獲得您 n8n 版本的 OpenAPI（Swagger）JSON 規範文件，可從 n8n 文檔或您的實例（例如 /api/v1/docs-json）下載。
2. 使用 load_api_spec_from_json 工具，提供 JSON 文件的絕對路徑：

   load_api_spec_from_json(json_file_path="C:\\your\\path\\to\\swagger.json")
   

開發

對於帶有文件更改自動重建的功能開發，可使用以下命令：

npm run watch

調試

使用 MCP 檢查器 可以更方便地進行調試：

npm run inspector

檢查器提供一個網絡界面來查看 MCP 通信。