使用说明
项目简介
本项目是 Paperless-ngx 文档管理系统与 n8n 工作流自动化工具的集成方案,基于 Model Context Protocol (MCP) 构建。它允许支持 MCP 协议的 AI 模型以标准化的方式与 Paperless-ngx 和 n8n 系统进行交互,实现智能文档处理和工作流程自动化。
主要功能点
- 文档信息查询: AI 模型可以通过 MCP 接口查询 Paperless-ngx 中存储的文档信息,包括元数据和内容,用于检索特定文档或获取文档列表。
- 工作流自动化: AI 模型可以触发 n8n 中预定义的工作流程,实现基于文档事件的自动化操作,例如,当 Paperless-ngx 中新增文档时,自动启动 n8n 工作流进行后续处理。
- 文档分析: AI 模型可以利用集成的功能分析 Paperless-ngx 中的文档内容,例如提取关键信息、进行文档摘要或分类等。
安装步骤
-
克隆仓库
git clone https://github.com/PDangelmaier/paperless-ngx-n8n-integration.git cd paperless-ngx-n8n-integration -
安装 MCP Python SDK
pip install mcp-sdk -
配置环境变量 需要设置 Paperless-ngx 和 n8n 实例的 API URL 和 API Key,用于 MCP 服务器与这两个系统进行安全通信。具体环境变量包括 'PAPERLESS_NGX_API_URL', 'PAPERLESS_NGX_API_KEY', 'N8N_API_URL', 和 'N8N_API_KEY'。
export PAPERLESS_NGX_API_URL="你的Paperless-ngx API URL" export PAPERLESS_NGX_API_KEY="你的Paperless-ngx API Key" export N8N_API_URL="你的n8n API URL" export N8N_API_KEY="你的n8n API Key" -
运行 MCP 服务器
python mcp_server.py
服务器配置 (MCP 客户端)
要将此 MCP 服务器连接到 MCP 客户端(如支持 MCP 的 AI 应用),您需要提供以下配置信息。这些信息通常以 JSON 格式配置在 MCP 客户端中。
{ "serverName": "paperless-ngx-n8n-mcp-server", "command": "python", "args": ["mcp_server.py"], "description": "Paperless-ngx 和 n8n 集成的 MCP 服务器" }
- 'serverName': 自定义的服务器名称,用于在客户端中标识此连接。例如: '"paperless-ngx-n8n-mcp-server"'。
- 'command': 启动服务器的命令。这里使用 'python' 解释器。
- 'args': 命令参数,指定执行 'mcp_server.py' 脚本。
- 'description': 服务器的简要描述,可选。
基本使用方法
配置完成后,在 MCP 客户端中,您可以向 AI 模型发出自然语言指令,指示其与 Paperless-ngx 和 n8n 系统交互。例如:
- “查找 Paperless-ngx 中所有关于 '合同' 的文档” (文档信息查询)
- “当 Paperless-ngx 收到新的 '发票' 文档时,启动 n8n 中名为 '发票处理' 的工作流” (工作流自动化)
- “分析 Paperless-ngx 中最新的 '报销单' 文档,提取报销总金额” (文档分析)
AI 模型将通过 MCP 协议与此服务器通信,服务器会根据请求调用 Paperless-ngx 和 n8n 的 API,并将结果返回给 AI 模型。
信息
分类
生产力应用