无纸化MCP
停止手动组织文档。让AI来做吧。
  
您有一个Paperless ngx实例。你有数百(数千?)份文件。你 *知道* 你应该给它们贴上标签,设置通讯员,正确地组织它们。但谁有时间呢?
PaperlessMCP将您的Paperless-ngx连接到任何兼容MCP的AI。现在,您只需问:
“查找我2023年以来的所有税务文件” “将这50张发票标记为‘业务费用’,并将对应方设置为‘Acme Corp’” “上传此收据并找出它是什么” “我的保险文件夹中缺少哪些文件?”
这是LLM类固醇上的Paperless ngx。设计的界面 *具体地* 让AI在你做任何其他事情的同时管理你的文档。
______________________________________________________________________
AI能用你的无纸化做什么?
一切。对每种实体类型进行完整的CRUD操作:
| 你说 | AI会 |
|---|---|
| “查找超过100美元的亚马逊收据” | 使用过滤器搜索文档 |
| “将所有2024年发票标记为‘2024纳税年度’” | 一次性批量更新数十份文档 |
| “上传此PDF并适当归档” | 上传、自动标记、设置通讯录 |
| “删除所有标记为“垃圾邮件”的文档” | 确认后删除(默认情况下为模拟运行) |
| “为病历创建标签,将其设置为红色” | 创建带颜色的标签 |
| “谁给我发送的文档最多?” | 按文档数量列出通讯员 |
| “为法律文档设置存储路径” | 创建有组织的文件夹结构 |
43工具 涵盖:
- 文件 --搜索、上传、下载、更新、删除、批量操作、OCR再处理
- 标签 --带有颜色和匹配规则的完整CRUD
- 记者 --追踪谁给你寄东西
- 文档类型 --对发票、收据、合同等进行分类
- 存储路径 --使用智能模板组织文件
- 自定义字段 --添加您自己的元数据(日期、金额、URL等)
所有破坏性操作都需要明确确认,并默认为干运行模式。人工智能不会意外地摧毁你的档案。
______________________________________________________________________
无纸化MCP适合您吗?
是的,如果:
- 您运行的是Paperless ngx(自托管或云)
- 您可以使用任何会说MCP(Claude或任何其他支持该协议的AI助手)的人工智能助手
- 你积压了大量未标记的文件,对此感到内疚
- 你宁愿说“组织这个”,也不愿点击47个按钮
- 您想用简单的英语查询文档
- 你认为电脑应该为你工作,而不是相反
否,如果:
- 你不使用Paperless ngx(这不是一个通用的文档工具)
- 你喜欢手动标记文档(奇怪,但尊重)
- 你不信任AI处理你的文件(这是公平的,但你可以先对所有内容进行模拟运行)
最佳点: 你有Paperless运行,你有一个兼容MCP的AI,你希望他们成为朋友。
______________________________________________________________________
入门指南
你需要
- 无纸化ngx实例 使用API令牌
*(设置→ Django管理员→ 代币→ 为您的用户创建一个)*
- 与MCP兼容的AI (克劳德桌面,或任何符合协议的东西)
选项1:Docker(推荐)
从零到与文档对话的最快路径。

docker run -d \
--name paperless-mcp \
--restart unless-stopped \
-e PAPERLESS_BASE_URL=https://your-paperless.example.com \
-e PAPERLESS_API_TOKEN=your-token-here \
-p 5000:5000 \
ghcr.io/barryw/paperlessmcp:vX.Y.Z从上面的徽章中获取版本。 我们不使用 latest 因为 您值得进行可重复的部署.将您的MCP客户端连接到 http://localhost:5000/mcp 然后开始处理你的文件。
选项2:克劳德桌面
添加到您的配置文件中:
| 操作系统 | 路径 |
|---|---|
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| 窗户 | %APPDATA%\Claude\claude_desktop_config.json |
{
"mcpServers": {
"paperless": {
"command": "dotnet",
"args": ["run", "--project", "/path/to/PaperlessMCP/PaperlessMCP", "--", "--stdio"],
"env": {
"PAPERLESS_BASE_URL": "https://your-paperless.example.com",
"PAPERLESS_API_TOKEN": "your-token-here"
}
}
}
}重新启动克劳德桌面。寻找工具图标——Paperless应该在那里。
选项3:克劳德代码
如果您已经在某处运行服务器,请执行一个命令:
# Connect to a running HTTP/SSE server
claude mcp add --transport sse paperless http://localhost:5000/mcp或者使用stdio从源代码运行:
claude mcp add --transport stdio paperless \
-e PAPERLESS_BASE_URL=https://your-paperless.example.com \
-e PAPERLESS_API_TOKEN=your-token-here \
-- dotnet run --project /path/to/PaperlessMCP/PaperlessMCP -- --stdio验证它是否存在:
claude mcp list选项4:Kubernetes
适用于跑k8s的家庭主妇。我们包括具有Kustomize支持的即用型清单。
# Clone and customize
git clone https://github.com/barryw/PaperlessMCP.git
cd PaperlessMCP/k8s
# Create your secrets
kubectl create secret generic paperless-mcp \
--from-literal=PAPERLESS_BASE_URL=https://your-paperless.example.com
kubectl create secret generic paperless-token \
--from-literal=token=your-api-token-here
# Deploy (edit the image tag first)
kubectl apply -k .包括:部署、服务、入口、Kustomization。根据口味调整。
选项5:来源
对于贡献者和修补匠:
git clone https://github.com/barryw/PaperlessMCP.git
cd PaperlessMCP
dotnet run --project PaperlessMCP # HTTP/SSE on :5000
dotnet run --project PaperlessMCP -- --stdio # stdio mode需要 .NET 10 SDK.
______________________________________________________________________
完整工具箱
43种工具,按它们所接触的东西排列。每个实体都支持完整的CRUD。
Documents — the main event
| 工具 | 它做什么 |
|---|---|
paperless.documents.search | 使用全文搜索和筛选器查找文档 |
paperless.documents.get | 按ID获取包含所有元数据的文档 |
paperless.documents.upload | 上传文档(base64) |
paperless.documents.upload_from_path | 从文件路径上传 |
paperless.documents.update | 更新标题、标签、通讯员等。 |
paperless.documents.delete | 删除文档(需要确认) |
paperless.documents.bulk_update | 一次更新多个文档 |
paperless.documents.download | 获取原始文件的下载URL |
paperless.documents.preview | 获取预览URL |
paperless.documents.thumbnail | 获取缩略图URL |
paperless.documents.reprocess | 在文档上重新运行OCR |
Tags — organize everything
| 工具 | 它做什么 |
|---|---|
paperless.tags.list | 列出所有标签 |
paperless.tags.get | 按ID获取标签 |
paperless.tags.create | 使用可选颜色和匹配规则创建标签 |
paperless.tags.update | 更新标签 |
paperless.tags.delete | 删除标签 |
paperless.tags.bulk_delete | 删除多个标签 |
Correspondents — who sends you stuff
| 工具 | 它做什么 |
|---|---|
paperless.correspondents.list | 列出所有通讯员 |
paperless.correspondents.get | 通过ID获取通讯员 |
paperless.correspondents.create | 使用可选匹配规则创建 |
paperless.correspondents.update | 更新通讯员 |
paperless.correspondents.delete | 删除通讯员 |
paperless.correspondents.bulk_delete | 删除多个通讯员 |
Document Types — invoices, receipts, contracts...
| 工具 | 它做什么 |
|---|---|
paperless.document_types.list | 列出所有文档类型 |
paperless.document_types.get | 按ID获取文档类型 |
paperless.document_types.create | 使用可选匹配规则创建 |
paperless.document_types.update | 更新文档类型 |
paperless.document_types.delete | 删除文档类型 |
paperless.document_types.bulk_delete | 删除多种文档类型 |
Storage Paths — where things live
| 工具 | 它做什么 |
|---|---|
paperless.storage_paths.list | 列出所有存储路径 |
paperless.storage_paths.get | 按ID获取存储路径 |
paperless.storage_paths.create | 使用路径模板创建 |
paperless.storage_paths.update | 更新存储路径 |
paperless.storage_paths.delete | 删除存储路径 |
paperless.storage_paths.bulk_delete | 删除多个存储路径 |
Custom Fields — your own metadata
| 工具 | 它做什么 |
|---|---|
paperless.custom_fields.list | 列出所有自定义字段定义 |
paperless.custom_fields.get | 按ID获取自定义字段 |
paperless.custom_fields.create | 创建字段(字符串、日期、数字、货币等) |
paperless.custom_fields.update | 更新字段定义 |
paperless.custom_fields.delete | 删除字段 |
paperless.custom_fields.assign | 为文档分配字段值 |
Health — is it alive?
| 工具 | 它做什么 |
|---|---|
paperless.ping | 检查连接和身份验证 |
paperless.capabilities | 列出支持的功能 |
______________________________________________________________________
配置
环境变量。就是这样。没有要管理的配置文件。
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
PAPERLESS_BASE_URL | 是 | -- | 您的无纸化ngx URL |
PAPERLESS_API_TOKEN | 是 | - | 用于身份验证的API令牌 |
MCP_PORT | 5000 | HTTP/SSE模式端口 | |
MAX_PAGE_SIZE | 100 | 每个分页请求的最大项目数 |
支持的别名: PAPERLESS_URL 和 PAPERLESS_TOKEN 如果这是你的风格,也可以工作。
______________________________________________________________________
支持项目
如果PaperlessMCP为您节省了时间,请考虑支持开发:
](https://github.com/sponsors/barryw) 
每一点都有助于保持灯亮着,提交源源不断。
______________________________________________________________________
贡献
好的,请。我们使用基于主干的开发和传统的提交。
git clone https://github.com/barryw/PaperlessMCP.git
cd PaperlessMCP
dotnet build
dotnet test规则:
- 常规承诺(
feat:,fix:,docs:等)——版本自动跳变 - 测试通过或未合并
- 破坏性行动需要
confirm=true默认情况下为干运行
看 贡献.md 完整的概述。
______________________________________________________________________
许可证
麻省理工学院 --你想做什么就做什么,别怪我。
______________________________________________________________________
