OP

orellbuehler/paperless-mcp

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

17 stars 3 forks 质量 82 趋势 31MIT

用于无纸-ngx的MCP服务器——允许克劳德等AI代理搜索,上传,标记,以及组织您的文档,附带可选的本地语义搜索

概览

连接AI代理到无纸-ngx. 这个模型上下文协议服务器将无纸-ngx REST API暴露为115+工具,因此克洛德等助手可以搜索,上传,标记,整理您的文档——可以使用本地向量嵌入在您整个档案上的可选语义搜索. 与任何MCP客户端合作:克洛德代码,克洛德桌面,或你自己的代理. - 搜索、上传、下载、更新和批量编辑文档;管理标签、通讯员、文档类型、存储路径、自定义字段,并保存视图--与OpenAI或Ollama嵌入物的矢量相似性搜索,储存在sqlite-vec本地;没有外部矢量DB-——自动对文档进行分类,按内容处理收件箱、批量标签-——配置邮件账户和规则,创建公共共享链接、电子邮件文档,并从垃圾中恢复-文件版本、PDF编辑、共享捆绑和任务管理,REST API版本以 2.x和3为标注.

概述(AI 翻译)

连接AI代理到无纸-ngx. 这个模型上下文协议服务器将无纸-ngx REST API暴露为115+工具,因此克洛德等助手可以搜索,上传,标记,整理您的文档——可以使用本地向量嵌入在您整个档案上的可选语义搜索.

与任何MCP客户端合作:克洛德代码,克洛德桌面,或你自己的代理.

□ 重点

  • ** 全部文档管理**——搜索、上传、下载、更新和批量编辑文档;管理标签、通讯员、文档类型、存储路径、自定义字段和保存视图
  • ** 语义搜索( 可选的) ** —— 有 OpenAI 或 Ollama 嵌入的矢量相似性搜索, 本地存储在 sqlite- vec; 无外部矢量 DB
  • AI辅助工作流程——自动分类文档,按内容处理收件箱和批量标签
  • 邮件、共享和垃圾——配置邮件账户和规则,创建公共共享链接、电子邮件文档,并从垃圾中恢复
  • Paperless-ngx 3.0已备妥——文档版本,PDF编辑,共享捆绑,任务管理,而REST API版本被钉住如此 2.x 和 3.x 都具有可预期的表现

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

paperless-mcp

Connect AI agents to Paperless-ngx. This Model Context Protocol server exposes the Paperless-ngx REST API as 115+ tools, so assistants like Claude can search, upload, tag, and organize your documents — with optional semantic search over your whole archive using local vector embeddings.

Works with any MCP client: Claude Code, Claude Desktop, or your own agent.

Highlights

  • Full document management — search, upload, download, update, and bulk-edit documents; manage tags, correspondents, document types, storage paths, custom fields, and saved views
  • Semantic search (optional) — vector similarity search with OpenAI or Ollama embeddings, stored locally in sqlite-vec; no external vector DB
  • AI-assisted workflows — auto-classify documents, process your inbox, bulk-tag by content
  • Mail, sharing, and trash — configure mail accounts and rules, create public share links, email documents, and restore from the trash
  • Paperless-ngx 3.0 ready — document versions, PDF editing, share bundles, and task management, with the REST API version pinned so 2.x and 3.x both behave predictably
  • Single- or multi-user — stdio transport for personal use, or an HTTP transport where every user authenticates with their own Paperless token and only sees their own documents
  • Docker-ready — prebuilt image on GHCR, drop-in sidecar for your Paperless-ngx compose stack

Things you can ask once it’s connected:

“Find all invoices from my ISP in 2025 and tag them as telecom”

“Upload this PDF, set the correspondent to my landlord, and file it as a contract”

“Which documents in my inbox are missing a correspondent or document type?”

“Give me just the page of my insurance policy that mentions the deductible, as a PDF”

“Find the document about the espresso machine warranty” (semantic search — no keyword match needed)

Quick start

The package is published as @orellbuehler/paperless-mcp and runs directly with npx — no clone or build needed.

  1. Get your API token from Paperless-ngx (Settings > Administration, or POST /api/token/)
  2. Register the server with your MCP client. With Claude Code:
claude mcp add paperless \
  --env PAPERLESS_URL=https://your-paperless-instance.example.com \
  --env PAPERLESS_TOKEN=your-api-token \
  -- npx -y @orellbuehler/paperless-mcp
在 GitHub 查看完整 README

安装

npx -y @orellbuehler/paperless-mcp
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "paperless": { "command": "npx", "args": ["-y", "@orellbuehler/paperless-mcp"], "env": { "PAPERLESS_URL": "https://your-paperless-instance.example.com", "PAPERLESS_TOKEN": "your-api-token" } } } }