Paperless MCP MCP Server

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.

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`.

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`.

Rename this server instance; defaults to the project name.

Concise routing context that distinguishes this deployment's material or responsibility.

Deployment-specific behavioral policy added to the generated MCP instructions.

Legacy: replaces all generated MCP instructions (deprecated; use _INSTANCE_DESCRIPTION for routing and _INSTRUCTIONS_EXTRA for policy).

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.

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.

Base URL of the Paperless-NGX REST API, without a trailing slash. The server refuses to start without it.

Paperless service-account token used for outbound API requests. The server refuses to start without it.

Per-request HTTP timeout in seconds.

Retries for idempotent requests after network errors or 5xx responses.

Default page size for list tools, from 1 through 100.

Public Paperless UI URL for user-visible links; defaults to PAPERLESS_URL.

Link lifetime in seconds when the caller requests no explicit TTL.

Ceiling in seconds a caller-requested link TTL is clamped to.

Post-success grace window in seconds: a served token's TTL shrinks to this so a stalled transfer can retry within it.

Crashed-handler reclaim window in seconds for an in-flight reservation.

Maximum size in bytes of a single upload.

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.

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.

Single shared bearer token; enables bearer auth unless `bearer_tokens_file` is set, which takes precedence.

OIDC discovery document URL, for example `https://auth.example.com/.well-known/openid-configuration`.

OIDC client identifier registered with the provider.

OIDC client secret registered with the provider.

Expected `aud` claim; tokens issued for another audience are rejected.

Scopes a caller must present, space- or comma-separated. Defaults to `openid` in oidc-proxy mode.

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.

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`.

Validate the access token instead of the id token.

MCP Apps iframe domain, used for CSP sandboxing. Overrides the host derived from `base_url`.

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.

Path to a TOML file mapping bearer tokens to subjects; overrides the single-token `bearer_token` mode.

Subject assigned to the single-token bearer mode; ignored when `bearer_tokens_file` is set, since mapped mode carries per-token subjects.

Mount path for the MCP endpoint; the health routes derive their prefix from it.

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).

Run the server process as this UID; the container entrypoint reassigns ownership of writable paths to match.

Run the server process as this GID; pair with PUID to match the owner of a mounted volume.