NP

nloui/paperless-mcp

Developer tools

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기

247 stars 84 forks 품질 65 트렌드 18

Paperless-NGX API 서버와 상호작용하기 위한 MCP(모델 컨텍스트 프로토콜) 서버입니다. 이 서버는 문서, 태그, 대응자 및 문서 유형을 관리하는 도구를 제공합니다...

개요

Paperless-NGX API 서버와 상호작용하기 위한 MCP(모델 컨텍스트 프로토콜) 서버입니다. 이 서버는 Paperless-NGX 인스턴스에서 문서, 태그, 대응자, 문서 유형을 관리하는 도구를 제공합니다. 2. Claude의 MCP 구성에 추가: VSCode 확장 기능을 위해 편집 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json: Claude 데스크톱 앱의 경우 ~/Library/Application Support/Claude/claude_desktop_config.json 편집: 3. API 토큰 획득: 1. Paperless-NGX 인스턴스에 로그인하기 2. 오른쪽 상단의 사용자 이름을 클릭하세요 3. "내 프로필"을 선택하세요. 4. 원형 화살표 버튼을 클릭하여 새 토큰을 생성합니다. 4. MCP 설정에서 자리 표시자를 교체합니다: - http://your-paperless-instance:8000를 Paperless-NGX URL로 - your-api-token을 방금 생성한 토큰으로 교체하세요 그게 전부입니다! 이제 Claude에게 Paperless-NGX 문서 관리를 도와달라고 요청할 수 있습니다. 다음은 클로드에게 요청할 수 있는 몇 가지 사항입니다:

개요(AI 번역)

Paperless-NGX API 서버와 상호작용하기 위한 MCP(모델 컨텍스트 프로토콜) 서버입니다. 이 서버는 Paperless-NGX 인스턴스에서 문서, 태그, 대응자, 문서 유형을 관리하는 도구를 제공합니다.

퀵 스타트

설치

  1. MCP 서버 설치:

  2. Claude의 MCP 구성에 추가:

VSCode 확장에 대해 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json를 수정하세요:

Claude 데스크톱 앱의 경우 ~/Library/Application Support/Claude/claude_desktop_config.json를 편집하세요:

  1. API 토큰 획득:

  2. Paperless-NGX 인스턴스에 로그인하기

  3. 오른쪽 상단의 사용자 이름을 클릭하세요

  4. “내 프로필” 선택

  5. 원형 화살표 버튼을 눌러 새로운 토큰을 생성합니다

  6. MCP 설정에서 자리 표시자를 교체하세요:

  • http://your-paperless-instance:8000 귀하의 Paperless-NGX URL과 함께
  • your-api-token 방금 생성한 토큰으로

그게 전부입니다! 이제 Claude에게 Paperless-NGX 문서 관리를 도와달라고 요청할 수 있습니다.

예시 사용

다음은 클로드에게 요청할 수 있는 몇 가지 사항입니다:

  • “'송장’으로 태그된 모든 문서를 보여줘”
  • “세금 신고서가 포함된 문서 검색”

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요.

README

원문 README의 일부입니다. 원문 보기.

Paperless-NGX MCP Server

An MCP (Model Context Protocol) server for interacting with a Paperless-NGX API server. This server provides tools for managing documents, tags, correspondents, and document types in your Paperless-NGX instance.

Quick Start

Installation

  1. Install the MCP server:
npm install -g paperless-mcp
  1. Add it to your Claude’s MCP configuration:

For VSCode extension, edit ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json:

{
  "mcpServers": {
    "paperless": {
      "command": "npx",
      "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"]
    }
  }
}

For Claude desktop app, edit ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "paperless": {
      "command": "npx",
      "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"]
    }
  }
}
  1. Get your API token:

    1. Log into your Paperless-NGX instance
    2. Click your username in the top right
    3. Select “My Profile”
    4. Click the circular arrow button to generate a new token
  2. Replace the placeholders in your MCP config:

    • http://your-paperless-instance:8000 with your Paperless-NGX URL
    • your-api-token with the token you just generated

That’s it! Now you can ask Claude to help you manage your Paperless-NGX documents.

Example Usage

Here are some things you can ask Claude to do:

  • “Show me all documents tagged as ‘Invoice’”
  • “Search for documents containing ‘tax return’”
  • “Create a new tag called ‘Receipts’ with color #FF0000”
  • “Download document #123”
  • “List all correspondents”
  • “Create a new document type called ‘Bank Statement’”

Available Tools

Document Operations

list_documents

Get a paginated list of all documents.

Parameters:

  • page (optional): Page number
  • page_size (optional): Number of documents per page
list_documents({
  page: 1,
  page_size: 25
})

get_document

Get a specific document by ID.

Parameters:

  • id: Document ID
get_document({
  id: 123
})

search_documents

Full-text search across documents.

Parameters:

  • query: Search query string
search_documents({
  query: "invoice 2024"
})

download_document

Download a document file by ID.

Parameters:

  • id: Document ID
  • original (optional): If true, downloads original file instead of archived version
download_document({
  id: 123,
  original: false
})

bulk_edit_documents

Perform bulk operations on multiple documents.

Parameters:

  • documents: Array of document IDs
  • method: One of:
    • set_correspondent: Set correspondent for documents
    • set_document_type: Set document type for documents
    • set_storage_path: Set storage path for documents
    • add_tag: Add a tag to documents
    • remove_tag: Remove a tag from documents
GitHub에서 전체 README 보기

설치

npx paperless-mcp http://your-paperless-instance:8000 your-api-token
MCP 초보자라면? mcpskill.org 가이드부터 시작하세요 →

설정

{ "mcpServers": { "paperless": { "command": "npx", "args": ["paperless-mcp", "http://your-paperless-instance:8000", "your-api-token"] } } }