@baruchiro/paperless-mcp 0.2.1 → 0.2.2

package/build/tools/correspondents.js

@@ -27,7 +27,7 @@ const utils_1 = require("../api/utils");
 const middlewares_1 = require("./utils/middlewares");
 const queryString_1 = require("./utils/queryString");
 function registerCorrespondentTools(server, api) {
-    server.tool("list_correspondents", {
+    server.tool("list_correspondents", "List all correspondents with optional filtering and pagination. Correspondents represent entities that send or receive documents.", {
         page: zod_1.z.number().optional(),
         page_size: zod_1.z.number().optional(),
         name__icontains: zod_1.z.string().optional(),
@@ -50,7 +50,7 @@ function registerCorrespondentTools(server, api) {
             ],
         };
     })));
-    server.tool("get_correspondent", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
+    server.tool("get_correspondent", "Get a specific correspondent by ID with full details including matching rules.", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
         if (!api)
             throw new Error("Please configure API connection first");
         const response = yield api.getCorrespondent(args.id);
@@ -61,7 +61,7 @@ function registerCorrespondentTools(server, api) {
             ],
         };
     })));
-    server.tool("create_correspondent", {
+    server.tool("create_correspondent", "Create a new correspondent with optional matching pattern and algorithm for automatic document assignment.", {
         name: zod_1.z.string(),
         match: zod_1.z.string().optional(),
         matching_algorithm: zod_1.z
@@ -82,7 +82,7 @@ function registerCorrespondentTools(server, api) {
             ],
         };
     })));
-    server.tool("update_correspondent", {
+    server.tool("update_correspondent", "Update an existing correspondent's name, matching pattern, or matching algorithm.", {
         id: zod_1.z.number(),
         name: zod_1.z.string(),
         match: zod_1.z.string().optional(),

package/build/tools/customFields.js

@@ -47,7 +47,7 @@ function registerCustomFieldTools(server, api) {
             ],
         };
     })));
-    server.tool("get_custom_field", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
+    server.tool("get_custom_field", "Get a specific custom field by ID with full details including data type and extra configuration.", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
         if (!api)
             throw new Error("Please configure API connection first");
         const response = yield api.getCustomField(args.id);
@@ -55,7 +55,7 @@ function registerCustomFieldTools(server, api) {
             content: [{ type: "text", text: JSON.stringify(response) }],
         };
     })));
-    server.tool("create_custom_field", {
+    server.tool("create_custom_field", "Create a new custom field with a specified data type (string, url, date, boolean, integer, float, monetary, documentlink, or select).", {
         name: zod_1.z.string(),
         data_type: zod_1.z.enum([
             "string",
@@ -77,7 +77,7 @@ function registerCustomFieldTools(server, api) {
             content: [{ type: "text", text: JSON.stringify(response) }],
         };
     })));
-    server.tool("update_custom_field", {
+    server.tool("update_custom_field", "Update an existing custom field's name, data type, or extra configuration data.", {
         id: zod_1.z.number(),
         name: zod_1.z.string().optional(),
         data_type: zod_1.z

package/build/tools/documentTypes.js

@@ -50,7 +50,7 @@ function registerDocumentTypeTools(server, api) {
             ],
         };
     })));
-    server.tool("get_document_type", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
+    server.tool("get_document_type", "Get a specific document type by ID with full details including matching rules.", { id: zod_1.z.number() }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
         if (!api)
             throw new Error("Please configure API connection first");
         const response = yield api.request(`/document_types/${args.id}/`);
@@ -59,7 +59,7 @@ function registerDocumentTypeTools(server, api) {
             content: [{ type: "text", text: JSON.stringify(enhancedDocumentType) }],
         };
     })));
-    server.tool("create_document_type", {
+    server.tool("create_document_type", "Create a new document type with optional matching pattern and algorithm for automatic document classification.", {
         name: zod_1.z.string(),
         match: zod_1.z.string().optional(),
         matching_algorithm: zod_1.z
@@ -78,7 +78,7 @@ function registerDocumentTypeTools(server, api) {
             content: [{ type: "text", text: JSON.stringify(enhancedDocumentType) }],
         };
     })));
-    server.tool("update_document_type", {
+    server.tool("update_document_type", "Update an existing document type's name, matching pattern, or matching algorithm.", {
         id: zod_1.z.number(),
         name: zod_1.z.string(),
         match: zod_1.z.string().optional(),

package/build/tools/documents.js

@@ -111,7 +111,7 @@ function registerDocumentTools(server, api) {
             ],
         };
     })));
-    server.tool("post_document", {
+    server.tool("post_document", "Upload a new document to Paperless-NGX with optional metadata like title, correspondent, document type, tags, and custom fields.", {
         file: zod_1.z.string(),
         filename: zod_1.z.string(),
         title: zod_1.z.string().optional(),
@@ -184,7 +184,7 @@ function registerDocumentTools(server, api) {
         const docsResponse = yield api.getDocuments(query.toString() ? `?${query.toString()}` : "");
         return (0, documentEnhancer_1.convertDocsWithNames)(docsResponse, api);
     })));
-    server.tool("get_document", {
+    server.tool("get_document", "Get a specific document by ID with full details including correspondent, document type, tags, and custom fields.", {
         id: zod_1.z.number(),
     }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
         if (!api)
@@ -241,7 +241,7 @@ function registerDocumentTools(server, api) {
         const docsResponse = yield api.searchDocuments(args.query);
         return (0, documentEnhancer_1.convertDocsWithNames)(docsResponse, api);
     })));
-    server.tool("download_document", {
+    server.tool("download_document", "Download a document file by ID. Returns the document as a base64-encoded resource.", {
         id: zod_1.z.number(),
         original: zod_1.z.boolean().optional(),
     }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {

package/build/tools/tags.js

@@ -39,7 +39,7 @@ function registerTagTools(server, api) {
             ],
         };
     })));
-    server.tool("create_tag", {
+    server.tool("create_tag", "Create a new tag with optional color, matching pattern, and matching algorithm for automatic document tagging.", {
         name: zod_1.z.string(),
         color: zod_1.z
             .string()
@@ -67,7 +67,7 @@ function registerTagTools(server, api) {
             ],
         };
     })));
-    server.tool("update_tag", {
+    server.tool("update_tag", "Update an existing tag's name, color, matching pattern, or matching algorithm.", {
         id: zod_1.z.number(),
         name: zod_1.z.string(),
         color: zod_1.z

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baruchiro/paperless-mcp",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Model Context Protocol (MCP) server for interacting with Paperless-NGX document management system. Enables AI assistants to manage documents, tags, correspondents, and document types through the Paperless-NGX API.",
   "main": "build/index.js",
   "bin": {