n8n API MCP Server

n8n API MCP 服务

一个用于与自托管 n8n 实例交互的模型上下文协议（MCP）服务。

此服务提供以下工具：

• 调用 n8n API。
• 使用由 OpenAPI 规范构建的本地数据库搜索 n8n API 端点。
• 使用“快速记忆”数据库存储和检索常用或成功的 API 调用，以便更快地通过自然语言访问。

功能

数据库

• API 规范数据库（api_spec.db）： 存储 n8n API 端点的详细信息，这些信息从 OpenAPI/Swagger JSON 文件加载。供搜索和详情工具使用。
• 快速记忆数据库（fast_memory.db）： 缓存与自然语言查询关联的成功 API 调用。可快速检索之前使用过的调用，并建议保存新的成功调用。

工具

• search_api_endpoints：在本地 API 规范数据库中搜索与查询匹配的端点（路径、摘要、描述、标签）。
• get_api_endpoint_details：从本地 API 规范数据库中获取指定端点（路径和方法）的详细信息（参数、请求正文、响应）。
• execute_api_call：对配置的 n8n 实例执行 API 调用。先检查快速记忆；如果未找到，调用成功后会提示保存到快速记忆。
• natural_language_api_search：使用自然语言搜索 API 调用。先检查快速记忆，然后根据查询回退到搜索 API 规范数据库。
• 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 相同的底层逻辑，包括检查快速记忆和提示保存。

设置

1. 克隆代码仓库：

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

2. 安装依赖项：

   npm install
   

3. 构建服务：

   npm run build
   

   这会将 TypeScript 代码编译为 JavaScript，并输出到 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:\\path\\to\\your\\n8n-openapi.json")
   

在 Cline / Claude Desktop 中安装

将以下配置添加到你的 cline_mcp_settings.json 中（根据克隆位置调整 index.js 的路径）：

{
  "mcpServers": {
    "... other servers ...": {},
    "n8n-api-mcp": {
      "command": "node",
      "args": [
        "C:\\MCP-Servers\\N8N-api-MCP\\build\\index.js" // <-- Update this path if needed
      ],
      "env": {
        "N8N_URL": "YOUR_N8N_INSTANCE_URL", // e.g., "http://192.168.1.100:5678"
        "N8N_API_KEY": "YOUR_N8N_API_KEY_HERE"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

（请记得将 YOUR_N8N_INSTANCE_URL 和 YOUR_N8N_API_KEY_HERE 替换为实际值）

开发

如需在文件更改时自动重新构建：

npm run watch

调试

使用 MCP Inspector 可更轻松地进行调试：

npm run inspector

Inspector 提供了一个 Web 界面，可用于查看 MCP 通信。