@baruchiro/paperless-mcp 0.3.0 → 0.4.0

package/README.md

@@ -2,7 +2,6 @@
 
 # Paperless-NGX MCP Server
 
-[![smithery badge](https://smithery.ai/badge/@baruchiro/paperless-mcp)](https://smithery.ai/server/@baruchiro/paperless-mcp)
 ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/baruchiro/paperless-mcp?utm_source=oss&utm_medium=github&utm_campaign=baruchiro%2Fpaperless-mcp&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
 
 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.
@@ -11,15 +10,7 @@ An MCP (Model Context Protocol) server for interacting with a Paperless-NGX API
 
 [![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=paperless&config=eyJjb21tYW5kIjoibnB4IC15IEBiYXJ1Y2hpcm8vcGFwZXJsZXNzLW1jcEBsYXRlc3QiLCJlbnYiOnsiUEFQRVJMRVNTX1VSTCI6Imh0dHA6Ly95b3VyLXBhcGVybGVzcy1pbnN0YW5jZTo4MDAwIiwiUEFQRVJMRVNTX0FQSV9LRVkiOiJ5b3VyLWFwaS10b2tlbiJ9fQ%3D%3D)
 
-### Installing via Smithery
-
-To install Paperless NGX MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@baruchiro/paperless-mcp):
-
-```bash
-npx -y @smithery/cli install @baruchiro/paperless-mcp --client claude
-```
-
-### Manual Installation
+### Installation
 
 Add these to your MCP config file:
 
@@ -137,6 +128,18 @@ download_document({
 })
 ```
 
+#### get_document_thumbnail
+Get a document thumbnail (image preview) by ID. Returns the thumbnail as a base64-encoded WebP image resource.
+
+Parameters:
+- id: Document ID
+
+```typescript
+get_document_thumbnail({
+  id: 123
+})
+```
+
 #### bulk_edit_documents
 Perform bulk operations on multiple documents.
 
@@ -480,6 +483,57 @@ npm run start -- <baseUrl> <token> --http --port 3000
 - Each request is handled statelessly, following the [StreamableHTTPServerTransport](https://github.com/modelcontextprotocol/typescript-sdk) pattern.
 - GET and DELETE requests to `/mcp` will return 405 Method Not Allowed.
 
+<details>
+<summary>Docker Deployment</summary>
+
+The MCP server can be deployed using Docker and Docker Compose. The Docker image automatically runs in HTTP mode with SSE (Server-Sent Events) support on port 3000.
+
+### Docker Compose Configuration
+
+Create a `docker-compose.yml` file:
+
+```yaml
+services:
+  paperless-mcp:
+    container_name: paperless-mcp
+    image: ghcr.io/baruchiro/paperless-mcp:latest
+    environment:
+      - PAPERLESS_URL=http://your-paperless-ngx-server:8000
+      - PAPERLESS_API_KEY=your-paperless-api-key
+      - PAPERLESS_PUBLIC_URL=https://paperless-ngx.yourpublicurl.com
+    ports:
+      - "3000:3000"
+    restart: unless-stopped
+```
+
+Then run:
+```bash
+docker-compose up -d
+```
+
+### Using with Continue VS Code Extension
+
+If you're using the [Continue VS Code extension](https://continue.dev/), you can configure it to use the Dockerized MCP server via SSE.
+
+Create or edit `.continue/mcpServers/paperless-mcp.yaml` at your workspace root:
+
+```yaml
+name: Paperless
+version: 0.0.1
+schema: v1
+mcpServers:
+  - name: Paperless
+    type: sse
+    url: http://localhost:3000/sse
+```
+
+**Notes:**
+- Replace `localhost` with your Docker host's IP address or hostname if running on a remote server
+- The Docker container handles authentication via environment variables, so no credentials are needed in the Continue config
+- The SSE endpoint is available at `/sse` on the configured port (default: 3000)
+
+</details>
+
 # Credits
 
 This project is a fork of [nloui/paperless-mcp](https://github.com/nloui/paperless-mcp). Many thanks to the original author for their work. Contributions and improvements may be returned upstream.

package/build/api/PaperlessAPI.d.ts

@@ -1,3 +1,4 @@
+import { AxiosResponse } from "axios";
 import { BulkEditDocumentsResult, BulkEditParameters, Correspondent, CustomField, Document, DocumentsResponse, DocumentType, GetCorrespondentsResponse, GetCustomFieldsResponse, GetDocumentTypesResponse, GetTagsResponse, Tag } from "./types";
 export declare class PaperlessAPI {
     private readonly baseUrl;
@@ -10,7 +11,8 @@ export declare class PaperlessAPI {
     getDocument(id: number): Promise<Document>;
     updateDocument(id: number, data: Partial<Document>): Promise<Document>;
     searchDocuments(query: string): Promise<DocumentsResponse>;
-    downloadDocument(id: number, asOriginal?: boolean): Promise<import("axios").AxiosResponse<any, any>>;
+    downloadDocument(id: number, asOriginal?: boolean): Promise<AxiosResponse<ArrayBuffer>>;
+    getThumbnail(id: number): Promise<AxiosResponse<ArrayBuffer>>;
     getTags(): Promise<GetTagsResponse>;
     createTag(data: Partial<Tag>): Promise<Tag>;
     updateTag(id: number, data: Partial<Tag>): Promise<Tag>;

package/build/api/PaperlessAPI.js

@@ -148,6 +148,17 @@ class PaperlessAPI {
             return response;
         });
     }
+    getThumbnail(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield axios_1.default.get(`${this.baseUrl}/api/documents/${id}/thumb/`, {
+                headers: {
+                    Authorization: `Token ${this.token}`,
+                },
+                responseType: "arraybuffer",
+            });
+            return response;
+        });
+    }
     // Tag operations
     getTags() {
         return __awaiter(this, void 0, void 0, function* () {

package/build/tools/documents.js

@@ -249,6 +249,25 @@ function registerDocumentTools(server, api) {
             ],
         };
     })));
+    server.tool("get_document_thumbnail", "Get a document thumbnail (image preview) by ID. Returns the thumbnail as a base64-encoded WebP image resource.", {
+        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.getThumbnail(args.id);
+        return {
+            content: [
+                {
+                    type: "resource",
+                    resource: {
+                        uri: `document-${args.id}-thumb.webp`,
+                        blob: Buffer.from(response.data).toString("base64"),
+                        mimeType: "image/webp",
+                    },
+                },
+            ],
+        };
+    })));
     server.tool("update_document", "Update a specific document with new values. This tool allows you to modify any document field including title, correspondent, document type, storage path, tags, custom fields, and more. Only the fields you specify will be updated.", {
         id: zod_1.z.number().describe("The ID of the document to update"),
         title: zod_1.z

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baruchiro/paperless-mcp",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "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": {