n8n MCP Server

n8n MCP Server

一个 Model Context Protocol（MCP）服务，可通过 Smithery Model Context Protocol，让 LLM 和 AI Agent 能够无缝管理 n8n 工作流。

功能

• 列出 n8n 中可用的工作流
• 查看工作流详情
• 执行工作流
• 监控工作流执行情况
• 向工作流传递参数
• 面向 AI Agent 的 MCP 兼容接口

开始使用

快速开始

1. 安装软件包

   npm install @dopehunter/n8n-mcp-server
   

2. 创建 .env 文件

   cp .env.example .env
   

3. 配置 n8n 连接 编辑 .env 文件并设置：

   • N8N_BASE_URL：n8n 实例的 URL（例如，http://localhost:5678/api）
   • N8N_API_KEY：你的 n8n API 密钥（在 n8n 设置中生成）

4. 启动服务

   npm start
   

5. 测试服务

   curl -X POST http://localhost:3000/mcp -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0","id":"1","method":"mcp.tools.list","params":{}}'
   

常见问题与故障排除

• 连接被拒绝错误：确保 n8n 实例正在运行，并且可通过 N8N_BASE_URL 中指定的 URL 访问
• API 密钥问题：确认 n8n API 密钥正确，且具有相应权限
• Docker 问题：在尝试构建或运行 Docker 镜像前，确保 Docker 正在运行

如需了解更详细的故障排除信息，请参阅故障排除指南。

组件

工具

• n8n_list_workflows

  • 列出 n8n 实例中的所有工作流
  • 输入：无

• n8n_get_workflow

  • 获取特定工作流的详情
  • 输入：workflowId（string，必填）：要获取的工作流 ID

• n8n_execute_workflow

  • 执行 n8n 工作流
  • 输入：
    • workflowId（string，必填）：要执行的工作流 ID
    • data（object，可选）：要传递给工作流的数据

• n8n_get_executions

  • 获取工作流的执行历史
  • 输入：
    • workflowId（string，必填）：要获取执行记录的工作流 ID
    • limit（number，可选）：要返回的最大执行记录数

• n8n_activate_workflow

  • 激活工作流
  • 输入：workflowId（string，必填）：要激活的工作流 ID

• n8n_deactivate_workflow

  • 停用工作流
  • 输入：workflowId（string，必填）：要停用的工作流 ID

前置条件

• Node.js（v14+）
• 可通过 API 访问的 n8n 实例
• 支持 Model Context Protocol 的 LLM 或 AI Agent

配置选项

Docker 配置

{
  "mcpServers": {
    "n8n": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--init", "-e", "N8N_API_KEY=$N8N_API_KEY", "-e", "N8N_BASE_URL=$N8N_BASE_URL", "mcp/n8n-mcp-server"]
    }
  }
}

NPX 配置

{
  "mcpServers": {
    "n8n": {
      "command": "npx",
      "args": ["-y", "@dopehunter/n8n-mcp-server"]
    }
  }
}

安装

NPM

npm install @dopehunter/n8n-mcp-server

通过 npx 直接使用

npx @dopehunter/n8n-mcp-server

从源代码安装

git clone https://github.com/dopehunter/n8n_MCP_server_complete.git
cd n8n_MCP_server_complete
npm install
cp .env.example .env
# Edit the .env file with your n8n API details

开发

启动开发服务器：

npm run start:dev

构建项目：

npm run build

运行测试：

npm test

与 Claude 或其他 LLM 配合使用

1. 启动 MCP 服务：

   npm start
   

2. 配置 LLM 客户端以使用 MCP 服务：

   • 对于 Claude Desktop，使用“配置选项”部分中的配置。
   • 对于其他客户端，将其指向服务 URL（例如，http://localhost:3000/mcp）。

3. 现在，你的 LLM 可以通过 MCP 命令直接使用 n8n 工作流。

构建 Docker 镜像

docker build -t mcp/n8n-mcp-server .

API 文档

有关可用 MCP 函数的详情，请参阅 API 文档。

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

本项目采用 ISC 许可证。