Paperless MCP Server

🚀 Paperless: Paperless Project

The Paperless project aims to assist users in achieving paperless office work. Through modern tools and methods, it simplifies the file management process and enhances work efficiency.

Project Logo

🚀 Quick Start

The Paperless project is designed to help users achieve paperless office work. It simplifies file management processes and boosts work efficiency through modern tools and methods. Here are the core features and services of the project.

✨ Features

1. Core Features

• Document Storage and Management: Supports uploading, storing, and retrieving files in multiple formats (such as PDF, DOCX, PPT, etc.).
• Version Control: Automatically records historical versions of documents for easy backtracking and restoration.
• Permission Management: Role - Based Access Control (RBAC) ensures document security.

2. Additional Features

a. Intelligent Search

• Supports full - text search, keyword filtering, time - range screening, etc.
• Provides advanced search options such as metadata queries and tag classification.

b. Team Collaboration

• Real - time editing and commenting functions support multi - person online collaboration.
• Task assignment and tracking ensure projects are completed on time.

3. Scalability

• Supports multiple storage backends (local, Alibaba Cloud OSS, AWS S3, etc.).
• Has flexible API interfaces for easy integration with other systems.

📦 Installation

Prerequisites

1. Operating System: Supports Linux, Windows, and macOS.
2. Node.js: Version v14 or higher is required.
3. PostgreSQL: Version 12 or higher is required.
4. Docker (Optional): For rapid deployment of the environment.

Local Installation Steps

# Step 1: Clone the repository
git clone https://github.com/yourusername/paperless.git

# Step 2: Enter the project directory
cd paperless

# Step 3: Install dependencies
npm install

# Step 4: Configure the database
cp config/database.example.json config/database.json

# Step 5: Configure environment variables
export NODE_ENV=development
export DB_URL="postgresql://user:password@localhost:5432/paperless"

# Step 6: Start the service
npm start

Docker Quick Deployment

# Use the official Node.js image
FROM node:16

# Set the working directory
WORKDIR /app

# Copy package files
COPY package*.json ./

# Install dependencies
RUN npm install --production

# Start the service
CMD ["npm", "start"]

💻 Usage Examples

Basic Operations

• Document Upload: Upload files through the web interface or API.
• Document Download: Supports direct downloading of specified versions of files.
• Deletion Operation: Use with caution. It is recommended to check the recycle bin first.

CLI Tool Usage

# Install the CLI tool
npm install -g paperless-cli

# View help information
paperless --help

# Upload a file to the server
paperless upload ./documents/report.pdf

📚 Documentation

API Documentation

1. User Authentication

• Login Interface:

  POST /api/v1/users/login
  {
    "username": "admin",
    "password": "secret"
  }
  

2. Document Management

• Create a Document:

  POST /api/v1/documents
  {
    "title": "Annual Report 2023",
    "content": "Base64 - encoded file content...",
    "metadata": {
      "category": "Financial Report",
      "tags": ["Report", "2023"]
    }
  }
  

• Get a Document:

  GET /api/v1/documents/:id
  

Configuration Guide

Environment Variable Configuration

# Example environment variables
PORT=3000
DATABASE_URL="postgresql://user:password@localhost:5432/paperless"
API_KEY="your_api_key_here"

Configuration File Example

// config/database.json
{
  "host": "localhost",
  "port": 5432,
  "database": "paperless_db",
  "username": "admin",
  "password": "secret"
}

🤝 Contribution Guide

Ways to Participate

1. Fork the Repository: Fork the project on GitHub.
2. Create a Branch: Create a new branch for new features or bug fixes based on the main branch.
3. Submit Code: After making modifications, push to your personal repository and initiate a Pull Request.

Development Specifications

• Follow the project's coding standards and documentation commenting requirements.
• The submitted code must pass unit tests and the CI/CD process.

📄 License

This project is licensed under the MIT License:

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🙏 Acknowledgments

Thanks to all contributors and users for their strong support, which has enabled the project to be continuously improved and developed. For more help, please contact the project maintainers or visit the official documentation.

The above is the core content and usage guide of the Paperless project. We hope it will be helpful to you!