使用说明
n8n MCP服务器
一种模型上下文协议(MCP)服务器,通过Smithery模型上下文协议直接在LLM和AI代理中实现n8n工作流的无缝管理。
特性
- 列出n8n中的可用工作流
- 查看工作流详细信息
- 执行工作流
- 监控工作流执行
- 将参数传递给工作流
- 用于AI代理的MCP兼容接口
入门指南
快速开始
-
安装软件包
npm install @dopehunter/n8n-mcp-server -
创建.env文件
cp .env.example .env -
配置您的n8n连接 编辑
.env文件和设置:N8N_BASE_URL:指向n8n实例的URL(例如。,http://localhost:5678/api)N8N_API_KEY:n8n API密钥(在n8n设置中生成此密钥)
-
启动服务器
npm start -
测试服务器
curl -X POST http://localhost:3000/mcp -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","id":"1","method":"mcp.tools.list","params":{}}'
常见问题及排除方法
- 连接被拒绝错误:确保您的n8n实例正在运行,并且可以通过n8n_BASE_URL中指定的URL访问
- API关键问题:验证n8n API密钥是否正确并且具有适当的权限
- Docker问题:在尝试构建或运行Docker镜像之前,请确保Docker正在运行
有关更详细的故障排除,请参阅 故障排除指南.
组件
工具
-
n8n_list_工作流
- 列出n8n实例中的所有工作流
- 输入:无
-
n8n_get_工作流
- 获取特定工作流的详细信息
- 输入:
workflowId(字符串,必填):要检索的工作流的ID
-
n8n_执行_工作流
- 执行n8n工作流
- 输入:
workflowId(字符串,必填):要执行的工作流的IDdata(对象,可选):要传递到工作流的数据
-
n8n_get执行
- 获取工作流的执行历史记录
- 输入:
workflowId(string,必填):用于获取执行的工作流的IDlimit(number,可选):要返回的最大执行次数
-
n8n_activate_工作流
- 激活工作流
- 输入:
workflowId(字符串,必填):要激活的工作流的ID
-
n8n-deactivate_工作流
- 停用工作流
- 输入:
workflowId(字符串,必填):要停用的工作流的ID
先决条件
- Node.js(v14+)
- 具有API访问权限的n8n实例
- 支持模型上下文协议的LLM或AI代理
配置选项
Docker配置
{
"mcpServers": {
"n8n": {
"command": "docker",
"args": ["run", "-i", "--rm", "--init", "-e", "N8N_API_KEY=$N8N_API_KEY", "-e", "N8N_BASE_URL=$N8N_BASE_URL", "mcp/n8n-mcp-server"]
}
}
}
NPX配置
{
"mcpServers": {
"n8n": {
"command": "npx",
"args": ["-y", "@dopehunter/n8n-mcp-server"]
}
}
}
安装
NPM
npm install @dopehunter/n8n-mcp-server
直接使用npx
npx @dopehunter/n8n-mcp-server
来源
git clone https://github.com/dopehunter/n8n_MCP_server_complete.git
cd n8n_MCP_server_complete
npm install
cp .env.example .env
# Edit the .env file with your n8n API details
发展
启动开发服务器:
npm run start:dev
构建项目:
npm run build
运行测试:
npm test
与Claude或其他LLM一起使用
-
启动MCP服务器:
npm start -
配置LLM客户端以使用MCP服务器:
- 对于Claude Desktop,请使用“配置选项”部分中的配置。
- 对于其他客户端,请指向服务器URL(例如。,
http://localhost:3000/mcp).
-
LLM现在可以直接通过MCP命令使用n8n工作流。
构建Docker镜像
docker build -t mcp/n8n-mcp-server .
API文档
请参阅 API文档 了解可用MCP功能的详细信息。
贡献
欢迎投稿!请随时提交拉取请求。
许可证
该项目根据ISC许可证获得许可。
