内容
# n8n MCP 社区版
**一个面向自托管 n8n 社区版的安全性 Model Context Protocol 服务器。**
将 MCP 客户端连接到 **有界限的 44 工具 n8n 社区版管理界面**:创建、编辑、激活和删除工作流,更新单个节点,管理执行、凭证、标签、用户、诊断和实例元数据 - 总共 44 个仔细有界限的工具。安全性在这里是**渐进的,而不是限制性的**:服务器默认为只读,`write` 解锁授权,`unsafe` 解锁每个工具,并带有每个破坏性操作的精确调用确认短语。 它从离线状态开始,使用支持的 n8n 公共 API,并且从不将工作流数据发送到外部 AI 提供商。
> **发布证据:** 仅安装在 [npm](https://www.npmjs.com/package/n8n-mcp-community)、[最新 GitHub 发布](https://github.com/drzamarian/n8n-mcp-community/releases/latest) 和 MCP 注册表条目 `io.github.drzamarian/n8n-mcp-community` 上一致的版本。[安装](docs/installation.md) 指南。
[查看合成终端演示记录](docs/demo-transcript.md)。它显示了精确版本的启动、44 工具库存和本地 Introspect 诊断,仅使用合成标识符和记录的输出形状。
[](docs/demo-transcript.md)
## 为什么有这个项目
- **社区版优先。** 发布表面设计用于自托管的 n8n 社区版,不提供仅付费功能作为可用功能。
- **44 个有用工具,一个明确的契约。** 每个工具都有有界限的输入、文档化的副作用、MCP 安全注释和契约测试。
- **默认安全。** 只读模式是默认模式。写入和破坏性或外部联系操作需要渐进式更强的门槛。
- **确定性的 Introspect。** `n8n_introspect` 运行本地的 23 条规则引擎;它不执行工作流、不调用代理、不与外部模型联系。
- **外科手术节点更新。** `n8n_update_node` 更改一个验证的节点路径,同时保留工作流的其余部分,并公开公共 API 的非原子限制。
- **真实的发现。** `n8n_list_node_types` 仅报告在可访问的工作流中观察到的类型。它不声称是完整的已安装目录。
- **数据最小化。** 凭证值、原始执行值、pin 数据和静态工作流数据不由通用公共工具返回。
## 当前验证
当前源候选版本已与以下内容验证:
- **精确的 44 个工具、5 个资源和 4 个提示**,通过真实的 stdio 进行;
- **291 个测试通过**,以及 Node.js 22.23.1 和 24.18.0 上的完整验证门槛;
- Gitleaks、Semgrep、Trivy 和两次 `npm audit` 运行的零发现;所有三个源扫描器都在 CI 中重现,具有不可变的扫描器/操作标识;
- 单独的 no-override 消费者安装,解析已审查的 `@hono/node-server@1.19.15` 后备,接受确切的 GHSA-frvp-7c67-39w9 建议或完全干净的建议读取,直到注册表元数据收敛,并证明 stdio 运行时和确切的 44/5/4 库存;
- 涵盖 224 个已安装包路径的可复制依赖项许可证门槛;
- 有界同源 HTTP 契约和零请求策略拒绝测试;
- 在带有出口隔离、吊销密钥、清理和零残留的 disposable n8n 社区 2.30.5 和 2.30.7 实例上,运行所有 44 个编译的工具生命周期。
发布仅通过审查的发布程序进行:存储库固定的 MCPB 签名标识、人类工件基线收据、标签作用域保护环境批准和外部签名的 MCPB 转移验证字节。
## 快速开始
要求:Node.js 22 或 24,npm,自托管的 n8n 社区版实例和仅具有所需权限的 n8n 公共 API 密钥。
首先识别一个版本,其 npm 源验证和 GitHub 发布资产已验证,然后在下面替换 `<VERIFIED_VERSION>`。保持固定值精确:
```json
{
"mcpServers": {
"n8n-community": {
"command": "npx",
"args": ["--yes", "n8n-mcp-community@<VERIFIED_VERSION>"],
"env": {
"N8N_API_URL": "https://n8n.example.com",
"N8N_API_KEY": "replace-with-a-dedicated-api-key",
"N8N_MCP_MODE": "read-only"
}
}
}
}
```
`read-only` 是推荐的起点,不是能力上限:相同的 44 工具表面包括完整的工作流创作。设置 `N8N_MCP_MODE=write` 以创建和编辑工作流、节点、凭证和标签,或设置 `N8N_MCP_MODE=unsafe` 以启用所有工具 - 激活、删除、重试和其他破坏性操作,每个操作仍由精确的调用确认短语保护。参见[安全模式](#安全模式)。
重启 MCP 客户端并确认 exactly 44 个工具、5 个资源和 4 个提示。可兼容的桌面客户端可以从 [最新验证版本](https://github.com/drzamarian/n8n-mcp-community/releases/latest) 安装签名 MCPB;请先验证其校验和。
## 从源码快速开始
要求:Node.js 22 或 24,npm,以及此存储库的 Git 签出。
```bash
npm ci
npm run verify:contributor
```
配置您的 MCP 客户端以运行编译的 stdio 入口点:
```json
{
"mcpServers": {
"n8n-community": {
"command": "node",
"args": ["/absolute/path/to/n8n-mcp-community/dist/index.js"],
"env": {
"N8N_API_URL": "https://n8n.example.com",
"N8N_API_KEY": "replace-with-your-api-key",
"N8N_MCP_MODE": "read-only"
}
}
}
}
```
重启 MCP 客户端并列出工具。服务器可以在没有 n8n 凭证的情况下初始化并公开其库存;连接的工具仅在调用时验证 URL 和 API 密钥。
验证版本提供签名 MCPB 和精确版本 `npx` 配置文件以实现可移植性。`@latest`、全局安装和 `curl | shell` 不是可复制的默认值。有关发布策略和客户端特定指南,请参见 [安装](docs/installation.md)。
## 安全模式
| 模式 | 它允许的内容 | 所需配置 |
| --- | --- | --- |
| 只读 | 仅只读工具 | 默认,或 `N8N_MCP_MODE=read-only` |
| 写入 | 只读和变异工具,无不安全确认门槛 | `N8N_MCP_MODE=write` |
| 不安全 | 所有工具 | `N8N_MCP_MODE=unsafe` 加上每个调用的精确确认 |
不安全模式是必要的,但不是充分的。每个不安全调用还需要诸如 `DELETE wf_123`、`STOP exec_123` 或 `TEST cred_123` 等确认。n8n API 密钥仍然是最终的上游权限边界。
仅当 loopback URL 为空时,才自动接受纯 HTTP。非 loopback HTTP 实例另外需要 `N8N_ALLOW_INSECURE_HTTP=1`,这会接受在传输过程中暴露 API 密钥和数据所带来的风险。
## 工具目录
每个条目都链接到其完整的输入、输出、端点、兼容性、故障和安全参考。
### 工作流
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_workflows_list`](docs/tools.md#n8n_workflows_list) | 只读 | 列出可访问的工作流,带有有界限的筛选器和分页。 |
| [`n8n_workflows_get`](docs/tools.md#n8n_workflows_get) | 只读 | 读取一个工作流,同时隐藏 pin 和静态数据值。 |
| [`n8n_workflows_create`](docs/tools.md#n8n_workflows_create) | 写入 | 通过公共 API 创建一个验证的工作流。 |
| [`n8n_workflows_update`](docs/tools.md#n8n_workflows_update) | 写入 | 保护并更新选定的字段,同时保留省略的字段。 |
| [`n8n_update_node`](docs/tools.md#n8n_update_node) | 写入 | 更改一个验证的节点属性,并具有非原子并发保护。 |
| [`n8n_workflows_delete`](docs/tools.md#n8n_workflows_delete) | 不安全 | 在精确确认后永久删除一个工作流。 |
| [`n8n_workflows_activate`](docs/tools.md#n8n_workflows_activate) | 不安全 | 在精确确认后激活一个工作流。 |
| [`n8n_workflows_deactivate`](docs/tools.md#n8n_workflows_deactivate) | 不安全 | 在精确确认后停用一个工作流。 |
| [`n8n_workflows_get_version`](docs/tools.md#n8n_workflows_get_version) | 只读 | 检索一个保留的历史工作流版本。 |
| [`n8n_workflows_get_tags`](docs/tools.md#n8n_workflows_get_tags) | 只读 | 列出分配给工作流的标签。 |
| [`n8n_workflows_update_tags`](docs/tools.md#n8n_workflows_update_tags) | 写入 | 替换工作流的完整标签分配。 |
| [`n8n_workflows_archive`](docs/tools.md#n8n_workflows_archive) | 不安全 | 在精确确认后归档一个工作流。 |
| [`n8n_workflows_unarchive`](docs/tools.md#n8n_workflows_unarchive) | 不安全 | 在精确确认后恢复一个归档工作流。 |
| [`n8n_workflows_diff`](docs/tools.md#n8n_workflows_diff) | 只读 | 比较节点和连接,不返回原始值。 |
### 执行
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_executions_list`](docs/tools.md#n8n_executions_list) | 只读 | 列出执行元数据,带有无值的数据存在摘要。 |
| [`n8n_executions_get`](docs/tools.md#n8n_executions_get) | 只读 | 读取一个执行的元数据,不返回工作流有效载荷。 |
| [`n8n_executions_delete`](docs/tools.md#n8n_executions_delete) | 不安全 | 永久删除一个保存的执行。 |
| [`n8n_executions_retry`](docs/tools.md#n8n_executions_retry) | 不安全 | 重试一个合格的保存执行。 |
| [`n8n_executions_stop`](docs/tools.md#n8n_executions_stop) | 不安全 | 停止一个正在运行的执行,并绑定来自验证输入的标识。 |
### 凭证
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_credentials_create`](docs/tools.md#n8n_credentials_create) | 写入 | 创建凭证时不返回其值。 |
| [`n8n_credentials_delete`](docs/tools.md#n8n_credentials_delete) | 不安全 | 永久删除一个凭证。 |
| [`n8n_credentials_schema`](docs/tools.md#n8n_credentials_schema) | 只读 | 读取凭证类型的公共模式。 |
| [`n8n_credentials_list`](docs/tools.md#n8n_credentials_list) | 只读 | 列出在 n8n 2.30.5 和 2.30.7 上验证的凭证元数据。 |
| [`n8n_credentials_get`](docs/tools.md#n8n_credentials_get) | 只读 | 读取一个凭证的公共元数据。 |
| [`n8n_credentials_update`](docs/tools.md#n8n_credentials_update) | 写入 | 更新凭证元数据或值,不回显机密。 |
| [`n8n_credentials_test`](docs/tools.md#n8n_credentials_test) | 不安全 | 测试存储的凭证,可能会联系其外部服务。 |
| [`n8n_credentials_usage`](docs/tools.md#n8n_credentials_usage) | 只读 | 在一个有界限的工作流页面中找到精确的凭证 ID 引用。 |
### 标签
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_tags_list`](docs/tools.md#n8n_tags_list) | 只读 | 列出工作流标签。 |
| [`n8n_tags_get`](docs/tools.md#n8n_tags_get) | 只读 | 读取一个标签。 |
| [`n8n_tags_create`](docs/tools.md#n8n_tags_create) | 写入 | 创建一个具有实时 1-24 字符边界的标签。 |
| [`n8n_tags_update`](docs/tools.md#n8n_tags_update) | 写入 | 重命名一个具有实时 1-24 字符边界的标签。 |
| [`n8n_tags_delete`](docs/tools.md#n8n_tags_delete) | 不安全 | 永久删除一个标签。 |
### 用户
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_users_list`](docs/tools.md#n8n_users_list) | 只读 | 列出可见的用户。 |
| [`n8n_users_get`](docs/tools.md#n8n_users_get) | 只读 | 通过稳定 ID 或确切电子邮件读取一个用户。 |
| [`n8n_users_create`](docs/tools.md#n8n_users_create) | 不安全 | 在精确的电子邮件确认后邀请成员或管理员。 |
| [`n8n_users_delete`](docs/tools.md#n8n_users_delete) | 不安全 | 删除一个 API 合法的用户而不支持转移声明。 |
### 诊断和实例元数据
| 工具 | 模式 | 目的 |
| --- | --- | --- |
| [`n8n_health`](docs/tools.md#n8n_health) | 只读 | 执行有界限的同源健康检查。 |
| [`n8n_insights_summary`](docs/tools.md#n8n_insights_summary) | 只读 | 读取官方的见解摘要,可选地使用日期筛选器。 |
| [`n8n_audit_generate`](docs/tools.md#n8n_audit_generate) | 不安全 | 在精确确认后生成 n8n 的实例安全审计。 |
| [`n8n_search_workflows`](docs/tools.md#n8n_search_workflows) | 只读 | 在本地按名称、节点类型或标签搜索一个工作流页面。 |
| [`n8n_get_node_docs`](docs/tools.md#n8n_get_node_docs) | 只读 | 读取四个不可变的离线核心节点引用之一。 |
| [`n8n_list_node_types`](docs/tools.md#n8n_list_node_types) | 只读 | 清点在有界限的可访问工作流页面中观察到的节点类型。 |
| [`n8n_introspect`](docs/tools.md#n8n_introspect) | 只读 | 运行确定性的本地工作流和执行诊断。 |
| [`n8n_community_packages_list`](docs/tools.md#n8n_community_packages_list) | 只读 | 列出已安装的社区包元数据而不使用突变路径。 |
## 资源和提示
服务器还公开了五个静态资源:
- `n8n://usage-guide`
- `n8n://node-docs/webhook`
- `n8n://node-docs/code`
- `n8n://node-docs/http-request`
- `n8n://node-docs/if`
四个提示引导安全的工作流创建、调试、优化和凭证管理:`create-workflow`、`debug-workflow`、`optimize-workflow` 和 `manage-credentials`。
## 安全模型一分钟
- 服务器使用本地 stdio;它不公开入站 HTTP 监听器。
- 连接的请求是同源的,并限制为配置的 n8n 主机。
- 重定向被拒绝;请求和响应正文限制为 2 MiB。
- 通用输出被验证、净化、限制为 256 KiB,并包装为 `{ "data": ..., "redacted": boolean, "untrusted": true }`。
- 原始凭证值和通用执行有效载荷值从不返回。
- `n8n_introspect` 使用固定的本地规则集,并且没有外部模型代码路径。
- 安全控制减少风险;它们不使不受信任的 n8n 内容安全到执行或授权更广泛的 API 密钥权限。
阅读完整的 [安全模型](docs/security-model.md) 并使用 [SECURITY.md](SECURITY.md) 私密地报告漏洞。
## 文档
- [文档地图](docs/README.md)
- [开始使用](docs/getting-started.md)
- [安装和升级](docs/installation.md)
- [配置](docs/configuration.md)
- [完整的工具参考](docs/tools.md)
- [测试示例](docs/examples.md)
- [常见问题](docs/faq.md)
- [客户端配置](docs/clients.md)
- [架构](docs/architecture.md)
- [安全模型](docs/security-model.md)
- [兼容性](div/docs/clients.md)
- [架构](docs/architecture.md)
- [安全模型](docs/security-model.md)
- [兼容性](docs/compatibility.md)
- [故障排除](docs/troubleshooting.md)
- [来源](docs/provenance.md)
- [路线图](ROADMAP.md)
- [变更日志](CHANGELOG.md)
## 开发
```bash
npm ci
npm run verify:contributor
npm run sbom > sbom.cdx.json
```
`npm run verify:contributor` 运行完整的无密钥贡献者门槛,包括格式化、依赖项许可证/通知、严格 TypeScript、所有测试、编译的运行时和文档库存一致性。请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 以获取更改信息。
## 范围和非关联
本项目与 n8n GmbH 无关,不受其赞助或认可。“n8n”仅用于标识与 n8n 产品和公共 API 的兼容性。本项目不重新分发 `n8n-nodes-base` 目录,也不将浏览器 cookie、交互式会话路由或运行时包下载用于构造一个。
v0.1.2 候选版本故意排除任意工作流执行、凭证/工作流传输、文件夹、数据表、测试评估端点和执行注释。有关保留的注释提议,请参见 [路线图](ROADMAP.md)。
## 许可证和维护者
该项目在 [MIT License](LICENSE) 下发布。第三方依赖保留其自己的许可证。
由
[Dr. Walter Zamarian Jr.](https://www.walterzamarianjr.com/) 创建和维护。
# 工具列表
## 工具列表
## 快速开始
## 安全模式
## 工具目录
### 工作流
### 执行
### 凭证
### 标签
### 用户
### 诊断和实例元数据
## 资源和提示
## 安全模型一分钟
## 文档
## 开发
## 范围和非关联