Paperless-NGX MCP 서버

Paperless-NGX API 서버와 상호 작용하는 MCP(Model Context Protocol) 서버입니다. 이 서버는 Paperless-NGX 인스턴스에서 문서, 태그, 통신 대상 및 문서 유형을 관리하는 도구를 제공합니다.

빠른 시작

Smithery를 통해 설치

Smithery를 통해 Claude Desktop용 Paperless NGX MCP 서버를 자동으로 설치하려면:

지엑스피1

수동 설치

MCP 서버를 설치하세요:

npm install -g paperless-mcp

Claude의 MCP 구성에 추가하세요.

VSCode 확장의 경우 ~/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"]
    }
  }
}

Claude 데스크톱 앱의 경우 ~/Library/Application Support/Claude/claude_desktop_config.json 편집합니다.

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

API 토큰을 받으세요:
1. Paperless-NGX 인스턴스에 로그인하세요
2. 오른쪽 상단의 사용자 이름을 클릭하세요
3. "내 프로필"을 선택하세요
4. 원형 화살표 버튼을 클릭하여 새 토큰을 생성하세요.
MCP 구성의 플레이스홀더를 다음과 같이 바꾸세요.
- http://your-paperless-instance:8000 (Paperless-NGX URL 포함)
- 방금 생성한 토큰 your-api-token 에 입력하세요.

이제 Claude에게 Paperless-NGX 문서 관리에 대한 도움을 요청하세요.

사용 예

클로드에게 요청할 수 있는 일은 다음과 같습니다.

"송장"으로 태그된 모든 문서를 보여주세요
"세금 신고서"를 포함하는 문서를 검색하세요.
"색상 #FF0000을 사용하여 '영수증'이라는 새 태그를 만듭니다."
"문서 #123 다운로드"
"모든 통신원을 나열하세요"
"'은행 거래 내역서'라는 새 문서 유형을 만듭니다."

사용 가능한 도구

문서 작업

문서 목록

모든 문서의 페이지별 목록을 가져옵니다.

매개변수:

페이지(선택 사항): 페이지 번호
page_size(선택 사항): 페이지당 문서 수

list_documents({
  page: 1,
  page_size: 25
})

문서 가져오기

ID로 특정 문서를 가져옵니다.

매개변수:

id: 문서 ID

get_document({
  id: 123
})

문서 검색

문서 전체에서 전체 텍스트 검색.

매개변수:

쿼리: 검색 쿼리 문자열

search_documents({
  query: "invoice 2024"
})

다운로드_문서

ID로 문서 파일을 다운로드하세요.

매개변수:

id: 문서 ID
original(선택 사항): true인 경우 보관된 버전 대신 원본 파일을 다운로드합니다.

download_document({
  id: 123,
  original: false
})

대량 편집 문서

여러 문서에 대한 대량 작업을 수행합니다.

매개변수:

문서: 문서 ID 배열
방법: 다음 중 하나:
- set_correspondent: 문서의 상대방 설정
- set_document_type: 문서의 문서 유형 설정
- set_storage_path: 문서의 저장 경로 설정
- add_tag: 문서에 태그를 추가합니다.
- remove_tag: 문서에서 태그 제거
- modify_tags: 여러 태그를 추가 및/또는 제거합니다.
- 삭제: 문서 삭제
- 재처리: 문서 재처리
- set_permissions: 문서 권한 설정
- 병합: 여러 문서 병합
- split: 문서를 여러 문서로 분할
- 회전: 문서 페이지 회전
- delete_pages: 문서에서 특정 페이지 삭제
방법에 따른 추가 매개변수:
- correspondent: set_correspondent에 대한 ID
- document_type: set_document_type에 대한 ID
- storage_path: set_storage_path에 대한 ID
- 태그: add_tag/remove_tag에 대한 ID
- add_tags: modify_tags에 대한 태그 ID 배열
- remove_tags: modify_tags에 대한 태그 ID 배열
- 권한: 소유자, 권한, 병합 플래그가 있는 set_permissions에 대한 개체
- metadata_document_id: 메타데이터 소스를 지정하기 위한 병합 ID
- delete_originals: 병합/분할에 대한 부울 값
- 페이지: 분할 문자열 "[1,2-3,4,5-7]" 또는 delete_pages "[2,3,4]"
- 도: 회전할 각도(90, 180 또는 270)

예:

// Add a tag to multiple documents
bulk_edit_documents({
  documents: [1, 2, 3],
  method: "add_tag",
  tag: 5
})

// Set correspondent and document type
bulk_edit_documents({
  documents: [4, 5],
  method: "set_correspondent",
  correspondent: 2
})

// Merge documents
bulk_edit_documents({
  documents: [6, 7, 8],
  method: "merge",
  metadata_document_id: 6,
  delete_originals: true
})

// Split document into parts
bulk_edit_documents({
  documents: [9],
  method: "split",
  pages: "[1-2,3-4,5]"
})

// Modify multiple tags at once
bulk_edit_documents({
  documents: [10, 11],
  method: "modify_tags",
  add_tags: [1, 2],
  remove_tags: [3, 4]
})

포스트_문서

Paperless-NGX에 새로운 문서를 업로드합니다.

매개변수:

파일: Base64로 인코딩된 파일 내용
파일 이름: 파일 이름
title (선택 사항): 문서의 제목
created(선택 사항): 문서가 생성된 DateTime(예: "2024-01-19" 또는 "2024-01-19 06:15:00+02:00")
통신원(선택사항): 통신원의 ID
document_type(선택 사항): 문서 유형의 ID
storage_path(선택 사항): 저장 경로의 ID
태그(선택 사항): 태그 ID 배열
archive_serial_number(선택 사항): 아카이브 일련 번호
custom_fields(선택 사항): 사용자 정의 필드 ID 배열

post_document({
  file: "base64_encoded_content",
  filename: "invoice.pdf",
  title: "January Invoice",
  created: "2024-01-19",
  correspondent: 1,
  document_type: 2,
  tags: [1, 3],
  archive_serial_number: "2024-001"
})

태그 작업

태그 목록

모든 태그를 가져옵니다.

list_tags()

태그 생성

새로운 태그를 만듭니다.

매개변수:

이름: 태그 이름
color(선택 사항): 16진수 색상 코드(예: "#ff0000")
match (선택 사항): 일치시킬 텍스트 패턴
matching_algorithm(선택 사항): "any", "all", "exact", "regular expression", "fuzzy" 중 하나

create_tag({
  name: "Invoice",
  color: "#ff0000",
  match: "invoice",
  matching_algorithm: "fuzzy"
})

통신원 운영

통신원 목록

모든 통신원을 모으세요.

list_correspondents()

통신원 생성

새로운 통신원을 만드세요.

매개변수:

이름: 통신원 이름
match (선택 사항): 일치시킬 텍스트 패턴
matching_algorithm(선택 사항): "any", "all", "exact", "regular expression", "fuzzy" 중 하나

create_correspondent({
  name: "ACME Corp",
  match: "ACME",
  matching_algorithm: "fuzzy"
})

문서 유형 작업

목록_문서_유형

모든 문서 유형을 가져옵니다.

list_document_types()

문서_유형_생성

새로운 문서 유형을 만듭니다.

매개변수:

이름: 문서 유형 이름
match (선택 사항): 일치시킬 텍스트 패턴
matching_algorithm(선택 사항): "any", "all", "exact", "regular expression", "fuzzy" 중 하나

create_document_type({
  name: "Invoice",
  match: "invoice total amount due",
  matching_algorithm: "any"
})

오류 처리

다음과 같은 경우 서버에서 명확한 오류 메시지가 표시됩니다.

Paperless-NGX URL 또는 API 토큰이 올바르지 않습니다.
Paperless-NGX 서버에 접근할 수 없습니다.
요청된 작업이 실패했습니다
제공된 매개변수가 잘못되었습니다.

개발

서버에 기여하거나 수정하고 싶으신가요? 다음 사항을 알아두세요.

저장소를 복제합니다
종속성 설치:

npm install

server.js를 변경하세요
로컬로 테스트:

node server.js http://localhost:8000 your-test-token

서버는 다음으로 구성되었습니다.

litemcp : MCP 서버 구축을 위한 TypeScript 프레임워크
zod : TypeScript 우선 스키마 검증

API 문서

이 MCP 서버는 Paperless-NGX REST API의 엔드포인트를 구현합니다. 기본 API에 대한 자세한 내용은 공식 문서를 참조하세요.

Paperless-NGX MCP Server

Integrations

Paperless-NGX MCP 서버

빠른 시작

Smithery를 통해 설치

수동 설치

사용 예

사용 가능한 도구

문서 작업

문서 목록

문서 가져오기

문서 검색

다운로드_문서

대량 편집 문서

포스트_문서

태그 작업

태그 목록

태그 생성

통신원 운영

통신원 목록

통신원 생성

문서 유형 작업

목록_문서_유형

문서_유형_생성

오류 처리

개발

API 문서

Tools

Related Resources

Appeared in Searches