n8n-mcp-server API 接口详解与使用指南
2025-07-06 23:37:00作者:魏献源Searcher
项目概述
n8n-mcp-server 是一个基于 n8n 工作流自动化平台的 API 服务项目,提供了丰富的 RESTful API 接口,用于管理和操作 n8n 实例中的各种资源。通过这套 API,开发者可以以编程方式管理用户、工作流、凭证、执行记录等核心组件,实现自动化管理和集成。
API 基础信息
该 API 遵循 OpenAPI 3.0 规范,基础路径为 /api/v1
,采用 API 密钥认证方式。当前版本为 1.1.1,使用 Sustainable Use License 许可协议。
核心功能模块
1. 系统检查
系统检查功能允许管理员生成系统运行状态报告,检查潜在的问题:
/audit:
post:
summary: 生成系统状态报告
description: 可配置检查范围和标准,如设置工作流闲置天数阈值
parameters:
- daysAbandonedWorkflow: 定义多少天未执行视为闲置工作流
- categories: 指定检查类别(凭证、数据库、节点等)
2. 凭证管理
凭证是 n8n 中连接外部服务的关键配置:
/credentials:
post:
summary: 创建新凭证
description: 为特定节点类型创建认证凭证
/credentials/{id}:
delete:
summary: 删除凭证
description: 按ID删除凭证,需为凭证所有者
/credentials/schema/{credentialTypeName}:
get:
summary: 获取凭证类型Schema
description: 查询特定凭证类型的数据结构
examples:
- freshdeskApi: 需要apiKey和domain
- slackOAuth2Api: 需要clientId和clientSecret
3. 工作流管理
工作流是 n8n 的核心自动化单元:
/workflows:
post:
summary: 创建工作流
get:
summary: 获取工作流列表
parameters:
- active: 按激活状态过滤
- tags: 按标签过滤(逗号分隔)
- name: 按名称过滤
/workflows/{id}:
get:
summary: 获取单个工作流详情
put:
summary: 更新工作流
delete:
summary: 删除工作流
/workflows/{id}/activate:
post:
summary: 激活工作流
/workflows/{id}/deactivate:
post:
summary: 停用工作流
/workflows/{id}/transfer:
put:
summary: 转移工作流所有权
4. 执行记录管理
执行记录反映了工作流的运行历史和结果:
/executions:
get:
summary: 获取执行记录列表
parameters:
- status: 按状态过滤(error/success/waiting)
- workflowId: 按工作流ID过滤
/executions/{id}:
get:
summary: 获取单个执行记录详情
delete:
summary: 删除执行记录
5. 标签管理
标签用于分类和组织资源:
/tags:
post:
summary: 创建新标签
get:
summary: 获取标签列表
/tags/{id}:
get:
summary: 获取标签详情
put:
summary: 更新标签
delete:
summary: 删除标签
高级功能
分页与过滤
多个列表接口支持分页和过滤:
parameters:
- limit: 每页记录数
- cursor: 分页游标
- active: 布尔过滤条件
- tags: 多标签过滤
项目隔离
部分接口支持 projectId 参数,实现多项目环境下的资源隔离:
parameters:
- projectId: 项目标识符
最佳实践建议
-
凭证安全:通过 API 创建凭证时,确保传输层加密,并定期轮换凭证
-
工作流版本控制:更新工作流前,建议先获取当前版本作为备份
-
执行记录清理:定期清理旧的执行记录以优化存储
-
系统检查自动化:设置定期检查任务,监控系统运行状态
-
标签策略:建立统一的标签命名规范,便于资源管理
错误处理
API 遵循标准 HTTP 状态码:
- 401 Unauthorized: 认证失败
- 404 Not Found: 资源不存在
- 400 Bad Request: 请求参数错误
- 409 Conflict: 资源冲突
- 500 Internal Server Error: 服务器内部错误
总结
n8n-mcp-server 的 API 设计遵循 RESTful 原则,提供了完整的工作流自动化管理能力。通过合理利用这些接口,开发者可以构建强大的自动化运维工具,实现 n8n 实例的规模化管理和监控。建议结合具体业务场景,设计适当的调用策略和错误处理机制,确保系统的稳定性和安全性。
登录后查看全文
热门项目推荐
GLM-4.6
GLM-4.6在GLM-4.5基础上全面升级:200K超长上下文窗口支持复杂任务,代码性能大幅提升,前端页面生成更优。推理能力增强且支持工具调用,智能体表现更出色,写作风格更贴合人类偏好。八项公开基准测试显示其全面超越GLM-4.5,比肩DeepSeek-V3.1-Terminus等国内外领先模型。【此简介由AI生成】Jinja00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GLM-V
GLM-4.5V and GLM-4.1V-Thinking: Towards Versatile Multimodal Reasoning with Scalable Reinforcement LearningPython00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0107AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile010
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
209
2.21 K

暂无简介
Dart
520
115

Ascend Extension for PyTorch
Python
64
94

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
552
87

React Native鸿蒙化仓库
C++
209
285

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
978
577

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

openGauss kernel ~ openGauss is an open source relational database management system
C++
147
194