内容
# n8n MCP 服务器
[](https://github.com/NumicaTech/n8n-io-mcp-server/actions/workflows/ci.yml)
[](https://github.com/NumicaTech/n8n-io-mcp-server/actions/workflows/publish.yml)
[](https://badge.fury.io/js/@numica%2Fn8n-io-mcp-server)
[](https://nodejs.org/)
一个模型上下文协议（MCP）服务器，提供用于发现和探索 n8n 工作流模板的工具，这些模板来自 n8n 社区画廊，网址为 https://n8n.io/workflows/。该服务器使 AI 助手能够通过标准化的接口搜索和检索工作流模板。
## 快速开始
立即开始！无需设置或凭证 - 只需运行服务器并开始探索 n8n 工作流模板。
### 1. 运行服务器
```bash
# 直接使用 npx 运行（推荐 - 始终使用最新版本）
npx -y @numica/n8n-io-mcp-server@latest
```
### 2. 配置您的 MCP 客户端
将以下内容添加到您的 MCP 客户端配置中（例如，Claude Desktop）：
```json
{
"mcpServers": {
"n8n-io-mcp-server": {
"command": "npx",
"args": ["-y", "@numica/n8n-io-mcp-server@latest"]
}
}
}
```
### 3. 开始使用
服务器提供两个主要工具：
- **`search-templates`** - 搜索数千个 n8n 工作流模板
- **`get-template`** - 按 ID 获取完整的工作流详细信息
就是这样！无需个人 n8n 实例或凭证 - 服务器访问公开可用的模板。
## 功能
- **模板发现**：搜索整个 n8n 社区模板库
- **搜索功能**：跨工作流名称、描述和节点类型进行搜索
- **详细检索**：获取包括节点、连接和配置在内的完整工作流定义
- **性能优化**：缓存以提高搜索性能并减少 API 调用
- **社区关注**：访问 n8n 社区共享的数千个公共工作流模板
## 可用工具
### 模板发现工具
- `search-templates` - 搜索 n8n 工作流模板
- 搜索工作流名称、描述和节点类型
- 返回具有工作流摘要的优化结果
- 支持自定义结果限制（1-100 个模板）
- `get-template` - 检索特定工作流模板的完整详细信息
- 获取包括所有节点和连接在内的完整工作流定义
- 完整的节点配置和参数设置
- 即将导入的工作流结构
- 详细的元数据和创建者信息
## 安装
### 全局安装
```bash
# 全局安装以重复使用
npm install -g @numica/n8n-io-mcp-server
```
### 从源代码安装
```bash
git clone https://github.com/NumicaTech/n8n-io-mcp-server.git
cd n8n-io-mcp-server
npm install
npm run build
```
## 使用
### 命令行
```bash
# 运行 MCP 服务器（推荐 - 始终是最新的）
npx -y @numica/n8n-io-mcp-server@latest
# 或全局安装后
n8n-io-mcp-server
# 或运行特定版本
npx @numica/n8n-io-mcp-server@0.1.0
```
### 配置
服务器连接到公共 n8n.io API 以访问工作流模板。无需个人 n8n 实例或凭证，因为它只访问公开可用的模板。
#### 环境变量
服务器使用以下环境变量进行配置：
- `N8N_API_BASE_URL` - n8n API 的基准 URL（默认为 `https://api.n8n.io/api`）
- 生产环境下，应使用默认值
- 自定义 URL 主要用于开发环境
#### API 端点
服务器访问以下 n8n.io API 端点：
- `{baseUrl}/templates/search` - 用于搜索工作流模板
- `{baseUrl}/templates/workflows/{workflowId}` - 用于检索特定工作流详细信息
无需额外配置 - 服务器开箱即用，默认设置即可正常运行。
## 要求
- Node.js >= 18.0.0
- 连接到 n8n.io 公共 API 的互联网连接
- 无需个人 n8n 实例或凭证
## 开发
该服务器使用 [mcp-framework](https://github.com/QuantGeekDev/mcp-framework) 构建，提供一种结构化的方法来开发模型上下文协议服务器。
### 设置
```bash
npm install
npm run dev
```
### 构建
```bash
npm run build
```
### 脚本
- `npm run build` - 将 TypeScript 构建为 JavaScript
- `npm start` - 启动 MCP 服务器
## 贡献
我们欢迎贡献！该项目使用 GitHub Actions 进行自动部署。
### 开发工作流程
1. **Fork 仓库** 并克隆您的 fork
2. **从 `main` 分支创建功能分支**：
```bash
git checkout -b feature/your-feature-name
```
3. **进行更改** 并确保遵循编码标准
4. **构建您的更改**：
```bash
npm run build
```
5. **提交您的更改** 并附上清晰的提交消息
6. **推送到您的 fork** 并创建拉取请求
### 自动部署
- **持续集成**：所有拉取请求和推送到 `main` 分支都会自动运行 CI，涵盖 Node.js 版本 16、18 和 20
- **自动 NPM 发布**：创建新的 GitHub 发布会自动部署到 NPM
- **版本管理**：确保 `package.json` 版本与您的发布标签匹配
### 创建发布版本
1. 更新 `package.json` 中的版本：
```bash
npm version patch # 或 minor, major
```
2. 推送更改和标签：
```bash
git push origin main --tags
```
3. 使用推送的标签创建 GitHub 发布版本
4. GitHub Action 会自动发布到 NPM
## 许可证
MIT
## 支持
如有问题和疑问，请使用 GitHub 问题跟踪器。
## 免责声明
此 MCP 服务器使用 n8n.io 的 API，该 API 未被官方记录，可能会随时更改或中断。虽然我们会监控更改并尝试尽快适应任何修改，但由于上游 API 更改，可能会有功能暂时不可用的情况。如遇问题，请通过 GitHub 问题跟踪器报告，以便我们及时解决。
MCP 市场