@baruchiro/paperless-mcp 0.4.0 → 0.4.1

package/build/api/PaperlessAPI.d.ts

@@ -6,7 +6,7 @@ export declare class PaperlessAPI {
     constructor(baseUrl: string, token: string);
     request<T = any>(path: string, options?: RequestInit): Promise<T>;
     bulkEditDocuments(documents: number[], method: string, parameters?: BulkEditParameters): Promise<BulkEditDocumentsResult>;
-    postDocument(file: File, metadata?: Record<string, string | string[] | number | number[]>): Promise<string>;
+    postDocument(document: Buffer, filename: string, metadata?: Record<string, string | string[] | number | number[]>): Promise<string>;
     getDocuments(query?: string): Promise<DocumentsResponse>;
     getDocument(id: number): Promise<Document>;
     updateDocument(id: number, data: Partial<Document>): Promise<Document>;

package/build/api/PaperlessAPI.js

@@ -79,10 +79,10 @@ class PaperlessAPI {
             });
         });
     }
-    postDocument(file_1) {
-        return __awaiter(this, arguments, void 0, function* (file, metadata = {}) {
+    postDocument(document_1, filename_1) {
+        return __awaiter(this, arguments, void 0, function* (document, filename, metadata = {}) {
             const formData = new form_data_1.default();
-            formData.append("document", file);
+            formData.append("document", document, { filename });
             // Add optional metadata fields
             if (metadata.title)
                 formData.append("title", metadata.title);
@@ -98,10 +98,10 @@ class PaperlessAPI {
                 metadata.tags.forEach((tag) => formData.append("tags", tag));
             }
             if (metadata.archive_serial_number) {
-                formData.append("archive_serial_number", metadata.archive_serial_number);
+                formData.append("archive_serial_number", String(metadata.archive_serial_number));
             }
             if (metadata.custom_fields) {
-                metadata.custom_fields.forEach((field) => formData.append("custom_fields", field));
+                metadata.custom_fields.forEach((field) => formData.append("custom_fields", String(field)));
             }
             const response = yield axios_1.default.post(`${this.baseUrl}/api/documents/post_document/`, formData, {
                 headers: Object.assign({ Authorization: `Token ${this.token}` }, formData.getHeaders()),

package/build/tools/customFields.js

@@ -55,7 +55,7 @@ function registerCustomFieldTools(server, api) {
             content: [{ type: "text", text: JSON.stringify(response) }],
         };
     })));
-    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).", {
+    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). For monetary fields, values must use currency code prefix format (e.g., USD10.00, GBP123.45) — NOT trailing symbol format (e.g., 10.00$).", {
         name: zod_1.z.string(),
         data_type: zod_1.z.enum([
             "string",

package/build/tools/documents.js

@@ -25,6 +25,8 @@ const zod_1 = require("zod");
 const documentEnhancer_1 = require("../api/documentEnhancer");
 const empty_1 = require("./utils/empty");
 const middlewares_1 = require("./utils/middlewares");
+const monetary_1 = require("./utils/monetary");
+const descriptions_1 = require("./utils/descriptions");
 function registerDocumentTools(server, api) {
     server.tool("bulk_edit_documents", "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.", {
         documents: zod_1.z.array(zod_1.z.number()),
@@ -59,7 +61,7 @@ function registerDocumentTools(server, api) {
                 zod_1.z.boolean(),
                 zod_1.z.array(zod_1.z.number()),
                 zod_1.z.null(),
-            ]),
+            ]).describe(descriptions_1.CUSTOM_FIELD_VALUE_DESCRIPTION),
         }))
             .optional()
             .transform(empty_1.arrayNotEmpty),
@@ -101,6 +103,7 @@ function registerDocumentTools(server, api) {
             throw new Error("Confirmation required for destructive operation. Set confirm: true to proceed.");
         }
         const { documents, method, add_custom_fields } = args, parameters = __rest(args, ["documents", "method", "add_custom_fields"]);
+        (0, monetary_1.validateCustomFields)(add_custom_fields);
         // Transform add_custom_fields into the two separate API parameters
         const apiParameters = Object.assign({}, parameters);
         if (add_custom_fields && add_custom_fields.length > 0) {
@@ -126,16 +129,19 @@ function registerDocumentTools(server, api) {
         document_type: zod_1.z.number().optional(),
         storage_path: zod_1.z.number().optional(),
         tags: zod_1.z.array(zod_1.z.number()).optional(),
-        archive_serial_number: zod_1.z.string().optional(),
+        archive_serial_number: zod_1.z.number().optional(),
         custom_fields: zod_1.z.array(zod_1.z.number()).optional(),
     }, (0, middlewares_1.withErrorHandling)((args, extra) => __awaiter(this, void 0, void 0, function* () {
         if (!api)
             throw new Error("Please configure API connection first");
-        const binaryData = Buffer.from(args.file, "base64");
-        const blob = new Blob([binaryData]);
-        const file = new File([blob], args.filename);
-        const { file: _, filename: __ } = args, metadata = __rest(args, ["file", "filename"]);
-        const response = yield api.postDocument(file, metadata);
+        // Validate base64 input
+        const base64Regex = /^[A-Za-z0-9+/]*={0,2}$/;
+        if (!base64Regex.test(args.file)) {
+            throw new Error("Invalid base64-encoded file data. Please provide a valid base64 string.");
+        }
+        const { file, filename } = args, metadata = __rest(args, ["file", "filename"]);
+        const document = Buffer.from(file, "base64");
+        const response = yield api.postDocument(document, filename, metadata);
         let result;
         if (typeof response === "string" && /^\d+$/.test(response)) {
             result = { id: Number(response) };
@@ -322,7 +328,7 @@ function registerDocumentTools(server, api) {
                 zod_1.z.array(zod_1.z.number()),
                 zod_1.z.null(),
             ])
-                .describe("The value for the custom field. For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456])."),
+                .describe(descriptions_1.CUSTOM_FIELD_VALUE_DESCRIPTION),
         }))
             .optional()
             .describe("Array of custom field values to assign"),
@@ -330,6 +336,7 @@ function registerDocumentTools(server, api) {
         if (!api)
             throw new Error("Please configure API connection first");
         const { id } = args, updateData = __rest(args, ["id"]);
+        (0, monetary_1.validateCustomFields)(updateData.custom_fields);
         const response = yield api.updateDocument(id, updateData);
         return (0, documentEnhancer_1.convertDocsWithNames)(response, api);
     })));

package/build/tools/utils/descriptions.d.ts

@@ -0,0 +1 @@
+export declare const CUSTOM_FIELD_VALUE_DESCRIPTION = "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) \u2014 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]).";

package/build/tools/utils/descriptions.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CUSTOM_FIELD_VALUE_DESCRIPTION = void 0;
+exports.CUSTOM_FIELD_VALUE_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]).";

package/build/tools/utils/monetary.d.ts

@@ -0,0 +1,5 @@
+export declare function getMonetaryValidationError(value: string): string | null;
+export declare function validateCustomFields(custom_fields: {
+    field: number;
+    value: unknown;
+}[] | undefined): void;

package/build/tools/utils/monetary.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMonetaryValidationError = getMonetaryValidationError;
+exports.validateCustomFields = validateCustomFields;
+const SYMBOL_TO_CODE = {
+    $: "USD",
+    "€": "EUR",
+    "£": "GBP",
+    "¥": "JPY",
+    "₹": "INR",
+    "₪": "ILS",
+};
+const TRAILING_SYMBOL_REGEX = new RegExp(`^(\\d+(?:\\.\\d+)?)[${Object.keys(SYMBOL_TO_CODE).join("")}]$`);
+function getMonetaryValidationError(value) {
+    const trailingMatch = TRAILING_SYMBOL_REGEX.exec(value);
+    if (trailingMatch) {
+        const amount = trailingMatch[1];
+        const symbol = value.slice(-1);
+        const code = SYMBOL_TO_CODE[symbol] || "USD";
+        const numericAmount = parseFloat(amount);
+        const formattedAmount = isNaN(numericAmount) ? amount : numericAmount.toFixed(2);
+        return (`Invalid monetary format "${value}". ` +
+            `Paperless-NGX requires the currency code as a prefix, e.g. "${code}${formattedAmount}". ` +
+            `Use the format: {CURRENCY_CODE}{amount} (e.g., USD10.00, GBP123.45, EUR9.99).`);
+    }
+    return null;
+}
+function validateCustomFields(custom_fields) {
+    custom_fields === null || custom_fields === void 0 ? void 0 : custom_fields.filter((cf) => typeof cf.value === "string").forEach((cf) => {
+        const monetaryError = getMonetaryValidationError(cf.value);
+        if (monetaryError)
+            throw new Error(monetaryError);
+    });
+}

package/build/tools/utils/monetary.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tools/utils/monetary.test.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const monetary_1 = require("./monetary");
+(0, node_test_1.test)("returns null for non-monetary strings", () => {
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("hello"), null);
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("some text"), null);
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)(""), null);
+});
+(0, node_test_1.test)("returns null for valid monetary prefix format", () => {
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("USD10.00"), null);
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("GBP123.45"), null);
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("EUR9.99"), null);
+    strict_1.default.equal((0, monetary_1.getMonetaryValidationError)("ILS50.00"), null);
+});
+(0, node_test_1.test)("returns error for trailing currency symbol", () => {
+    const err = (0, monetary_1.getMonetaryValidationError)("10.00$");
+    strict_1.default.ok(err);
+    strict_1.default.match(err, /USD10\.00/);
+    strict_1.default.match(err, /currency code as a prefix/);
+});

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@baruchiro/paperless-mcp",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "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": {
     "paperless-mcp": "build/index.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "node --require ts-node/register --test src/**/*.test.ts",
     "start": "ts-node src/index.ts",
     "build": "tsc",
     "dxt-pack": "dxt pack",