@kjanat/paperless-mcp 2.1.0 → 2.1.1

package/README.md

@@ -1,5 +1,7 @@
 # Paperless-ngx MCP Server
 
+[![NPM Version](https://img.shields.io/npm/v/@kjanat/paperless-mcp?logo=npm&labelColor=CB3837&color=black)](https://www.npmjs.com/package/@kjanat/paperless-mcp)
+
 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
@@ -16,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",
+   			},
+   		},
+   	},
    }
    ```
 
@@ -33,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",
+   			],
+   		},
+   	},
    }
    ```
 
@@ -94,7 +96,7 @@ Parameters:
 
 ```typescript
 get_document({
-  id: 123,
+	id: 123,
 });
 ```
 
@@ -108,7 +110,7 @@ Parameters:
 
 ```typescript
 search_documents({
-  query: "invoice 2024",
+	query: "invoice 2024",
 });
 ```
 
@@ -123,8 +125,8 @@ Parameters:
 
 ```typescript
 download_document({
-  id: 123,
-  original: false,
+	id: 123,
+	original: false,
 });
 ```
 
@@ -167,39 +169,39 @@ 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],
 });
 ```
 
@@ -222,14 +224,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",
 });
 ```
 
@@ -260,10 +262,10 @@ Parameters:
 
 ```typescript
 create_tag({
-  name: "Invoice",
-  color: "#ff0000",
-  match: "invoice",
-  matching_algorithm: 5,
+	name: "Invoice",
+	color: "#ff0000",
+	match: "invoice",
+	matching_algorithm: 5,
 });
 ```
 
@@ -281,9 +283,9 @@ Parameters:
 
 ```typescript
 update_tag({
-  id: 5,
-  name: "Invoices",
-  color: "#00ff00",
+	id: 5,
+	name: "Invoices",
+	color: "#00ff00",
 });
 ```
 
@@ -297,7 +299,7 @@ Parameters:
 
 ```typescript
 delete_tag({
-  id: 5,
+	id: 5,
 });
 ```
 
@@ -315,8 +317,8 @@ Parameters:
 
 ```typescript
 bulk_edit_tags({
-  tag_ids: [1, 2, 3],
-  operation: "delete",
+	tag_ids: [1, 2, 3],
+	operation: "delete",
 });
 ```
 
@@ -346,9 +348,9 @@ Parameters:
 
 ```typescript
 create_correspondent({
-  name: "ACME Corp",
-  match: "ACME",
-  matching_algorithm: 5,
+	name: "ACME Corp",
+	match: "ACME",
+	matching_algorithm: 5,
 });
 ```
 
@@ -366,8 +368,8 @@ Parameters:
 
 ```typescript
 bulk_edit_correspondents({
-  correspondent_ids: [1, 2],
-  operation: "delete",
+	correspondent_ids: [1, 2],
+	operation: "delete",
 });
 ```
 
@@ -397,9 +399,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,
 });
 ```
 
@@ -417,8 +419,8 @@ Parameters:
 
 ```typescript
 bulk_edit_document_types({
-  document_type_ids: [1, 2],
-  operation: "delete",
+	document_type_ids: [1, 2],
+	operation: "delete",
 });
 ```