Paperless MCP

{
  "name": "io.github.pvliesdonk/paperless-mcp",
  "title": "Paperless MCP",
  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
  "version": "3.0.0",
  "packages": [
    {
      "version": "3.0.0",
      "transport": {
        "type": "stdio"
      },
      "identifier": "pvliesdonk-paperless-mcp",
      "runtimeHint": "uvx",
      "registryType": "pypi",
      "environmentVariables": [
        {
          "name": "PAPERLESS_MCP_KV_STORE_URL",
          "default": "file:///data/state",
          "description": "Persistent-state backend URL shared by every pvl-core subsystem that needs state. `memory://` is in-process and lost on restart; `file:///path` persists on one server; `redis://`, `dynamodb://` and `mongodb://` each need their matching extra. When unset, defaults to `file:///data/state` (the volume family Docker images mount), or to `memory://` (with a warning) on a host where that directory is not usable."
        },
        {
          "name": "PAPERLESS_MCP_TOOLS_ALLOW",
          "description": "Comma-separated explicit tool names this instance exposes; every other tool is hidden from listings and cannot be invoked. Names matching no registered tool are inert. Mutually exclusive with `tools_deny`. Takes effect through `apply_tool_visibility`."
        },
        {
          "name": "PAPERLESS_MCP_TOOLS_DENY",
          "description": "Comma-separated explicit tool names hidden from this instance (absent from listings, cannot be invoked). Names matching no registered tool are inert. Mutually exclusive with `tools_allow`. Takes effect through `apply_tool_visibility`."
        },
        {
          "name": "PAPERLESS_MCP_SERVER_NAME",
          "description": "Rename this server instance; defaults to the project name."
        },
        {
          "name": "PAPERLESS_MCP_INSTANCE_DESCRIPTION",
          "description": "Concise routing context that distinguishes this deployment's material or responsibility."
        },
        {
          "name": "PAPERLESS_MCP_INSTRUCTIONS_EXTRA",
          "description": "Deployment-specific behavioral policy added to the generated MCP instructions."
        },
        {
          "name": "PAPERLESS_MCP_INSTRUCTIONS",
          "description": "Legacy: replaces all generated MCP instructions (deprecated; use _INSTANCE_DESCRIPTION for routing and _INSTRUCTIONS_EXTRA for policy)."
        },
        {
          "name": "PAPERLESS_MCP_LOG_LEVEL",
          "choices": [
            "DEBUG",
            "INFO",
            "WARNING",
            "ERROR",
            "CRITICAL"
          ],
          "default": "INFO",
          "description": "Log level for every logger in the process, FastMCP's included (DEBUG / INFO / WARNING / ERROR / CRITICAL). The -v CLI flag overrides to DEBUG. The unprefixed FASTMCP_LOG_LEVEL still works for one major version and logs a deprecation warning."
        },
        {
          "name": "PAPERLESS_MCP_LOG_FORMAT",
          "choices": [
            "rich",
            "json"
          ],
          "description": "Log rendering. rich is one colour event key=value line per record, for a terminal; json is one JSON object per record, for a collector. Unset picks rich when stderr is a terminal and json everywhere else, so a container or journald gets JSON with no configuration."
        },
        {
          "name": "PAPERLESS_MCP_PAPERLESS_URL",
          "description": "Base URL of the Paperless-NGX REST API, without a trailing slash. The server refuses to start without it."
        },
        {
          "name": "PAPERLESS_MCP_API_TOKEN",
          "isSecret": true,
          "description": "Paperless service-account token used for outbound API requests. The server refuses to start without it."
        },
        {
          "name": "PAPERLESS_MCP_HTTP_TIMEOUT_SECONDS",
          "format": "number",
          "default": "30.0",
          "description": "Per-request HTTP timeout in seconds."
        },
        {
          "name": "PAPERLESS_MCP_HTTP_RETRIES",
          "format": "number",
          "default": "2",
          "description": "Retries for idempotent requests after network errors or 5xx responses."
        },
        {
          "name": "PAPERLESS_MCP_DEFAULT_PAGE_SIZE",
          "format": "number",
          "default": "25",
          "description": "Default page size for list tools, from 1 through 100."
        },
        {
          "name": "PAPERLESS_MCP_PAPERLESS_PUBLIC_URL",
          "description": "Public Paperless UI URL for user-visible links; defaults to PAPERLESS_URL."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_TTL_DEFAULT_S",
          "format": "number",
          "default": "3600.0",
          "description": "Link lifetime in seconds when the caller requests no explicit TTL."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_TTL_MAX_S",
          "format": "number",
          "default": "86400.0",
          "description": "Ceiling in seconds a caller-requested link TTL is clamped to."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_GRACE_TTL_S",
          "format": "number",
          "default": "60.0",
          "description": "Post-success grace window in seconds: a served token's TTL shrinks to this so a stalled transfer can retry within it."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_LEASE_S",
          "format": "number",
          "default": "60.0",
          "description": "Crashed-handler reclaim window in seconds for an in-flight reservation."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_MAX_UPLOAD_BYTES",
          "format": "number",
          "default": "104857600",
          "description": "Maximum size in bytes of a single upload."
        }
      ]
    },
    {
      "transport": {
        "url": "http://localhost:{--port}/mcp",
        "type": "streamable-http"
      },
      "identifier": "ghcr.io/pvliesdonk/paperless-mcp:v3.0.0",
      "registryType": "oci",
      "packageArguments": [
        {
          "name": "--port",
          "type": "named",
          "default": "8000",
          "description": "Port for the HTTP transport"
        }
      ],
      "environmentVariables": [
        {
          "name": "PAPERLESS_MCP_SHUTDOWN_GRACE_S",
          "format": "number",
          "default": "3",
          "description": "Seconds SIGTERM may spend draining in-flight requests before the HTTP server exits. Keep it at or below the termination grace period the orchestrator allows. `0` drops in-flight requests immediately."
        },
        {
          "name": "PAPERLESS_MCP_BASE_URL",
          "description": "Public base URL of the deployed server, for example `https://mcp.example.com`. Required for OIDC. Also the fallback source of the MCP Apps domain when `app_domain` is unset.",
          "placeholder": "https://mcp.example.com"
        },
        {
          "name": "PAPERLESS_MCP_BEARER_TOKEN",
          "isSecret": true,
          "description": "Single shared bearer token; enables bearer auth unless `bearer_tokens_file` is set, which takes precedence.",
          "placeholder": "<secret>"
        },
        {
          "name": "PAPERLESS_MCP_OIDC_CONFIG_URL",
          "description": "OIDC discovery document URL, for example `https://auth.example.com/.well-known/openid-configuration`.",
          "placeholder": "https://auth.example.com/.well-known/openid-configuration"
        },
        {
          "name": "PAPERLESS_MCP_OIDC_CLIENT_ID",
          "description": "OIDC client identifier registered with the provider.",
          "placeholder": "mcp-client"
        },
        {
          "name": "PAPERLESS_MCP_OIDC_CLIENT_SECRET",
          "isSecret": true,
          "description": "OIDC client secret registered with the provider.",
          "placeholder": "your-client-secret"
        },
        {
          "name": "PAPERLESS_MCP_OIDC_AUDIENCE",
          "description": "Expected `aud` claim; tokens issued for another audience are rejected.",
          "placeholder": "mcp-api"
        },
        {
          "name": "PAPERLESS_MCP_OIDC_REQUIRED_SCOPES",
          "default": "openid",
          "description": "Scopes a caller must present, space- or comma-separated. Defaults to `openid` in oidc-proxy mode."
        },
        {
          "name": "PAPERLESS_MCP_OIDC_ADVERTISED_SCOPES",
          "default": "openid offline_access",
          "description": "Scopes advertised to MCP clients in protected-resource metadata, space- or comma-separated. Overrides the default `openid offline_access`; `oidc_required_scopes` is always added on top. Set this when the registered client is not permitted `offline_access`, or to have clients request extra claim scopes (such as `groups`) without also requiring them in every token."
        },
        {
          "name": "PAPERLESS_MCP_OIDC_JWT_SIGNING_KEY",
          "default": "derived",
          "isSecret": true,
          "description": "Signing key for issued tokens; used in oidc-proxy mode only. When unset, the key is derived deterministically from `oidc_client_secret`, so tokens survive a restart. Rotating that secret then invalidates every issued token. Set this explicitly to decouple token validity from secret rotation. Generate with `openssl rand -hex 32`."
        },
        {
          "name": "PAPERLESS_MCP_OIDC_VERIFY_ACCESS_TOKEN",
          "format": "boolean",
          "default": "false",
          "description": "Validate the access token instead of the id token."
        },
        {
          "name": "PAPERLESS_MCP_KV_STORE_URL",
          "default": "file:///data/state",
          "description": "Persistent-state backend URL shared by every pvl-core subsystem that needs state. `memory://` is in-process and lost on restart; `file:///path` persists on one server; `redis://`, `dynamodb://` and `mongodb://` each need their matching extra. When unset, defaults to `file:///data/state` (the volume family Docker images mount), or to `memory://` (with a warning) on a host where that directory is not usable."
        },
        {
          "name": "PAPERLESS_MCP_APP_DOMAIN",
          "description": "MCP Apps iframe domain, used for CSP sandboxing. Overrides the host derived from `base_url`."
        },
        {
          "name": "PAPERLESS_MCP_TOOLS_ALLOW",
          "description": "Comma-separated explicit tool names this instance exposes; every other tool is hidden from listings and cannot be invoked. Names matching no registered tool are inert. Mutually exclusive with `tools_deny`. Takes effect through `apply_tool_visibility`."
        },
        {
          "name": "PAPERLESS_MCP_TOOLS_DENY",
          "description": "Comma-separated explicit tool names hidden from this instance (absent from listings, cannot be invoked). Names matching no registered tool are inert. Mutually exclusive with `tools_allow`. Takes effect through `apply_tool_visibility`."
        },
        {
          "name": "PAPERLESS_MCP_AUTH_MODE",
          "description": "Explicit auth-mode override, accepting `remote` or `oidc-proxy` (case- and whitespace-insensitive). When unset the mode is auto-detected from which auth variables are set; the override exists because having all four OIDC variables set is ambiguous between those two modes. Other values are ignored with a warning."
        },
        {
          "name": "PAPERLESS_MCP_BEARER_TOKENS_FILE",
          "format": "filepath",
          "description": "Path to a TOML file mapping bearer tokens to subjects; overrides the single-token `bearer_token` mode.",
          "placeholder": "/etc/paperless-mcp/tokens.toml"
        },
        {
          "name": "PAPERLESS_MCP_BEARER_DEFAULT_SUBJECT",
          "default": "bearer-anon",
          "description": "Subject assigned to the single-token bearer mode; ignored when `bearer_tokens_file` is set, since mapped mode carries per-token subjects."
        },
        {
          "name": "PAPERLESS_MCP_SERVER_NAME",
          "description": "Rename this server instance; defaults to the project name."
        },
        {
          "name": "PAPERLESS_MCP_INSTANCE_DESCRIPTION",
          "description": "Concise routing context that distinguishes this deployment's material or responsibility."
        },
        {
          "name": "PAPERLESS_MCP_INSTRUCTIONS_EXTRA",
          "description": "Deployment-specific behavioral policy added to the generated MCP instructions."
        },
        {
          "name": "PAPERLESS_MCP_INSTRUCTIONS",
          "description": "Legacy: replaces all generated MCP instructions (deprecated; use _INSTANCE_DESCRIPTION for routing and _INSTRUCTIONS_EXTRA for policy)."
        },
        {
          "name": "PAPERLESS_MCP_HTTP_PATH",
          "default": "/mcp",
          "description": "Mount path for the MCP endpoint; the health routes derive their prefix from it."
        },
        {
          "name": "PAPERLESS_MCP_HEALTH_DETAIL",
          "choices": [
            "status",
            "standard",
            "full"
          ],
          "default": "standard",
          "description": "How much the unauthenticated /health and /health/ready bodies say: status, standard (adds name, version and per-check verdicts), or full (adds redacted reasons; trusted networks only)."
        },
        {
          "name": "PUID",
          "format": "number",
          "default": "1000",
          "description": "Run the server process as this UID; the container entrypoint reassigns ownership of writable paths to match."
        },
        {
          "name": "PGID",
          "format": "number",
          "default": "1000",
          "description": "Run the server process as this GID; pair with PUID to match the owner of a mounted volume."
        },
        {
          "name": "PAPERLESS_MCP_LOG_LEVEL",
          "choices": [
            "DEBUG",
            "INFO",
            "WARNING",
            "ERROR",
            "CRITICAL"
          ],
          "default": "INFO",
          "description": "Log level for every logger in the process, FastMCP's included (DEBUG / INFO / WARNING / ERROR / CRITICAL). The -v CLI flag overrides to DEBUG. The unprefixed FASTMCP_LOG_LEVEL still works for one major version and logs a deprecation warning."
        },
        {
          "name": "PAPERLESS_MCP_LOG_FORMAT",
          "choices": [
            "rich",
            "json"
          ],
          "description": "Log rendering. rich is one colour event key=value line per record, for a terminal; json is one JSON object per record, for a collector. Unset picks rich when stderr is a terminal and json everywhere else, so a container or journald gets JSON with no configuration."
        },
        {
          "name": "PAPERLESS_MCP_PAPERLESS_URL",
          "description": "Base URL of the Paperless-NGX REST API, without a trailing slash. The server refuses to start without it."
        },
        {
          "name": "PAPERLESS_MCP_API_TOKEN",
          "isSecret": true,
          "description": "Paperless service-account token used for outbound API requests. The server refuses to start without it."
        },
        {
          "name": "PAPERLESS_MCP_HTTP_TIMEOUT_SECONDS",
          "format": "number",
          "default": "30.0",
          "description": "Per-request HTTP timeout in seconds."
        },
        {
          "name": "PAPERLESS_MCP_HTTP_RETRIES",
          "format": "number",
          "default": "2",
          "description": "Retries for idempotent requests after network errors or 5xx responses."
        },
        {
          "name": "PAPERLESS_MCP_DEFAULT_PAGE_SIZE",
          "format": "number",
          "default": "25",
          "description": "Default page size for list tools, from 1 through 100."
        },
        {
          "name": "PAPERLESS_MCP_PAPERLESS_PUBLIC_URL",
          "description": "Public Paperless UI URL for user-visible links; defaults to PAPERLESS_URL."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_TTL_DEFAULT_S",
          "format": "number",
          "default": "3600.0",
          "description": "Link lifetime in seconds when the caller requests no explicit TTL."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_TTL_MAX_S",
          "format": "number",
          "default": "86400.0",
          "description": "Ceiling in seconds a caller-requested link TTL is clamped to."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_GRACE_TTL_S",
          "format": "number",
          "default": "60.0",
          "description": "Post-success grace window in seconds: a served token's TTL shrinks to this so a stalled transfer can retry within it."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_LEASE_S",
          "format": "number",
          "default": "60.0",
          "description": "Crashed-handler reclaim window in seconds for an in-flight reservation."
        },
        {
          "name": "PAPERLESS_MCP_TRANSFER_MAX_UPLOAD_BYTES",
          "format": "number",
          "default": "104857600",
          "description": "Maximum size in bytes of a single upload."
        }
      ]
    }
  ],
  "repository": {
    "url": "https://github.com/pvliesdonk/paperless-mcp",
    "source": "github"
  },
  "websiteUrl": "https://pvliesdonk.github.io/paperless-mcp/",
  "description": "Paperless-NGX over MCP: search, read, upload and tag documents; manage correspondents and types."
}