Skip to content
MCP server

Paperless-ngx

MCP server for Paperless-ngx 3.x — full REST API coverage, schema-aware, token-frugal.

Runs locallyStatus and history
Install
Pricing
Open source
Runs
Locally
Version
0.1.1
Listing updated
6 days ago

About Paperless-ngx

Paperless-ngx is an open-source MCP server. It runs locally on your machine and is started by your AI client.

Install

Run in a terminal

claude mcp add mcp-paperless-ngx --env PAPERLESS_URL='<PAPERLESS_URL>' --env PAPERLESS_TOKEN='<PAPERLESS_TOKEN>' -- npx -y mcp-paperless-ngx

Add to claude_desktop_config.json

{
  "mcpServers": {
    "mcp-paperless-ngx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "<PAPERLESS_URL>",
        "PAPERLESS_TOKEN": "<PAPERLESS_TOKEN>"
      }
    }
  }
}

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "mcp-paperless-ngx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "<PAPERLESS_URL>",
        "PAPERLESS_TOKEN": "<PAPERLESS_TOKEN>"
      }
    }
  }
}

Add to .vscode/mcp.json

{
  "servers": {
    "mcp-paperless-ngx": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "<PAPERLESS_URL>",
        "PAPERLESS_TOKEN": "<PAPERLESS_TOKEN>"
      }
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "mcp-paperless-ngx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "<PAPERLESS_URL>",
        "PAPERLESS_TOKEN": "<PAPERLESS_TOKEN>"
      }
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "mcp-paperless-ngx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "<PAPERLESS_URL>",
        "PAPERLESS_TOKEN": "<PAPERLESS_TOKEN>"
      }
    }
  }
}

Using several servers? Build one config file with the MCP config generator.

Configuration

  • PAPERLESS_URLBase URL of the Paperless-ngx instanceRequired
  • PAPERLESS_TOKENPaperless-ngx API tokenRequired
  • PAPERLESS_PUBLIC_URLURL used when building links, if the instance is reachable under a different name from outside
  • PAPERLESS_TOOLSETSComma-separated toolsets, or all
  • PAPERLESS_READ_ONLYExpose only tools that cannot change anything
  • PAPERLESS_HEADERSExtra request headers; needed behind forward-auth proxies such as Authentik
  • PAPERLESS_DOWNLOAD_DIRWhere downloaded files are written
  • PAPERLESS_MAX_PAGE_SIZEHard ceiling on list page sizes
  • PAPERLESS_TIMEOUT_MSRequest timeout in milliseconds
  • PAPERLESS_API_VERSIONREST API version sent in the Accept header

Pricing

Open source

Paperless-ngx FAQ

Is Paperless-ngx free?

Yes. Paperless-ngx is open source, so you can use and self-host it for free.

How do I add Paperless-ngx to Claude Code?

Run this command in your terminal: claude mcp add mcp-paperless-ngx --env PAPERLESS_URL='<PAPERLESS_URL>' --env PAPERLESS_TOKEN='<PAPERLESS_TOKEN>' -- npx -y mcp-paperless-ngx

Where this comes from

  • Description: from the official MCP Registry entry.
  • Install steps: from the official MCP Registry entry.

How AIPoweredBot checks servers