paperless-mcp

Overview

The paperless-mcp server enables seamless integration with Paperless-NGX document management systems, offering a rich set of tools for document operations, tag management, correspondent handling, and document type administration. Built with TypeScript and using the litemcp framework, it provides both stdio and HTTP transport modes for flexible deployment. The server implements the Paperless-NGX REST API, allowing users to perform document searches, uploads, bulk operations, and metadata management through natural language commands to AI assistants.

Try asking AI

After installing, here are 5 things you can ask your AI assistant:

• list_documentspage?: number, page_size?: number

  Get a paginated list of all documents

  Try:Show me all documentsTry:List the first 10 documents
• get_documentid: number

  Get a specific document by ID

  Try:Get document 123Try:Show me details for document 456
• search_documentsquery: string

  Full-text search across documents

  Try:Search for documents containing 'invoice'Try:Find all tax returns
• download_documentid: number, original?: boolean

  Download a document file by ID

  Try:Download document 123Try:Get original file for document 456
• bulk_edit_documentsdocuments: number[], method: string, ...additionalParams

  Perform bulk operations on multiple documents

  Try:Add tag to documents 1,2,3Try:Merge documents 4 and 5
• post_documentfile: string, filename: string, ...optionalParams

  Upload a new document to Paperless-NGX

  Try:Upload invoice.pdf as new documentTry:Create document from base64 content
• list_tags

  Get all tags

  Try:List all tagsTry:Show me all available tags
• create_tagname: string, color?: string, match?: string, matching_algorithm?: string

  Create a new tag

  Try:Create tag 'Receipts' with color #FF0000Try:Add new tag 'Urgent'
• list_correspondents

  Get all correspondents

  Try:List all correspondentsTry:Show me document senders
• create_correspondentname: string, match?: string, matching_algorithm?: string

  Create a new correspondent

  Try:Create correspondent 'ACME Corp'Try:Add new sender 'Bank XYZ'
• list_document_types

  Get all document types

  Try:List all document typesTry:Show me document categories
• create_document_typename: string, match?: string, matching_algorithm?: string

  Create a new document type

  Try:Create document type 'Invoice'Try:Add new category 'Bank Statement'

Comparable tools

Installation

npm install -g paperless-mcp

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

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

FAQ

How do I generate an API token for Paperless-NGX?

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

Can I run this MCP server in an HTTP mode?

Yes, use the `--http` flag with `npm run start` to run as an HTTP service. You can specify the port with `--port` (default: 3000).

Compare paperless-mcp with