NP

nloui/paperless-mcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

247 stars 84 forks Качество 65 Тренд 18

Сервер MCP (Model Context Protocol) для взаимодействия с сервером Paperless-NGX API. Этот сервер предоставляет инструменты для управления документами, тегами, корреспондентами и типами документов в ваших...

Обзор

Сервер MCP (Model Context Protocol) для взаимодействия с сервером Paperless-NGX API. Этот сервер предоставляет инструменты для управления документами, тегами, корреспондентами и типами документов в вашем экземпляре Paperless-NGX. 2. Добавьте его в конфигурацию вашего Claude's 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 - ваш-api-токен на токен, который вы только что сгенерировали Вот и всё! Теперь вы можете попросить Клода помочь вам управлять вашими документами Paperless-NGX. Вот несколько вещей, которые вы можете попросить Клода сделать:

Обзор (машинный перевод)

Сервер MCP (Model Context Protocol) для взаимодействия с сервером Paperless-NGX API. Этот сервер предоставляет инструменты для управления документами, тегами, корреспондентами и типами документов в вашем экземпляре Paperless-NGX.

Быстрый старт

Установка

  1. Установите MCP-сервер:

  2. Добавьте его в конфигурацию вашего Claude’s 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 с вашим URL Paperless-NGX
  • your-api-token с токеном, который вы только что сгенерировали

Вот и всё! Теперь вы можете попросить Клода помочь вам управлять вашими документами Paperless-NGX.

Пример использования

Вот несколько вещей, которые вы можете попросить Клода сделать:

  • «Покажите все документы с тегом ‘Счет’»
  • «Поиск документов, содержащих «налоговую декларацию»»

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

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
Открыть полный README на GitHub

Установка

npx paperless-mcp http://your-paperless-instance:8000 your-api-token
Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

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