outline-mcp-server 4.12.3 → 5.0.1

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "outline-mcp-server",
-  "version": "4.12.3",
+  "version": "5.0.1",
   "description": "An MCP server for interacting with Outline's API",
   "type": "module",
   "bin": {
-    "outline-mcp-server": "./bin/cli.js",
-    "outline-mcp-server-stdio": "./build/index.js"
+    "outline-mcp-server": "./build/index.js"
   },
   "files": [
     "build",
@@ -20,34 +19,32 @@
     "url": "https://github.com/mmmeff/outline-mcp-server"
   },
   "scripts": {
-    "build": "tsc && chmod +x build/index.js && chmod +x bin/cli.js",
+    "build": "tsc && chmod +x build/index.js",
     "prepare": "npm run build",
-    "watch": "npm run build && tsc --watch",
-    "dev": "concurrently -n 'build,inspector' -c 'blue.bold,green.bold' 'npm run watch' 'npx @modelcontextprotocol/inspector build/index.js'",
-    "start:stdio": "npm run build && echo 'build done. running...\n' && node build/index.js",
-    "start": "npx -y supergateway --port 6060 --stdio \"npm run start:stdio\"",
+    "watch": "bun --watch src/index.ts",
+    "dev": "concurrently -n 'build,inspector' -c 'blue.bold,green.bold' 'npm run watch' 'npm run inspector'",
+    "inspector": "npx @modelcontextprotocol/inspector@latest -y",
+    "start": "bun build/index.js",
     "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json}\"",
-    "semantic-release": "semantic-release",
-    "test:e2e": "playwright test",
-    "test:e2e:ui": "playwright test --ui",
-    "test:e2e:debug": "playwright test --debug"
+    "semantic-release": "semantic-release"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "0.6.0",
-    "axios": "^1.6.0",
-    "dotenv": "16.4.7",
-    "omit-ts": "^2.0.1"
+    "@modelcontextprotocol/sdk": "1.12.1",
+    "axios": "1.9.0",
+    "bun": "^1.2.15",
+    "dotenv": "16.5.0",
+    "fastify": "^4.28.1",
+    "omit-ts": "^2.0.1",
+    "zod": "3.25.61"
   },
   "devDependencies": {
-    "@faker-js/faker": "^9.6.0",
-    "@playwright/test": "^1.42.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/node": "^20.11.24",
+    "@types/node": "20.x",
     "concurrently": "^9.1.2",
     "prettier": "^3.2.5",
     "semantic-release": "^22.0.12",
-    "typescript": "^5.3.3"
+    "typescript": "5.x"
   },
   "keywords": [
     "outline",
@@ -57,6 +54,6 @@
   ],
   "license": "MIT",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

package/bin/cli.js

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-
-import { spawn } from 'child_process';
-import { fileURLToPath } from 'url';
-import { dirname, resolve } from 'path';
-
-// Get the directory of the current script
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Parse command line arguments
-const args = process.argv.slice(2);
-let port = 6060; // Default port
-
-// Parse --port argument
-for (let i = 0; i < args.length; i++) {
-  if (args[i] === '--port' && i + 1 < args.length) {
-    port = parseInt(args[i + 1], 10);
-    // Remove these arguments so they don't get passed to supergateway
-    args.splice(i, 2);
-    i--;
-  }
-}
-
-// Check for required environment variable
-if (!process.env.OUTLINE_API_KEY) {
-  console.error('\x1b[31mError: OUTLINE_API_KEY environment variable is required but not set.\x1b[0m');
-  console.error('Please set this environment variable before running the server.');
-  process.exit(1);
-}
-
-// Path to the built index.js file
-const serverPath = resolve(__dirname, '../build/index.js');
-
-// Spawn the supergateway process
-const gateway = spawn('npx', [
-  '-y',
-  'supergateway',
-  '--port',
-  port.toString(),
-  '--stdio',
-  `node ${serverPath}`
-], {
-  stdio: 'inherit',
-  shell: true
-});
-
-// Handle process exit
-process.on('SIGINT', () => {
-  console.log('SIGINT received, killing outline-mcp-server');
-  gateway.kill('SIGINT');
-});
-
-gateway.on('close', (code) => {
-  console.log('outline-mcp-server exited with code', code);
-  process.exit(code);
-}); 

package/build/e2e/archiveDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('archive_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'archive_document');
-    });
-});

package/build/e2e/askDocuments.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('ask_documents', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'ask_documents');
-    });
-});

package/build/e2e/createCollection.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('create_collection', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'create_collection');
-    });
-});

package/build/e2e/createComment.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('create_comment', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'create_comment');
-    });
-});

package/build/e2e/createDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('create_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'create_document');
-    });
-});

package/build/e2e/createTemplateFromDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('create_template_from_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'create_template_from_document');
-    });
-});

package/build/e2e/deleteComment.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('delete_comment', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'delete_comment');
-    });
-});

package/build/e2e/deleteDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('delete_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'delete_document');
-    });
-});

package/build/e2e/getCollection.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('get_collection', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'get_collection');
-    });
-});

package/build/e2e/getDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('get_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'get_document');
-    });
-});

package/build/e2e/listCollections.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('list_collections', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'list_collections');
-    });
-});

package/build/e2e/listDocuments.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('list_documents', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'list_documents');
-    });
-});

package/build/e2e/moveDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('move_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'move_document');
-    });
-});

package/build/e2e/searchDocuments.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('search_documents', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'search_documents');
-    });
-});

package/build/e2e/setup.js

@@ -1,33 +0,0 @@
-import { test } from '@playwright/test';
-import { registerTools } from '../utils/importTools.js';
-/**
- * Helper function to mock API responses
- */
-export async function mockApiResponse(page, url, response) {
-    await page.route(url, route => {
-        route.fulfill({
-            status: 200,
-            contentType: 'application/json',
-            body: JSON.stringify(response),
-        });
-    });
-}
-/**
- * Helper function to wait for API calls
- */
-export async function loadTool(page, toolName) {
-    return await test.step(`Loading tool: ${toolName}`, async () => {
-        const toolDefinitions = await registerTools();
-        const tool = toolDefinitions[toolName];
-        if (!tool) {
-            // TODO: Make this actually type-safe instead of a runtime error
-            throw new Error(`Tool not found for name: ${toolName}`);
-        }
-        await page.goto('/');
-        await page.getByRole('button', { name: 'Connect' }).click();
-        await page.getByRole('button', { name: 'List Tools' }).click();
-        await page.getByText(toolName).click();
-        await page.waitForTimeout(100);
-        return tool;
-    });
-}

package/build/e2e/updateCollection.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('update_collection', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'update_collection');
-    });
-});

package/build/e2e/updateComment.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('update_comment', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'update_comment');
-    });
-});

package/build/e2e/updateDocument.spec.js

@@ -1,7 +0,0 @@
-import test from '@playwright/test';
-import runSmokeTestForTool from './util/smokeTest';
-test.describe('update_document', () => {
-    test('passes a smoke test', async ({ page }) => {
-        await runSmokeTestForTool(page, 'update_document');
-    });
-});

package/build/e2e/util/smokeTest.js

@@ -1,88 +0,0 @@
-import { faker } from '@faker-js/faker';
-import test from '@playwright/test';
-import { loadTool } from '../setup.js';
-export default async function runSmokeTestForTool(page, toolName) {
-    const tool = await loadTool(page, toolName);
-    await test.step('Fill in required fields', async () => {
-        const requiredProperties = tool.inputSchema.required ?? [];
-        console.log('requiredProperties', requiredProperties);
-        for (let property of Object.entries(tool.inputSchema.properties ?? {}).filter(([name]) => requiredProperties.includes(name))) {
-            const [name, config] = property;
-            const input = page.getByPlaceholder(config.description);
-            switch (config.type) {
-                case 'string':
-                    if (config.enum) {
-                        // If it's an enum, select a random value from the enum array
-                        await input.fill(faker.helpers.arrayElement(config.enum));
-                    }
-                    else if (name.toLowerCase().includes('id')) {
-                        // Generate a realistic-looking ID
-                        await input.fill(faker.string.alphanumeric(10));
-                    }
-                    else if (name.toLowerCase().includes('email')) {
-                        // Generate email if the field name suggests it's an email
-                        await input.fill(faker.internet.email());
-                    }
-                    else if (name.toLowerCase().includes('date') || name.toLowerCase().includes('time')) {
-                        // Generate date string if the field name suggests it's a date
-                        await input.fill(faker.date.recent().toISOString());
-                    }
-                    else if (name.toLowerCase().includes('color')) {
-                        // Generate color hex code
-                        await input.fill(faker.color.rgb({ format: 'hex' }));
-                    }
-                    else if (name.toLowerCase().includes('url') || name.toLowerCase().includes('link')) {
-                        // Generate URL
-                        await input.fill(faker.internet.url());
-                    }
-                    else {
-                        // For general string fields
-                        await input.fill(faker.lorem.sentence());
-                    }
-                    break;
-                case 'number':
-                    await input.fill(faker.number.int({ min: 1, max: 100 }).toString());
-                    break;
-                case 'boolean':
-                    // For boolean inputs, let's use random true/false
-                    await input.fill(faker.datatype.boolean().toString());
-                    break;
-                case 'array':
-                    // For array inputs, we'll generate a JSON string with a few items
-                    const arrayItems = [];
-                    // Look at array item type and generate appropriate fake data
-                    if (config.items?.type === 'string') {
-                        for (let i = 0; i < 3; i++) {
-                            arrayItems.push(faker.lorem.word());
-                        }
-                    }
-                    else if (config.items?.type === 'number') {
-                        for (let i = 0; i < 3; i++) {
-                            arrayItems.push(faker.number.int(100));
-                        }
-                    }
-                    await input.fill(JSON.stringify(arrayItems));
-                    break;
-                case 'object':
-                    // For object inputs, generate a simple object with some properties
-                    const fakeObject = {
-                        prop1: faker.lorem.word(),
-                        prop2: faker.number.int(100),
-                        prop3: faker.datatype.boolean(),
-                    };
-                    await input.fill(JSON.stringify(fakeObject));
-                    break;
-                default:
-                    // For unhandled types, generate a basic string
-                    await input.fill(faker.lorem.word());
-                    break;
-            }
-        }
-    });
-    await test.step('Execute the tool', async () => {
-        await page.getByRole('button', { name: 'Run Tool' }).click();
-        await page.getByRole('heading', { name: 'Tool Result: Success' }).isVisible();
-        await page.getByRole('heading', { name: 'Error output from MCP server' }).isHidden();
-        await page.waitForTimeout(100);
-    });
-}

package/build/types.js

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

package/build/utils/listTools.js

@@ -1,10 +0,0 @@
-// We'll collect all tool definitions here, keyed by name
-const toolDefinitions = {};
-// Function to register a tool definition
-export function registerTool(definition) {
-    toolDefinitions[definition.name] = definition;
-}
-// Function to get all registered tool definitions
-export function getToolDefinitions() {
-    return toolDefinitions;
-}