paperless-mcp: Instructions file for Claude Code

CLAUDE.md

paperless-mcp CLAUDE.md is an instructions file for Claude Code from baruchiro/paperless-mcp. It costs 4,543 tokens per session, scanned A, original, from a forked repository, ISC.

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

In plain words
What is it for?
Use them when developing or maintaining the TypeScript and Node.js server, its document-management tools, or its HTTP connection mode.
Why use it?
They explain the repository structure, development commands, and rules for working with the Paperless-NGX API.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is baruchiro/paperless-mcp's own configuration. It tells Claude Code how to work on paperless-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything paperless-mcp configures →

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.

agentmods badge for paperless-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/baruchiro/paperless-mcp/claude-md.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.svg" alt="Measured on agentmods" height="20"></a>
Per session 4,543 This file is loaded in full into every session.
When invoked 4,543 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.04543 $0.04543
Opus 5 $0.02271 $0.02271
Sonnet 5 $0.00909 $0.00909
Haiku 4.5 $0.00454 $0.00454

Measured today against content hash db4e00be425b, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-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 today.

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 · 405 lines

How it starts

The opening of the file, as written. The whole thing — 405 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.

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

Running the Server

# STDIO mode (default)
npm run start -- --baseUrl http://localhost:8000 --token your-api-token

# HTTP mode
npm run start -- --baseUrl http://localhost:8000 --token your-api-token --http --port 3000

# Using environment variables
export PAPERLESS_URL=http://localhost:8000
export PAPERLESS_API_KEY=your-api-token
npm run start

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

  1. today Changed · +131 tokens per session db4e00be425b
  2. 8d 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 (139 stars, last pushed today), licensed ISC. It adds 4,543 tokens to every session, about $0.0227 per session on Opus 5. A static security scan graded it A with 0 findings. It comes from a forked repository.

Related

Other instructions, from other repositories

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,182 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

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

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens