使用说明
n8n mcp服务器
用于n8n工作流自动化的模型控制器提供程序(MCP)服务器实现。该服务器提供了一个标准化的接口,用于通过JSON-RPC协议执行和管理n8n工作流。
特性
- 符合JSON-RPC 2.0标准的API
- 工作流执行和管理
- 基于环境的配置
- TypeScript支持
- 综合录井
- Docker支持
先决条件
- Node.js>=14.0.0
- n8n实例正在运行且可访问
- n8n API密钥
安装
- 克隆存储库:
git clone https://github.com/S17S17/n8n-mcp-server.git
cd n8n-mcp-server
- 安装依赖项:
npm install
- 配置环境变量:
cp .env.example .env
# Edit .env with your configuration
配置
服务器可以通过环境变量进行配置。看 .env.example 所有可用选项。
所需的环境变量:
N8N_URL:n8n实例API的URLN8N_API_KEY:n8n API密钥N8N_API_HEADER:API密钥的头名称(默认值:X-N8N-API-key)
用法
启动服务器
有几个启动选项可供选择:
# Standard start
npm start
# Development mode with hot reload
npm run start:dev
# Simple mode (minimal features)
npm run start:simple
# Debug mode
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的详细文档。
发展
从源头构建
npm run build
运行测试
npm test
代码检查
npm run lint
贡献
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
支持
如需支持,请在GitHub存储库中打开问题。
