Paperless-NGX MCP 服务器使用说明

项目简介

Paperless-NGX MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在连接大型语言模型 (LLM) 客户端（如 Claude）与 Paperless-NGX 文档管理系统。通过该服务器，用户可以使用自然语言指令，让 LLM 客户端调用 Paperless-NGX 的各项功能，实现对文档、标签、通讯对象和文档类型的智能管理。

主要功能点

文档管理: 支持文档的上传、下载、搜索、批量编辑等操作。例如，可以搜索包含特定关键词的文档，下载指定ID的文档，批量添加或删除文档标签。
标签管理: 支持标签的创建和列表查看。可以创建新的标签，并设置标签的颜色和匹配规则。
通讯对象管理: 支持通讯对象的创建和列表查看。可以创建新的通讯对象。
文档类型管理: 支持文档类型的创建和列表查看。可以创建新的文档类型。
工具集成: 以工具 (Tools) 的形式向 LLM 客户端提供上述功能，方便 LLM 客户端调用。
错误处理: 提供清晰的错误信息，帮助用户诊断配置和使用问题。

安装步骤

安装 Paperless-NGX MCP 服务器: 打开终端，运行以下命令全局安装 'paperless-mcp'：
```
npm install -g paperless-mcp
```

配置 MCP 服务器到 LLM 客户端: 根据你使用的 LLM 客户端类型，编辑相应的配置文件。

Claude VSCode 扩展: 编辑 '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json' 文件。
Claude 桌面应用: 编辑 '~/Library/Application Support/Claude/claude_desktop_config.json' 文件。

在配置文件中，找到 'mcpServers' 部分（如果不存在则创建），添加以下 JSON 配置：

{
  "mcpServers": {
    "paperless": {  // "paperless" 是你为该 MCP 服务器自定义的名称，可以修改
      "command": "npx",  // 启动 MCP 服务器的命令，这里使用 npx 执行安装的 paperless-mcp
      "args": [
        "paperless-mcp",  // 执行 paperless-mcp 命令
        "http://your-paperless-instance:8000",  //  Paperless-NGX 服务器的 URL，例如 http://localhost:8000。请替换为你的 Paperless-NGX 实例地址
        "your-api-token"   // Paperless-NGX API 令牌。请替换为你生成的 API 令牌
      ]
    }
  }
}

获取 Paperless-NGX API 令牌:
- 登录你的 Paperless-NGX 实例。
- 点击右上角用户名。
- 选择 "My Profile" (我的个人资料)。
- 点击圆形箭头按钮生成新的 API 令牌。
替换占位符: 将上述 JSON 配置中的以下占位符替换为你的实际信息：
- 'http://your-paperless-instance:8000'：替换为你的 Paperless-NGX 服务器 URL (例如 'http://192.168.1.100:8000')。
- 'your-api-token'：替换为你刚刚生成的 Paperless-NGX API 令牌。

基本使用方法

配置完成后，你就可以在 Claude 等 LLM 客户端中使用自然语言指令来操作 Paperless-NGX 了。以下是一些示例：

"Show me all documents tagged as 'Invoice'" (显示所有标签为“Invoice”的文档)
"Search for documents containing 'tax return'" (搜索包含“tax return”的文档)
"Create a new tag called 'Receipts' with color #FF0000" (创建一个名为“Receipts”，颜色为 #FF0000 的新标签)
"Download document #123" (下载文档 #123)
"List all correspondents" (列出所有通讯对象)
"Create a new document type called 'Bank Statement'" (创建一个名为“Bank Statement”的新文档类型)

请注意，具体的指令方式可能因 LLM 客户端而异，请参考你使用的 LLM 客户端的文档。

关键词

Paperless-NGX MCP 服务器使用说明

项目简介

主要功能点

安装步骤

基本使用方法

信息