outline-mcp-server 5.5.5 → 5.6.1

package/README.md

@@ -135,6 +135,45 @@ Example queries your AI assistant can now handle:
 - "Update the content of a document"
 - "Add a comment to a document"
 
+## Docker Usage
+
+You can run the Outline MCP Server using Docker or Docker Compose for easy deployment.
+
+### 1. Prepare your `.env` file
+
+Copy `.env.example` to `.env` and fill in your Outline API key:
+
+```bash
+cp .env.example .env
+# Edit .env and set OUTLINE_API_KEY=your_outline_api_key_here
+```
+
+### 2. Build and run with Docker Compose (recommended)
+
+```bash
+docker-compose up --build
+```
+
+- The server will be available on port 6060 by default.
+- Environment variables are loaded from your `.env` file.
+
+### 3. Build and run manually with Docker
+
+```bash
+docker build -t outline-mcp-server .
+docker run --env-file .env -p 6060:6060 outline-mcp-server
+```
+
+- You can override environment variables at runtime with `-e` flags if needed.
+
+### 4. Customizing
+
+- To change the API URL, set `OUTLINE_API_URL` in your `.env` file or as an environment variable.
+- To change the port or host, set `OUTLINE_MCP_PORT` and `OUTLINE_MCP_HOST` in your `.env` file or as environment variables.
+- For more advanced setups, edit `docker-compose.yml` as needed.
+
+---
+
 ## Development
 
 ```bash

package/build/tools/listDocuments.js

@@ -35,15 +35,27 @@ toolRegistry.register('list_documents', {
                 limit: args.limit || 25,
                 sort: args.sort || 'updatedAt',
                 direction: args.direction || 'DESC',
-                collectionId: args.collectionId || '',
-                userId: args.userId || '',
-                backlinkDocumentId: args.backlinkDocumentId || '',
-                parentDocumentId: args.parentDocumentId || '',
             };
             // Only add template if it's explicitly defined
             if (args.template !== undefined) {
                 payload.template = args.template;
             }
+            // Only add collectionId if it's provided
+            if (args.collectionId) {
+                payload.collectionId = args.collectionId;
+            }
+            // Only add userId if it's provided
+            if (args.userId) {
+                payload.userId = args.userId;
+            }
+            // Only add backlinkDocumentId if it's provided
+            if (args.backlinkDocumentId) {
+                payload.backlinkDocumentId = args.backlinkDocumentId;
+            }
+            // Only add parentDocumentId if it's provided
+            if (args.parentDocumentId) {
+                payload.parentDocumentId = args.parentDocumentId;
+            }
             // Only add query if it's provided
             if (args.query) {
                 payload.query = args.query;

package/build/utils/getMcpServer.js

@@ -7,10 +7,12 @@ export async function getMcpServer() {
         version: process.env.npm_package_version || 'unknown',
         description: 'Outline Model Context Protocol server',
     });
-    await loadAllTools(tool => server.registerTool(tool.name, {
-        description: tool.description,
-        inputSchema: tool.inputSchema,
-        outputSchema: tool.outputSchema,
-    }, tool.callback));
+    await loadAllTools((tool) => {
+        server.registerTool(tool.name, {
+            description: tool.description,
+            inputSchema: tool.inputSchema,
+            outputSchema: tool.outputSchema,
+        }, tool.callback);
+    });
     return server;
 }

package/build/utils/loadAllTools.js

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { fileURLToPath } from 'url';
+import { fileURLToPath, pathToFileURL } from 'url';
 import toolRegistry from './toolRegistry.js';
 /**
  * Dynamically imports all tool files from the tools directory
@@ -14,10 +14,12 @@ export async function loadAllTools(onToolLoaded) {
     const toolFiles = fs
         .readdirSync(toolsDir)
         .filter(file => file.endsWith('.ts') || file.endsWith('.js'));
-    // Import all tool files, causing them to be restered via `registerTool`
+    // Import all tool files, causing them to be registered via `registerTool`
     for (const file of toolFiles) {
         const resolved = path.resolve(toolsDir, file);
-        await import(resolved);
+        // Convert path to file:// URL for cross-platform ESM compatibility
+        const fileURL = pathToFileURL(resolved).href;
+        await import(fileURL);
     }
     // configure McpServer with all definitions
     for (const tool of toolRegistry.tools) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "outline-mcp-server",
-  "version": "5.5.5",
+  "version": "5.6.1",
   "description": "An MCP server for interacting with Outline's API",
   "type": "module",
   "bin": {