mcp-docs-service 0.4.0 → 0.5.1

package/dist/schemas/tools.js

@@ -45,3 +45,36 @@ export const SearchDocumentsSchema = ToolInputSchema.extend({
 export const CheckDocumentationHealthSchema = ToolInputSchema.extend({
     basePath: z.string().optional().default(""),
 });
+// New schemas for Phase 2 features
+export const CreateFolderSchema = ToolInputSchema.extend({
+    path: z.string(),
+    createReadme: z.boolean().default(true),
+});
+export const MoveDocumentSchema = ToolInputSchema.extend({
+    sourcePath: z.string(),
+    destinationPath: z.string(),
+    updateReferences: z.boolean().default(true),
+});
+export const RenameDocumentSchema = ToolInputSchema.extend({
+    path: z.string(),
+    newName: z.string(),
+    updateReferences: z.boolean().default(true),
+});
+export const UpdateNavigationOrderSchema = ToolInputSchema.extend({
+    path: z.string(),
+    order: z.number(),
+});
+export const CreateSectionSchema = ToolInputSchema.extend({
+    title: z.string(),
+    path: z.string(),
+    order: z.number().optional(),
+});
+// New schemas for Phase 3 features
+export const ValidateLinksSchema = ToolInputSchema.extend({
+    basePath: z.string().optional().default(""),
+    recursive: z.boolean().default(true),
+});
+export const ValidateMetadataSchema = ToolInputSchema.extend({
+    basePath: z.string().optional().default(""),
+    requiredFields: z.array(z.string()).optional(),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-docs-service",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "MCP Documentation Service - A Model Context Protocol implementation for documentation management",
   "type": "module",
   "main": "dist/index.js",
@@ -19,6 +19,7 @@
     "lint": "eslint src --ext .ts",
     "test": "vitest run",
     "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "prepublishOnly": "npm run build",
     "prepare-publish": "node scripts/prepare-publish.js"
   },
@@ -44,6 +45,7 @@
     "@types/node": "^20.10.5",
     "@typescript-eslint/eslint-plugin": "^6.15.0",
     "@typescript-eslint/parser": "^6.15.0",
+    "@vitest/coverage-v8": "^3.0.8",
     "eslint": "^8.56.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",

package/dist/cli/bin.d.ts

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-/**
- * MCP Docs Service CLI
- *
- * This is the entry point for the CLI version of the MCP Docs Service.
- * It simply imports and runs the main service.
- */
-import "../index.js";

package/dist/cli/bin.js

@@ -1,133 +0,0 @@
-#!/usr/bin/env node
-/**
- * MCP Docs Service CLI
- *
- * This is the entry point for the CLI version of the MCP Docs Service.
- * It simply imports and runs the main service.
- */
-import path from "path";
-import fs from "fs";
-import { fileURLToPath } from "url";
-// Get the current directory
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-// Check if we're running under MCP Inspector
-const isMCPInspector = process.env.MCP_INSPECTOR === "true" ||
-    process.argv.some((arg) => arg.includes("modelcontextprotocol/inspector"));
-// Create a logging function that respects MCP Inspector mode
-const log = (...args) => {
-    if (!isMCPInspector) {
-        console.log(...args);
-    }
-};
-const errorLog = (...args) => {
-    console.error(...args);
-};
-// Parse command line arguments
-const args = process.argv.slice(2);
-log("CLI Arguments:", JSON.stringify(args));
-let docsDir = path.join(process.cwd(), "docs");
-let createDir = false;
-let healthCheck = false;
-let showHelp = false;
-// MCP Inspector specific handling
-// When run through MCP Inspector, it might pass arguments in a different format
-if (isMCPInspector) {
-    log("Detected MCP Inspector environment");
-    // Try to find a valid docs directory in all arguments
-    // This is a more aggressive approach but should work with various argument formats
-    for (const arg of process.argv) {
-        if (arg.endsWith("/docs") || arg.includes("/docs ")) {
-            const potentialPath = arg.split(" ")[0];
-            log("Found potential docs path in MCP Inspector args:", potentialPath);
-            if (fs.existsSync(potentialPath)) {
-                docsDir = path.resolve(potentialPath);
-                log("Using docs directory from MCP Inspector:", docsDir);
-                break;
-            }
-        }
-    }
-    // If we couldn't find a valid docs directory, use the default
-    log("Using docs directory:", docsDir);
-}
-else {
-    // Standard argument parsing
-    for (let i = 0; i < args.length; i++) {
-        log(`Processing arg[${i}]:`, args[i]);
-        if (args[i] === "--docs-dir" && i + 1 < args.length) {
-            docsDir = path.resolve(args[i + 1]);
-            log("Setting docs dir from --docs-dir flag:", docsDir);
-            i++; // Skip the next argument
-        }
-        else if (args[i] === "--create-dir") {
-            createDir = true;
-        }
-        else if (args[i] === "--health-check") {
-            healthCheck = true;
-        }
-        else if (args[i] === "--help" || args[i] === "-h") {
-            showHelp = true;
-        }
-        else if (!args[i].startsWith("--")) {
-            // Handle positional argument as docs directory
-            const potentialPath = path.resolve(args[i]);
-            log("Potential positional path:", potentialPath);
-            log("Path exists?", fs.existsSync(potentialPath));
-            if (fs.existsSync(potentialPath)) {
-                docsDir = potentialPath;
-                log("Setting docs dir from positional argument:", docsDir);
-            }
-            else {
-                log("Path doesn't exist, not using as docs dir:", potentialPath);
-            }
-        }
-    }
-}
-log("Final docs dir:", docsDir);
-// Show help if requested
-if (showHelp) {
-    console.log(`
-MCP Docs Service - Documentation Management Service
-
-Usage:
-  mcp-docs-service [options]
-  mcp-docs-service <docs-directory> [options]
-
-Options:
-  --docs-dir <path>   Specify the docs directory (default: ./docs)
-  --create-dir        Create the docs directory if it doesn't exist
-  --health-check      Run a health check on the documentation
-  --help, -h          Show this help message
-  `);
-    process.exit(0);
-}
-// Create docs directory if it doesn't exist and --create-dir is specified
-if (createDir) {
-    try {
-        if (!fs.existsSync(docsDir)) {
-            fs.mkdirSync(docsDir, { recursive: true });
-            log(`Created docs directory: ${docsDir}`);
-        }
-    }
-    catch (error) {
-        errorLog(`Error creating docs directory: ${error}`);
-        process.exit(1);
-    }
-}
-// Ensure the docs directory exists
-if (!fs.existsSync(docsDir)) {
-    errorLog(`Error: Docs directory does not exist: ${docsDir}`);
-    errorLog(`Use --create-dir to create it automatically`);
-    process.exit(1);
-}
-// Add the docs directory to process.argv so it's available to the main service
-process.argv.push(docsDir);
-// Add health check flag to process.argv if specified
-if (healthCheck) {
-    process.argv.push("--health-check");
-}
-// Import the main service
-import "../index.js";
-// The main service will handle the CLI arguments and execution
-// No additional code needed here as the main index.ts already has CLI functionality
-//# sourceMappingURL=bin.js.map

package/dist/cli/bin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":";AAEA;;;;;GAKG;AAEH,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,4BAA4B;AAC5B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,6CAA6C;AAC7C,MAAM,cAAc,GAClB,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,MAAM;IACpC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,gCAAgC,CAAC,CAAC,CAAC;AAE7E,6DAA6D;AAC7D,MAAM,GAAG,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;IAC7B,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;IAClC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,+BAA+B;AAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACnC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5C,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;AAC/C,IAAI,SAAS,GAAG,KAAK,CAAC;AACtB,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,IAAI,QAAQ,GAAG,KAAK,CAAC;AAErB,kCAAkC;AAClC,gFAAgF;AAChF,IAAI,cAAc,EAAE,CAAC;IACnB,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAE1C,sDAAsD;IACtD,mFAAmF;IACnF,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpD,MAAM,aAAa,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,GAAG,CAAC,kDAAkD,EAAE,aAAa,CAAC,CAAC;YACvE,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACjC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACtC,GAAG,CAAC,0CAA0C,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;KAAM,CAAC;IACN,4BAA4B;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACpD,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACpC,GAAG,CAAC,wCAAwC,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC,EAAE,CAAC,CAAC,yBAAyB;QAChC,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE,CAAC;YACtC,SAAS,GAAG,IAAI,CAAC;QACnB,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,gBAAgB,EAAE,CAAC;YACxC,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YACpD,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;aAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,+CAA+C;YAC/C,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,GAAG,CAAC,4BAA4B,EAAE,aAAa,CAAC,CAAC;YACjD,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YAElD,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACjC,OAAO,GAAG,aAAa,CAAC;gBACxB,GAAG,CAAC,4CAA4C,EAAE,OAAO,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,4CAA4C,EAAE,aAAa,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAEhC,yBAAyB;AACzB,IAAI,QAAQ,EAAE,CAAC;IACb,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;;GAYX,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,0EAA0E;AAC1E,IAAI,SAAS,EAAE,CAAC;IACd,IAAI,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,GAAG,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,mCAAmC;AACnC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,yCAAyC,OAAO,EAAE,CAAC,CAAC;IAC7D,QAAQ,CAAC,6CAA6C,CAAC,CAAC;IACxD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,+EAA+E;AAC/E,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAE3B,qDAAqD;AACrD,IAAI,WAAW,EAAE,CAAC;IAChB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC;AAED,0BAA0B;AAC1B,OAAO,aAAa,CAAC;AAErB,+DAA+D;AAC/D,oFAAoF"}

package/dist/handlers/docs.d.ts

@@ -1,26 +0,0 @@
-import { ToolResponse } from "../types/tools.js";
-/**
- * Reads a markdown document and extracts its content and metadata
- */
-export declare function readDocument(docPath: string, allowedDirectories: string[]): Promise<ToolResponse>;
-/**
- * Lists all markdown documents in a directory
- */
-export declare function listDocuments(basePath: string, allowedDirectories: string[]): Promise<ToolResponse>;
-/**
- * Gets the structure of the documentation directory
- */
-export declare function getStructure(basePath: string, allowedDirectories: string[]): Promise<ToolResponse>;
-/**
- * Gets the navigation structure for the documentation
- */
-export declare function getNavigation(basePath: string, allowedDirectories: string[]): Promise<ToolResponse>;
-/**
- * Checks the health of documentation
- */
-export declare function checkDocumentationHealth(basePath: string, options: {
-    checkLinks?: boolean;
-    checkMetadata?: boolean;
-    checkOrphans?: boolean;
-    requiredMetadataFields?: string[];
-}, allowedDirectories: string[]): Promise<ToolResponse>;