outline-mcp-server 5.2.1 → 5.3.1

package/README.md

@@ -1,16 +1,22 @@
 # Outline MCP Server
 
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=outline&config=eyJjb21tYW5kIjoibnB4IC15IC0tcGFja2FnZT1vdXRsaW5lLW1jcC1zZXJ2ZXJAbGF0ZXN0IC1jIG91dGxpbmUtbWNwLXNlcnZlci1zdGRpbyIsImVudiI6eyJPVVRMSU5FX0FQSV9LRVkiOiI8UkVQTEFDRV9NRT4iLCJPVVRMSU5FX0FQSV9VUkwiOiJodHRwczovL2FwcC5nZXRvdXRsaW5lLmNvbS9hcGkiLCJPVVRMSU5FX01DUF9QT1JUIjoiNjA2MCJ9fQ%3D%3D)
-
 ![npm](https://img.shields.io/npm/v/outline-mcp-server) • ![downloads](https://img.shields.io/npm/dy/outline-mcp-server)
 
 A Model Context Protocol (MCP) server that provides tools for interacting with [Outline](https://www.getoutline.com/)'s API, enabling AI agents to manage documents, collections, and other entities programmatically through the Outline knowledge base platform.
 
-## 🚨 \***\*Upgrade Notice:\*\*** v5 has introduced several breaking changes: 🚨
+## Quick Installation
+
+### Claude Desktop
+
+🎉 **`outline-mcp-server` now has an extension for Claude Desktop!**
+
+You can now download a Claude Desktop extension from the [releases page](https://github.com/mmmeff/outline-mcp/releases) for quick and easy setup (just double click it).
 
-- the `--port` CLI flag has been migrated to an environment variable, `OUTLINE_MCP_PORT`
-- Minimum node version has been bumped to 20
-- sse & stdio were removed in 5.0.0 but later re-introduced in 5.1.0 and 5.2.0 respectively
+### Cursor
+
+One click install in Cursor:
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=outline&config=eyJjb21tYW5kIjoibnB4IC15IC0tcGFja2FnZT1vdXRsaW5lLW1jcC1zZXJ2ZXJAbGF0ZXN0IC1jIG91dGxpbmUtbWNwLXNlcnZlci1zdGRpbyIsImVudiI6eyJPVVRMSU5FX0FQSV9LRVkiOiI8UkVQTEFDRV9NRT4iLCJPVVRMSU5FX0FQSV9VUkwiOiJodHRwczovL2FwcC5nZXRvdXRsaW5lLmNvbS9hcGkifX0%3D)
 
 ## Features
 
@@ -48,14 +54,16 @@ A Model Context Protocol (MCP) server that provides tools for interacting with [
 - Outline API key with appropriate permissions
 - Note: if you need to use the AI-powered ask feature, you must enable the "AI Answers" feature in your Outline Workspace settings
 
-### Running directly
+### Running
+
+`outline-mcp-server` supports the latest streamable-http protocol, the deprecated sse protocol, and good ole fashioned stdio.
 
 ```bash
 # S-HTTP/SSE servers
-OUTLINE_API_KEY=... npx outline-mcp-server@latest -y
+OUTLINE_API_KEY=... npx -y outline-mcp-server@latest
 
 # STDIO
-OUTLINE_API_KEY=... npx outline-mcp-server-stdio@latest -y
+OUTLINE_API_KEY=... npx -y --package=outline-mcp-server@latest -c outline-mcp-server-stdio
 ```
 
 ### Cursor (mcp.json)

package/build/dxt.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+/**
+ * Outline MCP Desktop Extension (DXT) Server
+ */
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import toolRegistry from './utils/toolRegistry.js';
+import { getMcpServer } from './utils/getMcpServer.js';
+import logger from './utils/logger.js';
+// Configuration - Note: environment variables are set by the DXT runtime
+const CONFIG = {
+    OUTLINE_API_KEY: process.env.OUTLINE_API_KEY,
+    OUTLINE_API_URL: process.env.OUTLINE_API_URL || 'https://app.getoutline.com/api',
+};
+// Error handling for uncaught exceptions
+process.on('uncaughtException', (error) => {
+    logger.error('Uncaught exception:', error);
+    process.exit(1);
+});
+process.on('unhandledRejection', (reason, promise) => {
+    logger.error('Unhandled rejection at:', promise, 'reason:', reason);
+    process.exit(1);
+});
+// Graceful shutdown
+process.on('SIGINT', () => {
+    logger.info('Received SIGINT, shutting down gracefully');
+    process.exit(0);
+});
+process.on('SIGTERM', () => {
+    logger.info('Received SIGTERM, shutting down gracefully');
+    process.exit(0);
+});
+// Start the server
+async function startServer() {
+    try {
+        logger.info('Starting Outline MCP DXT Server...');
+        const server = await getMcpServer();
+        const transport = new StdioServerTransport();
+        await server.connect(transport);
+        logger.info('Outline MCP DXT Server started successfully');
+        logger.info('Server configuration:', {
+            apiUrl: CONFIG.OUTLINE_API_URL,
+            toolsLoaded: `${toolRegistry.tools.length} tools loaded: ${toolRegistry.tools.map(t => t.name).join(', ')}`,
+        });
+    }
+    catch (error) {
+        logger.error('Failed to start server:', error);
+        process.exit(1);
+    }
+}
+startServer();

package/build/tools/createDocument.js

@@ -33,7 +33,7 @@ toolRegistry.register('create_document', {
             if (args.template !== undefined) {
                 payload.template = args.template;
             }
-            const response = await outlineClient.post('/documents', payload);
+            const response = await outlineClient.post('/documents.create', payload);
             return { content: [{ type: 'text', text: JSON.stringify(response.data.data) }] };
         }
         catch (error) {

package/build/utils/getMcpServer.js

@@ -3,7 +3,7 @@ import { loadAllTools } from './loadAllTools.js';
 // Helper to create a new MCP server instance with all tools registered
 export async function getMcpServer() {
     const server = new McpServer({
-        name: 'outline-mcp',
+        name: process.env.npm_package_name || 'outline-mcp-server',
         version: process.env.npm_package_version || 'unknown',
         description: 'Outline Model Context Protocol server',
     });

package/build/utils/logger.js

@@ -0,0 +1,16 @@
+/** Using console.error to guarantee stderr output in logs */
+const logger = {
+    error: (message, ...args) => {
+        console.error(`[ERROR] ${message}`, ...args);
+    },
+    warn: (message, ...args) => {
+        console.error(`[WARN] ${message}`, ...args);
+    },
+    info: (message, ...args) => {
+        console.error(`[INFO] ${message}`, ...args);
+    },
+    debug: (message, ...args) => {
+        console.error(`[DEBUG] ${message}`, ...args);
+    },
+};
+export default logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "outline-mcp-server",
-  "version": "5.2.1",
+  "version": "5.3.1",
   "description": "An MCP server for interacting with Outline's API",
   "type": "module",
   "bin": {
@@ -20,10 +20,12 @@
   },
   "scripts": {
     "build": "tsc && chmod +x build/index.js && chmod +x build/stdio.js",
+    "build:dxt": "./scripts/build-dxt.sh",
     "prepare": "npm run build",
     "watch": "bun --watch src/index.ts",
     "watch:stdio": "bun --watch src/stdio.ts",
     "dev": "concurrently -n 'build,inspector' -c 'blue.bold,green.bold' 'npm run watch' 'npm run inspector'",
+    "run-dxt": "dotenv bun src/dxt.ts",
     "inspector": "npx @modelcontextprotocol/inspector@latest",
     "start": "bun build/index.js",
     "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json}\"",
@@ -43,6 +45,7 @@
     "@types/node": "20.19.1",
     "bun": "^1.2.17",
     "concurrently": "^9.2.0",
+    "dotenv-cli": "^8.0.0",
     "prettier": "3.6.0",
     "semantic-release": "^22.0.12",
     "typescript": "5.x"