NP

nloui/paperless-mcp

Developer tools

このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る

247 stars 84 forks 品質 65 トレンド 18

Paperless-NGX APIサーバーとやり取りするためのMCP(Model Context Protocol)サーバーです。このサーバーは、ドキュメント、タグ、対応する、ドキュメントタイプを管理するためのツールを提供します...

概要

Paperless-NGX APIサーバーとやり取りするためのMCP(Model Context Protocol)サーバーです。このサーバーは、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.「My Profile」を選択し 4.円形の矢印ボタンをクリックして新しいトークンを生成する 4. MCP設定のプレースホルダーを置き換えます:- http://your-paperless-instance:8000をPaperless-NGX URLに、your-api-tokenを生成したトークンに置き換えます それだけです!これでClaudeにPaperless-NGXのドキュメント管理をお願いできます。 クロードに頼めることは以下の通りです:

概要(AI 翻訳)

Paperless-NGX APIサーバーとやり取りするためのMCP(Model Context Protocol)サーバーです。このサーバーは、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"] } } }