Paperless MCP - Document Management System

by PDangelmaier

2 212 downloads Not rated yet MIT

GitHub

Other

About

# Paperless MCP - Document Management System <img src="https://via.placeholder.com/200x200?text=Paperless+MCP" alt="Paperless MCP Logo" width="200" height="200"> A modern, efficient document management system for the digital workplace <a…

Details

License: MIT

Explore

Document Storage & Organization
- Secure cloud or on-premises document storage
- Hierarchical folder structure
- Custom metadata and tagging
- Advanced search capabilities

Document Processing
- OCR for scanned documents
- Automated document classification
- Metadata extraction
- PDF processing and manipulation

Security & Compliance
- Role-based access control
- Audit logging for all document activities
- Encryption of sensitive data
- Compliance with industry standards (GDPR, HIPAA, etc.)

Integration & Extensibility
- RESTful API for third-party integration
- Webhook support for automation
- Customizable workflow engine
- Plugin architecture for extending functionality

User Experience
- Intuitive web-based user interface
- Mobile-responsive design
- Document preview and annotation
- Batch operations for efficient document handling

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Paperless MCP - Document Management System

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

From the repository

- Node.js (v16 or later)
- npm or yarn
- PostgreSQL (v13 or later)
- Docker (optional, for containerized deployment)

1. Clone the repository:
``bash git clone https://github.com/yourusername/paperless-mcp.git cd paperless-mcp`2. Install dependencies:`bash npm install`3. Set up environment variables:`bash cp .env.example .env

`4. Run database migrations:`bash npm run migrate`5. Start the development server:`bash npm run dev



1. Clone the repository:

bash

git clone https://github.com/yourusername/paperless-mcp.git

cd paperless-mcp





2. Build and start the Docker containers:

bash

docker-compose up -d





The application will be available at http://localhost:3000.
Paperless MCP also provides a command-line interface for administrative tasks:







POST /api/v1/auth/login





Request body:

json

{

"username": "admin",

"password": "your-password"

}





Response:

json

{

"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",

"expiresAt": "2023-12-31T23:59:59Z"

}



- PORT: The port the server will listen on (default: 3000)

- DATABASE_URL: PostgreSQL connection string

- STORAGE_TYPE: Storage backend ('local', 's3', 'azure', etc.)

- STORAGE_PATH: Local storage path (if STORAGE_TYPE=local)

- LOG_LEVEL: Logging level ('debug', 'info', 'warn', 'error')

- JWT_SECRET: Secret for JWT token generation

- OCR_ENGINE: OCR engine to use ('tesseract', 'azure', etc.)
For more advanced configuration, create a config.js or config.json file in the project root. Example:



json

{

"server": {

    "port": 3000,

    "host": "0.0.0.0",

    "cors": {

    "enabled": true,

    "origins": ["https://example.com"]

    }

},

"database": {

    "url": "postgresql://user:password@localhost:5432/paperless",

    "pool": {

    "min": 2,

    "max": 10

    }

},

"storage": {

    "type": "s3",

    "config": {

    "bucket": "paperless-documents",

    "region": "us-west-2"

    }

}

}

1. Fork the repository 2. Clone your fork:git clone https://github.com/yourusername/paperless-mcp.git3. Create a feature branch:git checkout -b feature/my-feature4. Make your changes 5. Run tests:npm test6. Commit your changes:git commit -m 'Add my feature'7. Push to the branch:git push origin feature/my-feature`
8. Submit a pull request

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "paperless mcp - document management system": {
            "Paperless-MCP-Server": {
                "command": "npx",
                "args": [
                    "paperless-mcp",
                    "--help"
                ]
            }
        }
    }
}

McpServers

{
    "Paperless-MCP-Server": {
        "command": "npx",
        "args": [
            "paperless-mcp",
            "--help"
        ]
    }
}

A modern, efficient document management system for the digital workplace <a href="#features">Features</a> • <a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#api-documentation">API</a> • <a href="#configuration">Configuration</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a>

Overview

Paperless MCP is an open-source document management system designed to streamline the handling of digital documents in enterprise environments. It provides a comprehensive solution for storing, organizing, searching, and processing documents, eliminating the need for physical paperwork and simplifying document workflows. The system offers robust document processing capabilities, including OCR (Optical Character Recognition), metadata extraction, and automated document classification, all while maintaining strict security and access controls.

Features

Document Storage & Organization - Secure cloud or on-premises document storage - Hierarchical folder structure - Custom metadata and tagging - Advanced search capabilities Document Processing - OCR for scanned documents - Automated document classification - Metadata extraction - PDF processing and manipulation Security & Compliance - Role-based access control - Audit logging for all document activities - Encryption of sensitive data - Compliance with industry standards (GDPR, HIPAA, etc.) Integration & Extensibility - RESTful API for third-party integration - Webhook support for automation - Customizable workflow engine - Plugin architecture for extending functionality User Experience - Intuitive web-based user interface - Mobile-responsive design - Document preview and annotation - Batch operations for efficient document handling

Installation

Prerequisites

- Node.js (v16 or later) - npm or yarn - PostgreSQL (v13 or later) - Docker (optional, for containerized deployment)

Local Installation

1. Clone the repository: ``

bash
git clone https://github.com/yourusername/paperless-mcp.git
cd paperless-mcp



2. Install dependencies:

bash
npm install



3. Set up environment variables:

``bash cp .env.example .env

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Explore

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

Overview

Features

Installation

Prerequisites

Local Installation

More like this

Sequential Thinking

Filesystem

EverArt

Google Drive