@kjanat/paperless-mcp 2.1.1 → 2.2.0

package/README.md

@@ -18,16 +18,16 @@ An MCP (Model Context Protocol) server for interacting with a Paperless-ngx API
 
    ```jsonc
    {
-   	"mcpServers": {
-   		"paperless": {
-   			"command": "bunx", // or npx
-   			"args": ["@kjanat/paperless-mcp"],
-   			"env": {
-   				"PAPERLESS_URL": "http://your-paperless-instance:8000",
-   				"PAPERLESS_API_KEY": "your-api-token",
-   			},
-   		},
-   	},
+     "mcpServers": {
+       "paperless": {
+         "command": "bunx", // or npx
+         "args": ["@kjanat/paperless-mcp"],
+         "env": {
+           "PAPERLESS_URL": "http://your-paperless-instance:8000",
+           "PAPERLESS_API_KEY": "your-api-token",
+         },
+       },
+     },
    }
    ```
 
@@ -35,16 +35,16 @@ An MCP (Model Context Protocol) server for interacting with a Paperless-ngx API
 
    ```jsonc
    {
-   	"mcpServers": {
-   		"paperless": {
-   			"command": "bunx", // or npx
-   			"args": [
-   				"@kjanat/paperless-mcp",
-   				"http://your-paperless-instance:8000",
-   				"your-api-token",
-   			],
-   		},
-   	},
+     "mcpServers": {
+       "paperless": {
+         "command": "bunx", // or npx
+         "args": [
+           "@kjanat/paperless-mcp",
+           "http://your-paperless-instance:8000",
+           "your-api-token",
+         ],
+       },
+     },
    }
    ```
 
@@ -96,7 +96,7 @@ Parameters:
 
 ```typescript
 get_document({
-	id: 123,
+  id: 123,
 });
 ```
 
@@ -110,7 +110,7 @@ Parameters:
 
 ```typescript
 search_documents({
-	query: "invoice 2024",
+  query: "invoice 2024",
 });
 ```
 
@@ -125,8 +125,8 @@ Parameters:
 
 ```typescript
 download_document({
-	id: 123,
-	original: false,
+  id: 123,
+  original: false,
 });
 ```
 
@@ -144,6 +144,7 @@ Parameters:
   - `add_tag`: Add a tag to documents
   - `remove_tag`: Remove a tag from documents
   - `modify_tags`: Add and/or remove multiple tags
+  - `modify_custom_fields`: Add and/or remove custom fields
   - `delete`: Delete documents
   - `reprocess`: Reprocess documents
   - `set_permissions`: Set document permissions
@@ -151,6 +152,8 @@ Parameters:
   - `split`: Split a document into multiple documents
   - `rotate`: Rotate document pages
   - `delete_pages`: Delete specific pages from a document
+  - `edit_pdf`: Reorder, rotate, split, or discard PDF pages
+  - `remove_password`: Remove PDF password protection
 - Additional parameters based on `method`:
   - `correspondent`: ID for set_correspondent
   - `document_type`: ID for set_document_type
@@ -158,50 +161,55 @@ Parameters:
   - `tag`: ID for add_tag/remove_tag
   - `add_tags`: Array of tag IDs for modify_tags
   - `remove_tags`: Array of tag IDs for modify_tags
+  - `add_custom_fields`: Custom field IDs or id:value pairs for modify_custom_fields
+  - `remove_custom_fields`: Array of custom field IDs for modify_custom_fields
   - `permissions`: Object for set_permissions with owner, permissions, merge flag
   - `metadata_document_id`: ID for merge to specify metadata source
   - `delete_originals`: Boolean for merge/split
-  - `pages`: String for split "[1,2-3,4,5-7]" or `delete_pages` "[2,3,4]"
+  - `pages`: String for split (`"1-2,3-4,5"`) or number array for delete_pages (`[2, 3, 4]`)
   - `degrees`: Number for rotate (90, 180, or 270)
+  - `operations`: Array of PDF edit operations for edit_pdf
+  - `password`: Password for remove_password
+  - `update_document`, `delete_original`, `include_metadata`: PDF edit/remove-password flags
 
 Examples:
 
 ```typescript
 // Add a tag to multiple documents
 bulk_edit_documents({
-	documents: [1, 2, 3],
-	method: "add_tag",
-	tag: 5,
+  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,
+  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,
+  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]",
+  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],
+  documents: [10, 11],
+  method: "modify_tags",
+  add_tags: [1, 2],
+  remove_tags: [3, 4],
 });
 ```
 
@@ -224,14 +232,14 @@ Parameters:
 
 ```typescript
 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",
+  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",
 });
 ```
 
@@ -262,10 +270,10 @@ Parameters:
 
 ```typescript
 create_tag({
-	name: "Invoice",
-	color: "#ff0000",
-	match: "invoice",
-	matching_algorithm: 5,
+  name: "Invoice",
+  color: "#ff0000",
+  match: "invoice",
+  matching_algorithm: 5,
 });
 ```
 
@@ -283,9 +291,9 @@ Parameters:
 
 ```typescript
 update_tag({
-	id: 5,
-	name: "Invoices",
-	color: "#00ff00",
+  id: 5,
+  name: "Invoices",
+  color: "#00ff00",
 });
 ```
 
@@ -299,7 +307,7 @@ Parameters:
 
 ```typescript
 delete_tag({
-	id: 5,
+  id: 5,
 });
 ```
 
@@ -317,8 +325,8 @@ Parameters:
 
 ```typescript
 bulk_edit_tags({
-	tag_ids: [1, 2, 3],
-	operation: "delete",
+  tag_ids: [1, 2, 3],
+  operation: "delete",
 });
 ```
 
@@ -348,9 +356,9 @@ Parameters:
 
 ```typescript
 create_correspondent({
-	name: "ACME Corp",
-	match: "ACME",
-	matching_algorithm: 5,
+  name: "ACME Corp",
+  match: "ACME",
+  matching_algorithm: 5,
 });
 ```
 
@@ -368,8 +376,8 @@ Parameters:
 
 ```typescript
 bulk_edit_correspondents({
-	correspondent_ids: [1, 2],
-	operation: "delete",
+  correspondent_ids: [1, 2],
+  operation: "delete",
 });
 ```
 
@@ -399,9 +407,9 @@ Parameters:
 
 ```typescript
 create_document_type({
-	name: "Invoice",
-	match: "invoice total amount due",
-	matching_algorithm: 1,
+  name: "Invoice",
+  match: "invoice total amount due",
+  matching_algorithm: 1,
 });
 ```
 
@@ -419,8 +427,8 @@ Parameters:
 
 ```typescript
 bulk_edit_document_types({
-	document_type_ids: [1, 2],
-	operation: "delete",
+  document_type_ids: [1, 2],
+  operation: "delete",
 });
 ```