n8n-mcp-server

一个用于 n8n 工作流自动化的模型-控制器-提供者 (MCP) 服务器实现。该服务器提供了一个标准化的接口，用于通过 JSON-RPC 协议执行和管理 n8n 工作流。

特性

• 符合 JSON-RPC 2.0 标准的 API
• 工作流执行和管理
• 基于环境的配置
• TypeScript 支持
• 完善的日志记录
• Docker 支持

前提条件

• Node.js >= 14.0.0
• 正在运行且可访问的 n8n 实例
• n8n API 密钥

安装

1. 克隆仓库：

git clone https://github.com/S17S17/n8n-mcp-server.git
cd n8n-mcp-server

2. 安装依赖：

npm install

3. 配置环境变量：

cp .env.example .env
# 编辑 .env 文件进行配置

配置

服务器可以通过环境变量进行配置。请参阅 .env.example 文件获取所有可用选项。

必需的环境变量：

• N8N_URL: 您的 n8n 实例 API 的 URL
• N8N_API_KEY: 您的 n8n API 密钥
• N8N_API_HEADER: API 密钥的 Header 名称（默认：X-N8N-API-KEY）

用法

启动服务器

有几种启动选项可用：

# 标准启动
npm start

# 带有热重载的开发模式
npm run start:dev

# 简单模式（最少的功能）
npm run start:simple

# 调试模式
npm run debug

Docker 支持

使用 Docker 构建和运行：

docker build -t n8n-mcp-server .
docker run -p 3000:3000 --env-file .env n8n-mcp-server

或者使用 Docker Compose：

docker-compose up

API 文档

该服务器实现了一个 JSON-RPC 2.0 接口，具有以下方法：

• initialize: 初始化服务器连接
• shutdown: 优雅地关闭服务器
• listTools: 列出可用的工作流工具
• callTool: 执行特定的工作流工具

有关详细的 API 文档，请参阅 API.md。

开发

从源代码构建

npm run build

运行测试

npm test

代码检查

npm run lint

贡献

1. Fork 该仓库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到该分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。

支持

如需支持，请在 GitHub 仓库中打开一个 issue。