Paperless-NGX MCP Server logo

Paperless-NGX MCP Server

by nloui

An MCP server for interacting with a Paperless-NGX API server. It provides tools for managing documents, tags, correspondents, and document types in your Paperless-NGX instance.

View on GitHub

Last updated: N/A

What is Paperless-NGX MCP Server?

This is an MCP (Model Context Protocol) server that acts as an intermediary between a client (like Claude) and a Paperless-NGX instance. It translates requests from the client into Paperless-NGX API calls, allowing you to manage your documents and related data using natural language.

How to use Paperless-NGX MCP Server?

Install the server either via Smithery or manually using npm. Configure your client (Claude Desktop or VSCode extension) to use the server, providing your Paperless-NGX URL and API token. Then, you can interact with your Paperless-NGX instance through the client using natural language commands.

Key features of Paperless-NGX MCP Server

  • Document Management (listing, searching, downloading, bulk editing, uploading)

  • Tag Management (listing, creating)

  • Correspondent Management (listing, creating)

  • Document Type Management (listing, creating)

  • Error Handling (clear error messages for common issues)

  • Integration with Claude Desktop and VSCode extension via MCP

Use cases of Paperless-NGX MCP Server

  • Ask Claude to find all invoices from a specific vendor.

  • Create new tags for organizing your documents.

  • Bulk edit document metadata, such as assigning a document type or correspondent.

  • Upload new documents to your Paperless-NGX instance.

  • Automate document management tasks using natural language commands.

FAQ from Paperless-NGX MCP Server

What is Paperless-NGX?

Paperless-NGX is a document management system that allows you to scan, index, and archive your paper documents.

What is an MCP server?

An MCP (Model Context Protocol) server acts as an intermediary between a client and a service, allowing the client to interact with the service using natural language.

How do I get my Paperless-NGX API token?

Log into your Paperless-NGX instance, click your username, select 'My Profile', and click the circular arrow button to generate a new token.

What if I get an error message?

The server provides clear error messages. Check your Paperless-NGX URL, API token, and ensure your Paperless-NGX server is running and reachable.

Can I contribute to the development of this server?

Yes! Clone the repository, install dependencies, make your changes, and test locally. The server is built with litemcp and zod.