Paperless-ngx
mcpkey · packageio.github.cubinet-code/paperless-ngx-mcp · v3.2.1
Full Paperless-ngx API for AI assistants: search, tag, edit and upload documents, workflows and more
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
#!/usr/bin/env bash # paperless-ngx (io.github.cubinet-code/paperless-ngx-mcp), 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_API_KEY -e PAPERLESS_PUBLIC_URL 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-17T23:39:57+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_API_KEY: ${PAPERLESS_API_KEY}
PAPERLESS_PUBLIC_URL: ${PAPERLESS_PUBLIC_URL}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-17T23:39:57+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_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_API_KEY
- name: PAPERLESS_PUBLIC_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_PUBLIC_URL
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
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-17T23:39:57+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_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_API_KEY
- name: PAPERLESS_PUBLIC_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: PAPERLESS_PUBLIC_URL
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
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_API_KEY, PAPERLESS_PUBLIC_URL. 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_API_KEY, PAPERLESS_PUBLIC_URL
{
"mcpServers": {
"paperless-ngx": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_API_KEY": "${PAPERLESS_API_KEY}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}"
}
}
}
}
#!/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_API_KEY=${PAPERLESS_API_KEY}" -e "PAPERLESS_PUBLIC_URL=${PAPERLESS_PUBLIC_URL}" -- npx -y [email protected]
{
"mcpServers": {
"paperless-ngx": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_API_KEY": "${PAPERLESS_API_KEY}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}"
}
}
}
}
{
"servers": {
"paperless-ngx": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"PAPERLESS_URL": "${PAPERLESS_URL}",
"PAPERLESS_API_KEY": "${PAPERLESS_API_KEY}",
"PAPERLESS_PUBLIC_URL": "${PAPERLESS_PUBLIC_URL}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.cubinet-code/paperless-ngx-mcp
- 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.