NP

nloui/paperless-mcp

开发工具

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

248 stars 85 forks 质量 65 趋势 18

一个MCP(模型上下文协议)服务器,用于与无纸化-NGX API服务器交互。该服务器提供管理文档、标签、通信件和文档类型的工具,适用于您的......

概览

一个MCP(模型上下文协议)服务器,用于与无纸化NGX的API服务器交互。该服务器提供管理无纸化NGX实例中的文档、标签、对应文件和文档类型的工具。 2. 将其添加到你的 Claude 的 MCP 配置中: 对于VSCode扩展,编辑~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json: 对于Claude桌面应用,编辑~/Library/Application Support/Claude/claude_desktop_config.json: 3. 获取你的 API 令牌:1. 登录你的 Paperless-NGX 实例 2.点击右上角的用户名 3.选择“我的个人资料” 4.点击圆形箭头按钮生成新令牌 4. 将MCP配置中的占位符替换为:- http://your-paperless-instance:8000为你的Paperless-NGX URL,your-api-token替换为你刚生成的令牌 就是这样!现在你可以请Claude帮你管理Paperless-NGX文档了。 以下是你可以让克劳德做的一些事情:

概述(AI 翻译)

一个MCP(模型上下文协议)服务器,用于与无纸化NGX的API服务器交互。该服务器提供管理无纸化NGX实例中的文档、标签、对应文件和文档类型的工具。

快速启动

安装

  1. 安装MCP服务器:

  2. 将其添加到你的 Claude 的 MCP 配置中:

对于VSCode扩展,编辑~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json:

对于Claude桌面应用,编辑~/Library/Application Support/Claude/claude_desktop_config.json:

  1. 获取你的 API 令牌:

  2. 登录你的Paperless-NGX实例

  3. 点击右上角的用户名

  4. 选择“我的个人资料”

  5. 点击圆形箭头按钮生成新代币

  6. 替换MCP配置中的占位符:

  • http://your-paperless-instance:8000 与您的 Paperless-NGX URL 关联
  • your-api-token 用你刚生成的代币

就是这样!现在你可以请Claude帮你管理Paperless-NGX文档了。

示例用法

以下是你可以让克劳德做的一些事情:

  • “显示所有标记为’发票’的文件”
  • “搜索包含’纳税申报表’的文件”

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

README

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

Paperless-NGX MCP Server

An MCP (Model Context Protocol) server for interacting with a Paperless-NGX API server. This server provides tools for managing documents, tags, correspondents, and document types in your Paperless-NGX instance.

Quick Start

Installation

  1. Install the MCP server:
npm install -g paperless-mcp
  1. Add it to your Claude’s MCP configuration:

For VSCode extension, edit ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json:

{
  "mcpServers": {
    "paperless": {
      "command": "npx",
      "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"]
    }
  }
}

For Claude desktop app, edit ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "paperless": {
      "command": "npx",
      "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"]
    }
  }
}
  1. Get your API token:

    1. Log into your Paperless-NGX instance
    2. Click your username in the top right
    3. Select “My Profile”
    4. Click the circular arrow button to generate a new token
  2. Replace the placeholders in your MCP config:

    • http://your-paperless-instance:8000 with your Paperless-NGX URL
    • your-api-token with the token you just generated

That’s it! Now you can ask Claude to help you manage your Paperless-NGX documents.

Example Usage

Here are some things you can ask Claude to do:

  • “Show me all documents tagged as ‘Invoice’”
  • “Search for documents containing ‘tax return’”
  • “Create a new tag called ‘Receipts’ with color #FF0000”
  • “Download document #123”
  • “List all correspondents”
  • “Create a new document type called ‘Bank Statement’”

Available Tools

Document Operations

list_documents

Get a paginated list of all documents.

Parameters:

  • page (optional): Page number
  • page_size (optional): Number of documents per page
list_documents({
  page: 1,
  page_size: 25
})

get_document

Get a specific document by ID.

Parameters:

  • id: Document ID
get_document({
  id: 123
})

search_documents

Full-text search across documents.

Parameters:

  • query: Search query string
search_documents({
  query: "invoice 2024"
})

download_document

Download a document file by ID.

Parameters:

  • id: Document ID
  • original (optional): If true, downloads original file instead of archived version
download_document({
  id: 123,
  original: false
})

bulk_edit_documents

Perform bulk operations on multiple documents.

Parameters:

  • documents: Array of document IDs
  • method: One of:
    • set_correspondent: Set correspondent for documents
    • set_document_type: Set document type for documents
    • set_storage_path: Set storage path for documents
    • add_tag: Add a tag to documents
    • remove_tag: Remove a tag from documents
在 GitHub 查看完整 README

安装

npx paperless-mcp http://your-paperless-instance:8000 your-api-token
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "paperless": { "command": "npx", "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"] } } }