What is paperless-ngx-mcp CLAUDE.md?

Project instructions for paperless-ngx-mcp, a Go server that lets an agent work with Paperless-ngx, a document-management application. They describe the project layout, development commands, tests, and document-related tools.

Use them when changing, testing, or documenting this MCP server, including its document, tag, search, download, upload, and metadata features.

They give an agent the project-specific context needed to find the right files and follow the repository’s development process.

How freeformz/paperless-ngx-mcp configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to freeformz/paperless-ngx-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/freeformz/paperless-ngx-mcp/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/freeformz/paperless-ngx-mcp

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/freeformz/paperless-ngx-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/freeformz/paperless-ngx-mcp/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/freeformz/paperless-ngx-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/freeformz/paperless-ngx-mcp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/freeformz/paperless-ngx-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/freeformz/paperless-ngx-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 875 This file is loaded in full into every session.

When invoked 875 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00875	$0.00875
Opus 5	$0.00438	$0.00438
Sonnet 5	$0.00175	$0.00175
Haiku 4.5	$0.00088	$0.00088

Measured 10d ago against content hash 7d7aba1d8820, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

paperless-ngx-mcp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 80 lines

How it starts

The opening of the file, as written. The whole thing — 80 lines — stays where its author put it; the contents beside it link to each section on GitHub.

paperless-ngx-mcp

MCP server for Paperless-ngx document management, built in Go.

Project Structure

main.go — Entry point, Cobra root command, mcp subcommand
server.go — MCP server setup, tool registration, agent instructions
client.go — Paperless-ngx HTTP client with auth, versioning, multipart upload
helpers.go — Shared helpers (errResult, jsonResult, doRequest, param helpers)
cache.go — In-memory TTL cache for metadata list endpoints
tools_documents.go — Document tool handlers (CRUD, notes, metadata, suggestions, upload, email)
tools_download.go — Document download and cleanup tool handlers
download.go — Downloader (per-instance temp dir, concurrency, file tracking)
tools_tags.go — Tag tool handlers
tools_correspondents.go — Correspondent tool handlers
tools_document_types.go — Document type tool handlers
tools_storage_paths.go — Storage path tool handlers
tools_custom_fields.go — Custom field tool handlers
tools_search.go — Search and statistics tool handlers
tools_bulk.go — Bulk operation tool handlers
tools_saved_views.go — Saved view tool handlers
tools_share_links.go — Share link tool handlers
tools_users.go — User, group, and profile tool handlers
tools_mail.go — Mail account, mail rule, and processed mail tool handlers
tools_workflows.go — Workflow, trigger, and action tool handlers
tools_system.go — System status, config, tasks, logs, and trash tool handlers
test_helpers_test.go — Shared test infrastructure (mock server, helpers)
.claude/rules/paperless.md — Rules for how Claude uses the Paperless-ngx MCP tools
.goreleaser.yaml — GoReleaser config (builds, archives, MCPB bundles)
Makefile — Build, test, and release tasks
.github/workflows/ — CI (test on push/PR) and Release (on semver tags)

Documentation

Any changes to features or how tools work must be reflected in docs/PRD.md

Build & Test

make build              # build binary
make test               # run tests
make test-coverage      # tests with coverage report
make vet                # go vet
make lint               # vet + staticcheck + test
make release-snapshot   # local goreleaser build (no publish)

Read the full file on GitHub · 80 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

10d ago First seen · 80 lines · 875 tokens per session scan A 7d7aba1d8820

Subscribe to this mod's changes

paperless-ngx-mcp CLAUDE.md is an instructions file published in the GitHub repository freeformz/paperless-ngx-mcp (22 stars, last pushed 12d ago), licensed MIT. It adds 875 tokens to every session, about $0.0044 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Documents

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

paperless-ngx-mcp: Instructions file for Claude Code