What is paperless-mcp CLAUDE.md?

Project instructions for an MCP server that lets AI assistants manage documents in Paperless-NGX, a system for organising scanned and digital documents.

Use them when developing or maintaining the TypeScript and Node.js server, its document-management tools, or its HTTP connection mode.

They explain the repository structure, development commands, and rules for working with the Paperless-NGX API.

How baruchiro/paperless-mcp configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to baruchiro/paperless-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/baruchiro/paperless-mcp/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/baruchiro/paperless-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/baruchiro/paperless-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/baruchiro/paperless-mcp/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/baruchiro/paperless-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/baruchiro/paperless-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/baruchiro/paperless-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/baruchiro/paperless-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 5,017 This file is loaded in full into every session.

When invoked 5,017 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 fork From a forked repository.

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.05017	$0.05017
Opus 5.5	$0.02007	$0.02007
Sonnet 5.5	$0.01003	$0.01003
Haiku 4.5	$0.00502	$0.00502

Measured 1mo ago against content hash 035d1fa94581, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

paperless-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 1mo 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 · 414 lines

How it starts

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

Paperless-NGX MCP Server - Claude Instructions

These are the project's AI instructions, read automatically by Claude Code as CLAUDE.md. They are the single source of truth for how to work in this repo - they previously lived in .github/copilot-instructions.md and .cursor/rules/*.mdc, which have been consolidated here.

AGENTS.md restates the contribution and scope rules for agents that do not read this file, and CONTRIBUTING.md states them for human contributors. When you change a rule that appears in more than one of the three, update all of them.

Project Overview

This is a Model Context Protocol (MCP) server for interacting with Paperless-NGX document management system. It enables AI assistants like Claude to manage documents, tags, correspondents, and document types through the Paperless-NGX API.

Tech Stack:

TypeScript with Node.js
MCP SDK (@modelcontextprotocol/sdk)
Express for HTTP transport mode
Axios for API requests
Zod for schema validation

Repository Structure

src/
├── api/
│   ├── PaperlessAPI.ts       # Main API client for Paperless-NGX
│   ├── types.ts              # TypeScript type definitions
│   ├── utils.ts              # API utility functions
│   └── documentEnhancer.ts   # Document response enhancement
├── tools/
│   ├── documents.ts          # Document management tools
│   ├── tags.ts               # Tag management tools
│   ├── correspondents.ts     # Correspondent management tools
│   ├── documentTypes.ts      # Document type management tools
│   ├── customFields.ts       # Custom field management tools
│   └── utils/                # Shared tool utilities
├── index.ts                  # Entry point and server setup

Build and Development Commands

Essential Commands

Build: npm run build - Compiles TypeScript to JavaScript in build/ directory
Start: npm run start - Run the server with ts-node (development)
Test: npm test - Currently no tests defined (outputs error and exits)
Pack: npm run dxt-pack - Package for DXT distribution
Inspect: npm run inspect - Build and run with MCP inspector

Read the full file on GitHub · 414 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.

1mo ago Changed · +9 lines · +474 tokens per session 035d1fa94581
2mo ago Changed · +131 tokens per session db4e00be425b
2mo ago First seen · 405 lines · 4,412 tokens per session scan A c96cdde681d3

Subscribe to this mod's changes

paperless-mcp CLAUDE.md is an instructions file published in the GitHub repository baruchiro/paperless-mcp (149 stars, last pushed 3d ago), licensed ISC. It adds 5,017 tokens to every session, about $0.0201 per session on Opus 5.5. A static security scan graded it A with 0 findings. It comes from a forked repository.

Documents ai document-management mcp mcp-server paperless-ngx

paperless-mcp CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
paperless-mcp CLAUDE.mdbaruchiro/paperless-mcp	Instructions file	149	3d ago	ISC	A	5,017	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

paperless-mcp: Instructions file for Claude Code