Skip to content
VS Code

Paperless-ngx for VS Code

io.github.tobee89/mcp-paperless-ngx

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

client:VS Code transport:stdio runtime:npm

Install Paperless-ngx in VS Code

.vscode/mcp.json

{
  "inputs": [
    {
      "type": "promptString",
      "id": "paperless-url",
      "description": "PAPERLESS_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-token",
      "description": "PAPERLESS_TOKEN",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-public-url",
      "description": "PAPERLESS_PUBLIC_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-toolsets",
      "description": "PAPERLESS_TOOLSETS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-read-only",
      "description": "PAPERLESS_READ_ONLY",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-headers",
      "description": "PAPERLESS_HEADERS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-download-dir",
      "description": "PAPERLESS_DOWNLOAD_DIR",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-max-page-size",
      "description": "PAPERLESS_MAX_PAGE_SIZE",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-timeout-ms",
      "description": "PAPERLESS_TIMEOUT_MS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "paperless-api-version",
      "description": "PAPERLESS_API_VERSION",
      "password": true
    }
  ],
  "servers": {
    "mcp-paperless-ngx": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "mcp-paperless-ngx"
      ],
      "env": {
        "PAPERLESS_URL": "${input:paperless-url}",
        "PAPERLESS_TOKEN": "${input:paperless-token}",
        "PAPERLESS_PUBLIC_URL": "${input:paperless-public-url}",
        "PAPERLESS_TOOLSETS": "${input:paperless-toolsets}",
        "PAPERLESS_READ_ONLY": "${input:paperless-read-only}",
        "PAPERLESS_HEADERS": "${input:paperless-headers}",
        "PAPERLESS_DOWNLOAD_DIR": "${input:paperless-download-dir}",
        "PAPERLESS_MAX_PAGE_SIZE": "${input:paperless-max-page-size}",
        "PAPERLESS_TIMEOUT_MS": "${input:paperless-timeout-ms}",
        "PAPERLESS_API_VERSION": "${input:paperless-api-version}"
      }
    }
  }
}

VS Code prompts for each input the first time the server starts, so no secret is written to the file. VS Code docs

Paperless-ngx in other clients