Skip to main content
Glama
baruchiro

paperless-mcp

by baruchiro
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

bulk_edit_documents

Bulk edit multiple Paperless documents by updating tags, correspondents, document types, custom fields, or permissions, and by reprocessing, rotating, merging, splitting, or deleting pages.

Instructions

Perform bulk operations on multiple documents. Note: 'remove_tag' removes a tag from specific documents (tag remains in system), while 'delete_tag' permanently deletes a tag from the entire system. ⚠️ WARNING: 'delete' method permanently deletes documents and requires confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNo
mergeNoFor set_permissions: true adds to existing permissions and keeps the current owner; false (default) replaces the listed users/groups
ownerNoFor set_permissions: new owner user ID, or null to remove the owner. Unless merge is true, omitting owner also clears the current owner.
pagesNo
methodYes
confirmNoMust be true when method is 'delete' to confirm destructive operation
degreesNo
add_tagsNo
documentsYes
remove_tagsNo
storage_pathNo
correspondentNo
document_typeNo
set_permissionsNoFor set_permissions: view/change permissions to apply. Omitted actions (view/change) and omitted users/groups lists are left untouched; an empty list [] removes all (unless merge is true). Omit entirely for owner-only changes.
delete_originalsNo
add_custom_fieldsNo
metadata_document_idNo
remove_custom_fieldsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.2.1
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / add_custom_fields
      Added value: +{
+  "items": {
+    "properties": {
+      "field": {
+        "type": "number"
+      },
+      "value": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "items": {
+              "type": "number"
+            },
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) — NOT trailing symbol format (e.g., 10.00$). For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456]). For select fields, pass the option's label (the display text from get_custom_field / list_custom_fields); the server translates it to the encoding Paperless expects."
+      }
+    },
+    "required": [
+      "field",
+      "value"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / confirm
      Added value: +{
+  "description": "Must be true when method is 'delete' to confirm destructive operation",
+  "type": "boolean"
+}
    • addedInput schema / properties / merge
      Added value: +{
+  "description": "For set_permissions: true adds to existing permissions and keeps the current owner; false (default) replaces the listed users/groups",
+  "type": "boolean"
+}
    • changedInput schema / properties / method / enum
      Previous value: -[
-  "set_correspondent",
-  "set_document_type",
-  "set_storage_path",
-  "add_tag",
-  "remove_tag",
-  "modify_tags",
-  "delete",
-  "reprocess",
-  "set_permissions",
-  "merge",
-  "split",
-  "rotate",
-  "delete_pages"
-]New value: +[
+  "set_correspondent",
+  "set_document_type",
+  "set_storage_path",
+  "add_tag",
+  "remove_tag",
+  "modify_tags",
+  "modify_custom_fields",
+  "delete",
+  "reprocess",
+  "set_permissions",
+  "merge",
+  "split",
+  "rotate",
+  "delete_pages"
+]
    • addedInput schema / properties / owner
      Added value: +{
+  "anyOf": [
+    {
+      "maximum": 9007199254740991,
+      "minimum": -9007199254740991,
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "For set_permissions: new owner user ID, or null to remove the owner. Unless merge is true, omitting owner also clears the current owner."
+}
    • removedInput schema / properties / permissions
      Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "merge": {
-      "type": "boolean"
-    },
-    "owner": {
-      "type": [
-        "number",
-        "null"
-      ]
-    },
-    "set_permissions": {
-      "additionalProperties": false,
-      "properties": {
-        "change": {
-          "additionalProperties": false,
-          "properties": {
-            "groups": {
-              "items": {
-                "type": "number"
-              },
-              "type": "array"
-            },
-            "users": {
-              "items": {
-                "type": "number"
-              },
-              "type": "array"
-            }
-          },
-          "required": [
-            "users",
-            "groups"
-          ],
-          "type": "object"
-        },
-        "view": {
-          "additionalProperties": false,
-          "properties": {
-            "groups": {
-              "items": {
-                "type": "number"
-              },
-              "type": "array"
-            },
-            "users": {
-              "items": {
-                "type": "number"
-              },
-              "type": "array"
-            }
-          },
-          "required": [
-            "users",
-            "groups"
-          ],
-          "type": "object"
-        }
-      },
-      "required": [
-        "view",
-        "change"
-      ],
-      "type": "object"
-    }
-  },
-  "type": "object"
-}
    • addedInput schema / properties / remove_custom_fields
      Added value: +{
+  "items": {
+    "type": "number"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / set_permissions
      Added value: +{
+  "additionalProperties": false,
+  "description": "For set_permissions: view/change permissions to apply. Omitted actions (view/change) and omitted users/groups lists are left untouched; an empty list [] removes all (unless merge is true). Omit entirely for owner-only changes.",
+  "properties": {
+    "change": {
+      "additionalProperties": false,
+      "properties": {
+        "groups": {
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        },
+        "users": {
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "view": {
+      "additionalProperties": false,
+      "properties": {
+        "groups": {
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        },
+        "users": {
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. First observedv1.0.0

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full behavioral burden. It usefully discloses that 'delete_tag' is system-wide and permanent, and that 'delete' permanently deletes documents and needs confirmation. But it remains silent on side effects, permissions, or reversibility for the remaining methods (set_permissions, merge, split, reprocess, etc.).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences: purpose first, then method distinction, then destructive warning. Nothing is wasted, though given the tool's breadth it is arguably too sparse rather than too long.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 18 parameters, 14 methods, nested objects, no annotations, and no output schema, the description is substantially incomplete. It covers only a fraction of the method semantics and parameter meanings an agent would need to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 22%, so the description must compensate. It explains the distinction between two method values but adds no meaning for core parameters like 'tag', 'documents', 'pages', 'storage_path', or most of the 14 enum methods, leaving most parameters undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Perform bulk operations on multiple documents'), which clearly separates it from single-document siblings like update_document and from other bulk tools. However, it does not enumerate what kinds of operations are available beyond the two tag methods it calls out, so it stops short of full sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit guidance for choosing between two similar methods ('remove_tag' vs 'delete_tag') and warns that 'delete' requires confirmation, which is useful. But it gives no guidance on when to use this bulk tool versus other tools, and no context for the other 11 methods.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools