Paperless-ngx
mcpkey · packageio.github.tobee89/mcp-paperless-ngx · v0.1.1
MCP server for Paperless-ngx 3.x — full REST API coverage, schema-aware, token-frugal.
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
# once, as root:
# as_mcp DIR COMMAND...: runs COMMAND as the mcp user in DIR, its home, sandboxed as the
# units are: a package's install scripts can write to DIR only, as the server later can
as_mcp() {
local dir="$1"; shift
systemd-run --quiet --wait --pipe --collect --uid=mcp --gid=mcp \
-p WorkingDirectory="$dir" -p Environment=HOME="$dir" -p ReadWritePaths="$dir" \
-p NoNewPrivileges=true -p ProtectSystem=strict -p ProtectHome=true -p PrivateTmp=true \
-- "$@" </dev/null
}
install -d -m 0750 -o mcp -g mcp /var/lib/mcp/paperless-ngx
# paperless-ngx: its packages, installed whole before its unit starts (no session installs)
# npx takes a half-installed tree for installed: a rerun starts them afresh
systemctl stop mcp-my-agent-paperless-ngx.service 2>/dev/null || true
as_mcp /var/lib/mcp/paperless-ngx rm -rf /var/lib/mcp/paperless-ngx/.npm/_npx
as_mcp /var/lib/mcp/paperless-ngx npx --yes [email protected] -- true
as_mcp /var/lib/mcp/paperless-ngx npx --yes --package=supergateway@4 -- true
#!/usr/bin/env bash
# paperless-ngx (io.github.tobee89/mcp-paperless-ngx), recipe baremetal (generated).
# Generated by Hub for toolset "my-agent"; started by mcp-my-agent-paperless-ngx.service.
set -euo pipefail
export HOST=127.0.0.1 PORT=8101
exec npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz
[Unit]
Description=MCP server paperless-ngx (toolset my-agent), generated by Hub
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=mcp
Group=mcp
EnvironmentFile=/etc/mcp/my-agent.env
Environment=HOME=/var/lib/mcp/paperless-ngx
WorkingDirectory=/var/lib/mcp/paperless-ngx
ExecStart=/opt/mcp/my-agent/bin/paperless-ngx.sh
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
ReadWritePaths=/var/lib/mcp/paperless-ngx
[Install]
WantedBy=multi-user.target
generated from the record, not tested yet
docker run --rm -p 127.0.0.1:8101:8000 -e PAPERLESS_URL -e PAPERLESS_TOKEN -e PAPERLESS_PUBLIC_URL -e PAPERLESS_TOOLSETS -e PAPERLESS_READ_ONLY -e PAPERLESS_HEADERS -e PAPERLESS_DOWNLOAD_DIR -e PAPERLESS_MAX_PAGE_SIZE -e PAPERLESS_TIMEOUT_MS -e PAPERLESS_API_VERSION node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y [email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T18:02:54+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
paperless-ngx:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
PAPERLESS_URL: ${PAPERLESS_URL}
PAPERLESS_TOKEN: ${PAPERLESS_TOKEN}
PAPERLESS_PUBLIC_URL: ${PAPERLESS_PUBLIC_URL}
PAPERLESS_TOOLSETS: ${PAPERLESS_TOOLSETS}
PAPERLESS_READ_ONLY: ${PAPERLESS_READ_ONLY}
PAPERLESS_HEADERS: ${PAPERLESS_HEADERS}
PAPERLESS_DOWNLOAD_DIR: ${PAPERLESS_DOWNLOAD_DIR}
PAPERLESS_MAX_PAGE_SIZE: ${PAPERLESS_MAX_PAGE_SIZE}
PAPERLESS_TIMEOUT_MS: ${PAPERLESS_TIMEOUT_MS}
PAPERLESS_API_VERSION: ${PAPERLESS_API_VERSION}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T18:02:54+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: paperless-ngx
namespace: mcp
labels: &id001
app: paperless-ngx
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: paperless-ngx
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: PAPERLESS_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_URL
- name: PAPERLESS_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TOKEN
- name: PAPERLESS_PUBLIC_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_PUBLIC_URL
- name: PAPERLESS_TOOLSETS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TOOLSETS
- name: PAPERLESS_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_READ_ONLY
- name: PAPERLESS_HEADERS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_HEADERS
- name: PAPERLESS_DOWNLOAD_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_DOWNLOAD_DIR
- name: PAPERLESS_MAX_PAGE_SIZE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_MAX_PAGE_SIZE
- name: PAPERLESS_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TIMEOUT_MS
- name: PAPERLESS_API_VERSION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_API_VERSION
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: paperless-ngx
namespace: mcp
spec:
selector:
app: paperless-ngx
ports:
- port: 8000
targetPort: http
name: http
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T18:02:54+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
paperless-ngx:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: paperless-ngx
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: PAPERLESS_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_URL
- name: PAPERLESS_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TOKEN
- name: PAPERLESS_PUBLIC_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_PUBLIC_URL
- name: PAPERLESS_TOOLSETS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TOOLSETS
- name: PAPERLESS_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_READ_ONLY
- name: PAPERLESS_HEADERS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_HEADERS
- name: PAPERLESS_DOWNLOAD_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_DOWNLOAD_DIR
- name: PAPERLESS_MAX_PAGE_SIZE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_MAX_PAGE_SIZE
- name: PAPERLESS_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_TIMEOUT_MS
- name: PAPERLESS_API_VERSION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_API_VERSION
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: PAPERLESS_URL, PAPERLESS_TOKEN, PAPERLESS_PUBLIC_URL, PAPERLESS_TOOLSETS, PAPERLESS_READ_ONLY, PAPERLESS_HEADERS, PAPERLESS_DOWNLOAD_DIR, PAPERLESS_MAX_PAGE_SIZE, PAPERLESS_TIMEOUT_MS, PAPERLESS_API_VERSION. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y [email protected] # env: PAPERLESS_URL, PAPERLESS_TOKEN, PAPERLESS_PUBLIC_URL, PAPERLESS_TOOLSETS, PAPERLESS_READ_ONLY, PAPERLESS_HEADERS, PAPERLESS_DOWNLOAD_DIR, PAPERLESS_MAX_PAGE_SIZE, PAPERLESS_TIMEOUT_MS, PAPERLESS_API_VERSION
{
"mcpServers": {
"paperless-ngx": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_TOKEN": "${PAPERLESS_TOKEN}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}",
"PAPERLESS_TOOLSETS": "${PAPERLESS_TOOLSETS}",
"PAPERLESS_READ_ONLY": "${PAPERLESS_READ_ONLY}",
"PAPERLESS_HEADERS": "${PAPERLESS_HEADERS}",
"PAPERLESS_DOWNLOAD_DIR": "${PAPERLESS_DOWNLOAD_DIR}",
"PAPERLESS_MAX_PAGE_SIZE": "${PAPERLESS_MAX_PAGE_SIZE}",
"PAPERLESS_TIMEOUT_MS": "${PAPERLESS_TIMEOUT_MS}",
"PAPERLESS_API_VERSION": "${PAPERLESS_API_VERSION}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add paperless-ngx -e "PAPERLESS_URL=${PAPERLESS_URL}" -e "PAPERLESS_TOKEN=${PAPERLESS_TOKEN}" -e "PAPERLESS_PUBLIC_URL=${PAPERLESS_PUBLIC_URL}" -e "PAPERLESS_TOOLSETS=${PAPERLESS_TOOLSETS}" -e "PAPERLESS_READ_ONLY=${PAPERLESS_READ_ONLY}" -e "PAPERLESS_HEADERS=${PAPERLESS_HEADERS}" -e "PAPERLESS_DOWNLOAD_DIR=${PAPERLESS_DOWNLOAD_DIR}" -e "PAPERLESS_MAX_PAGE_SIZE=${PAPERLESS_MAX_PAGE_SIZE}" -e "PAPERLESS_TIMEOUT_MS=${PAPERLESS_TIMEOUT_MS}" -e "PAPERLESS_API_VERSION=${PAPERLESS_API_VERSION}" -- npx -y [email protected]
{
"mcpServers": {
"paperless-ngx": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_TOKEN": "${PAPERLESS_TOKEN}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}",
"PAPERLESS_TOOLSETS": "${PAPERLESS_TOOLSETS}",
"PAPERLESS_READ_ONLY": "${PAPERLESS_READ_ONLY}",
"PAPERLESS_HEADERS": "${PAPERLESS_HEADERS}",
"PAPERLESS_DOWNLOAD_DIR": "${PAPERLESS_DOWNLOAD_DIR}",
"PAPERLESS_MAX_PAGE_SIZE": "${PAPERLESS_MAX_PAGE_SIZE}",
"PAPERLESS_TIMEOUT_MS": "${PAPERLESS_TIMEOUT_MS}",
"PAPERLESS_API_VERSION": "${PAPERLESS_API_VERSION}"
}
}
}
}
{
"servers": {
"paperless-ngx": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_TOKEN": "${PAPERLESS_TOKEN}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}",
"PAPERLESS_TOOLSETS": "${PAPERLESS_TOOLSETS}",
"PAPERLESS_READ_ONLY": "${PAPERLESS_READ_ONLY}",
"PAPERLESS_HEADERS": "${PAPERLESS_HEADERS}",
"PAPERLESS_DOWNLOAD_DIR": "${PAPERLESS_DOWNLOAD_DIR}",
"PAPERLESS_MAX_PAGE_SIZE": "${PAPERLESS_MAX_PAGE_SIZE}",
"PAPERLESS_TIMEOUT_MS": "${PAPERLESS_TIMEOUT_MS}",
"PAPERLESS_API_VERSION": "${PAPERLESS_API_VERSION}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.tobee89/mcp-paperless-ngx
- not probed yet: tools unpinned, ingest lists them
tools
Not probed yetThe tools appear once the hub or its worker has listed this entry. Running it still works: your client lists them on first start.