MCP¶

paperless-ngx-mcp exposes the same capability three ways: as MCP tools an agent calls, as a Python API you import, and as a CLI.

As an MCP server¶

Once deployed, the server registers consolidated, action-routed tool modules. Each module is independently togglable with a *TOOL environment flag.

As a Python API¶

from paperless_ngx_mcp.auth import get_client

api = get_client()        # reads PAPERLESS_URL / PAPERLESS_TOKEN from the environment / .env
status = api.get_system_status()

As a CLI¶

export PAPERLESS_URL="http://localhost:8080"
export PAPERLESS_TOKEN="your_token"
paperless-ngx-mcp --transport stdio