n8n MCP 服务器

一个模型上下文协议（MCP）服务器，允许 AI 助手通过自然语言与 n8n 工作流进行交互。

概述

该项目提供了一个模型上下文协议（MCP）服务器，使 AI 助手能够无缝地与 n8n（一个流行的工作流自动化工具）进行交互。它充当桥梁，使 AI 助手能够通过自然语言命令以编程方式管理和控制 n8n 工作流和执行。

安装

先决条件

Node.js 20 或更高版本
启用了 API 访问的 n8n 实例

从 npm 安装

npm install -g @leonardsellem/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 .

Docker 安装

你也可以使用 Docker 运行服务器：

# 拉取镜像
docker pull leonardsellem/n8n-mcp-server

# 使用你的 n8n API 配置运行容器
docker run -e N8N_API_URL=http://your-n8n:5678/api/v1 \
  -e N8N_API_KEY=your_n8n_api_key \
  -e N8N_WEBHOOK_USERNAME=username \
  -e N8N_WEBHOOK_PASSWORD=password \
  leonardsellem/n8n-mcp-server

更新服务器

更新服务器的方式取决于你最初是如何安装的。

1. 通过 npm 全局安装

如果你使用 npm install -g @leonardsellem/n8n-mcp-server 安装了服务器：

打开终端或命令提示符。

运行以下命令以获取最新版本：

npm install -g @leonardsellem/n8n-mcp-server@latest

如果服务器当前正在运行（例如，作为后台进程或服务），你需要重启它以使更改生效。

2. 从源码安装

如果你克隆了仓库并从源码安装：

打开终端或命令提示符。
导航到你克隆项目的目录：
```
cd path/to/n8n-mcp-server
```
如果你对代码进行了任何本地更改并希望保留它们，请考虑暂存它们（可选）：
```
git stash
```
你可以稍后使用 git stash pop 应用它们。
从仓库拉取最新更改（假设你在 main 分支上）：
```
git pull origin main
```
如果你在其他分支上，请将 main 替换为你的分支名称。
安装或更新任何更改的依赖项：
```
npm install
```
重新构建项目以包含最新更新：
```
npm run build
```
如果你之前使用 npm install -g . 从该源文件夹全局安装，你可能需要再次运行此命令以更新全局链接：
```
npm install -g .
```
重启服务器。
- 如果你使用类似 node build/index.js 的命令直接运行服务器，请确保路径仍然正确。使用 npm install -g . 然后使用 n8n-mcp-server 作为命令应该保持一致。

3. 使用 Docker

如果你使用 Docker 运行服务器：

从 Docker Hub 拉取最新镜像：

docker pull leonardsellem/n8n-mcp-server:latest

停止并删除旧容器。你需要容器的名称或 ID（你可以使用 docker ps 找到它）：
```
docker stop <your_container_name_or_id>
docker rm <your_container_name_or_id>
```
使用更新的镜像启动一个新容器。使用你之前使用的相同 docker run 命令，包括所有必要的环境变量（请参阅“Docker 安装”部分以获取示例命令）。例如：
```
docker run -e N8N_API_URL=http://your-n8n:5678/api/v1 \
  -e N8N_API_KEY=your_n8n_api_key \
  -e N8N_WEBHOOK_USERNAME=username \
  -e N8N_WEBHOOK_PASSWORD=password \
  leonardsellem/n8n-mcp-server:latest
```
确保你使用 :latest 或你打算运行的特定版本标签。

配置

在运行服务器的目录中创建一个 .env 文件，使用 .env.example 作为模板：

cp .env.example .env

配置以下环境变量：

变量	描述	示例
`N8N_API_URL`	n8n API 的完整 URL，包括 `/api/v1`	`http://localhost:5678/api/v1`
`N8N_API_KEY`	用于与 n8n 进行身份验证的 API 密钥	`n8n_api_...`
`N8N_WEBHOOK_USERNAME`	用于 webhook 身份验证的用户名（如果使用 webhook）	`username`
`N8N_WEBHOOK_PASSWORD`	用于 webhook 身份验证的密码	`password`
`DEBUG`	启用调试日志（可选）	`true` 或 `false`

生成 n8n API 密钥

在浏览器中打开你的 n8n 实例
转到设置 > API > API 密钥
创建一个具有适当权限的新 API 密钥
将密钥复制到你的 .env 文件中

使用

运行服务器

从安装目录：

n8n-mcp-server

或者如果全局安装：

n8n-mcp-server

与 AI 助手集成

构建服务器后（npm run build），你需要配置你的 AI 助手（如带有 Claude 扩展的 VS Code 或 Claude 桌面应用程序）来运行它。这通常涉及编辑 JSON 配置文件。

示例配置（例如，在 VS Code 的 settings.json 或 Claude 桌面的 claude_desktop_config.json 中）：

{
  "mcpServers": {
    // 为你的服务器指定一个唯一的名称
    "n8n-local": {
      // 使用 'node' 执行构建的 JavaScript 文件
      "command": "node",
      // 提供构建的 index.js 文件的 *绝对路径*
      "args": [
        "/path/to/your/cloned/n8n-mcp-server/build/index.js"
        // 在 Windows 上，使用双反斜杠：
        // "C:\\path\\to\\your\\cloned\\n8n-mcp-server\\build\\index.js"
      ],
      // 服务器所需的环境变量
      "env": {
        "N8N_API_URL": "http://your-n8n-instance:5678/api/v1", // 替换为你的 n8n URL
        "N8N_API_KEY": "YOUR_N8N_API_KEY", // 替换为你的密钥
        // 仅在你计划使用 webhook 工具时添加 webhook 凭据
        // "N8N_WEBHOOK_USERNAME": "your_webhook_user",
        // "N8N_WEBHOOK_PASSWORD": "your_webhook_password"
      },
      // 确保服务器已启用
      "disabled": false,
      // 默认的自动批准设置
      "autoApprove": []
    }
    // ... 其他服务器可能在这里配置
  }
}

关键点：

将 /path/to/your/cloned/n8n-mcp-server/ 替换为你克隆并构建仓库的实际绝对路径。
使用适合你操作系统的正确路径分隔符（macOS/Linux 使用正斜杠 /，Windows 使用双反斜杠 \\）。
确保你提供了正确的 N8N_API_URL（包括 /api/v1）和 N8N_API_KEY。
在助手运行 build/index.js 文件之前，需要先构建服务器（npm run build）。

可用工具

服务器提供以下工具：

使用 Webhook

此 MCP 服务器支持通过 n8n webhook 执行工作流。要使用此功能：

在 n8n 中创建一个由 webhook 触发的工作流。
在你的 webhook 节点上设置基本身份验证。
使用 run_webhook 工具触发工作流，只需传递工作流名称。

示例：

const result = await useRunWebhook({
  workflowName: "hello-world", // 将调用 <n8n-url>/webhook/hello-world
  data: {
    prompt: "Hello from AI assistant!"
  }
});

webhook 身份验证会自动使用 N8N_WEBHOOK_USERNAME 和 N8N_WEBHOOK_PASSWORD 环境变量进行处理。

工作流管理

workflow_list: 列出所有工作流
workflow_get: 获取特定工作流的详细信息
workflow_create: 创建新工作流
workflow_update: 更新现有工作流
workflow_delete: 删除工作流
workflow_activate: 激活工作流
workflow_deactivate: 停用工作流

执行管理

execution_run: 通过 API 执行工作流
run_webhook: 通过 webhook 执行工作流
execution_get: 获取特定执行的详细信息
execution_list: 列出工作流的执行
execution_stop: 停止正在运行的执行

资源

服务器提供以下资源：

n8n://workflows/list: 所有工作流的列表
n8n://workflow/{id}: 特定工作流的详细信息
n8n://executions/{workflowId}: 工作流的执行列表
n8n://execution/{id}: 特定执行的详细信息

路线图

n8n MCP 服务器是一个社区驱动的项目，其未来方向将由你的反馈和贡献塑造！

目前，我们的路线图是灵活的，并且正在持续开发中。我们相信基于用户的需求和想法来发展服务器。

我们鼓励你参与塑造此工具的未来：

建议功能： 有关于新工具、资源或改进的想法吗？
讨论优先级： 想对我们下一步应该关注的内容发表意见吗？

请通过在我们的 GitHub Issues 页面上提出问题来分享你的想法、功能请求和建议。让我们一起为 AI 助手构建一个强大的工具！

开发

构建

npm run build

以开发模式运行

npm run dev

测试

npm test

代码检查

npm run lint

贡献

我们欢迎社区的贡献，并很高兴看到你如何帮助改进 n8n MCP 服务器！无论你是修复错误、提出新功能还是改进文档，你的帮助都是宝贵的。

报告错误

如果你遇到错误，请通过在我们的 GitHub Issues 页面上提出问题来报告。

提交错误报告时，请包括以下内容：

一个清晰且描述性的标题。
问题的详细描述，包括重现错误的步骤。
关于你环境的信息（例如，Node.js 版本、n8n MCP 服务器版本、操作系统）。
任何相关的错误消息或截图。

建议改进

我们一直在寻找使服务器更好的方法。如果你有改进或新功能的想法，请在我们的 GitHub Issues 页面上提出问题。

请提供：

一个清晰且描述性的标题。
提议改进的详细解释以及为什么它会有益。
任何潜在的使用场景或示例。

提交 Pull Requests

如果你想贡献代码，请按照以下步骤操作：

Fork 仓库： 创建 n8n-mcp-server 仓库的自己的 fork。
创建分支： 在你的 fork 中为你的更改创建一个新分支（例如，git checkout -b feature/your-feature-name 或 bugfix/issue-number）。
进行更改： 实现你的功能或修复错误。
- 确保你的代码符合现有的编码风格。（我们使用 Prettier 进行格式化，可以通过 npm run lint 运行）。
- 如果适用，请为你的更改包括测试。你可以使用 npm test 运行测试。
提交更改： 编写清晰且简洁的提交消息。
推送到你的 fork： 将你的更改推送到你的 fork 仓库。
打开 Pull Request (PR)： 向官方 n8n-mcp-server 仓库的 main 分支提交 PR。
- 为你的 PR 提供清晰的标题和描述，解释你所做的更改并引用任何相关的问题。

我们将尽快审查你的 PR 并提供反馈。感谢你的贡献！

许可证

MIT

🚀 加入我们的团队：招募共同维护者！

该项目是一个活跃的、社区驱动的工具，被 AI 爱好者和开发者广泛使用。目前，它由一位热情的个体兼职维护，该个体并非经验丰富的工程师，但致力于将 AI 与工作流自动化相结合。为了帮助该项目蓬勃发展，确保其长期健康，并跟上其不断增长的用户群体，我们正在寻找热情的 共同维护者 加入团队！

为什么贡献？

学习和成长： 提高你在 TypeScript、Node.js、API 集成和 AI 工具开发等领域的技能。
合作： 与其他有动力的开发者和 AI 用户一起工作。
产生影响： 直接塑造该项目的未来，并帮助为 AI 社区构建一个宝贵的工具。
开源： 获得为开源项目做贡献的经验。

你可以如何帮助

我们欢迎多种形式的贡献！以下是一些你可以做出重大贡献的领域：

修复错误： 帮助我们识别并修复错误，以提高稳定性。
功能开发： 根据用户需求和你的想法实现新工具和功能。
文档： 改进我们的指南、示例和 API 参考，使项目更易于访问。
测试： 增强我们的测试套件（单元测试、集成测试），以确保代码质量和可靠性。
CI/CD： 帮助简化我们的开发和部署流程。
代码审查： 对 pull requests 提供反馈，并帮助维护代码标准。
社区支持： 协助用户解决问题并帮助管理讨论。

参与进来！

如果你对 AI 和工作流自动化的交叉领域感到兴奋，并且正在寻找一个有意义的开源机会，我们很乐意听到你的声音！

准备好贡献了吗？

查看我们的 GitHub Issues 页面以找到现有任务，提出新想法，或表达你成为共同维护者的兴趣。
你可以打开一个标题为“Co-maintainer Application”的问题来正式申请，或者直接开始为现有问题做贡献。
或者，如果你有任何问题，请随时联系现有的维护者。

让我们一起构建 AI 驱动的工作流自动化的未来！🙌

感谢社区的支持！