mcp-docs-service 0.5.1 → 0.5.2

package/README.md

@@ -257,7 +257,8 @@ npx mcp-docs-service --health-check /path/to/docs
 
 MCP Docs Service is designed to be resilient by default. The service automatically handles incomplete or poorly structured documentation without failing:
 
-- Returns a minimum health score of 70 even with issues
+- Returns a minimum health score of 80 even with issues
+- Automatically creates missing documentation directories
 - Handles missing documentation directories gracefully
 - Continues processing even when files have errors
 - Provides lenient scoring for metadata completeness and broken links
@@ -270,6 +271,21 @@ This makes the service particularly useful for:
 
 The service will always provide helpful feedback rather than failing, allowing you to incrementally improve your documentation over time.
 
+## Version History
+
+### v0.5.2
+
+- Enhanced resilience by automatically creating missing documentation directories
+- Improved tolerance mode with a minimum health score of 80
+- Made tolerance mode the default for health checks
+- Updated health check tool description to mention tolerance mode
+
+### v0.5.1
+
+- Added tolerance mode to health checks
+- Fixed issues with test suite reliability
+- Improved error handling in document operations
+
 ## Documentation
 
 For more detailed information, check out our documentation:

package/dist/handlers/health.js

@@ -24,8 +24,8 @@ export class HealthCheckHandler {
     async checkDocumentationHealth(basePath = "", options) {
         try {
             // Always use tolerance mode by default
-            const toleranceMode = true;
-            safeLog(`Checking documentation health with tolerance mode enabled by default`);
+            const toleranceMode = options?.toleranceMode !== false;
+            safeLog(`Checking documentation health with tolerance mode ${toleranceMode ? "enabled" : "disabled"}`);
             // Get the full path to the docs directory
             const docsPath = path.join(this.docsDir, basePath);
             // Check if the directory exists
@@ -231,7 +231,7 @@ ${results.issues
             // Deduct up to 30 points based on metadata completeness
             const metadataDeduction = Math.round((30 * (100 - metadataCompleteness)) / 100);
             score -= toleranceMode
-                ? Math.min(metadataDeduction, 15)
+                ? Math.min(metadataDeduction, 10)
                 : metadataDeduction;
         }
         // Deduct points for broken links
@@ -239,7 +239,7 @@ ${results.issues
             // Deduct 2 points per broken link, up to 20 points
             const brokenLinksDeduction = Math.min(results.brokenLinks * 2, 20);
             score -= toleranceMode
-                ? Math.min(brokenLinksDeduction, 10)
+                ? Math.min(brokenLinksDeduction, 5)
                 : brokenLinksDeduction;
         }
         // Deduct points for orphaned documents
@@ -258,9 +258,9 @@ ${results.issues
                 ? Math.min(missingRefsDeduction, 0)
                 : missingRefsDeduction;
         }
-        // In tolerance mode, ensure a minimum score of 70
-        if (toleranceMode && score < 70) {
-            score = 70;
+        // In tolerance mode, ensure a minimum score of 80
+        if (toleranceMode && score < 80) {
+            score = 80;
         }
         return Math.max(0, score);
     }

package/dist/index.js

@@ -50,12 +50,12 @@ async function ensureDocsDirectory() {
         }
     }
     catch (error) {
-        // Create directory if it doesn't exist and --create-dir is specified
-        if (createDir) {
-            try {
-                await fs.mkdir(docsDir, { recursive: true });
-                safeLog(`Created docs directory: ${docsDir}`);
-                // Create a sample README.md
+        // Create directory if it doesn't exist
+        try {
+            await fs.mkdir(docsDir, { recursive: true });
+            safeLog(`Created docs directory: ${docsDir}`);
+            // Create a sample README.md if --create-dir is specified
+            if (createDir) {
                 const readmePath = path.join(docsDir, "README.md");
                 try {
                     await fs.access(readmePath);
@@ -74,14 +74,10 @@ This is the documentation directory for your project.
                     safeLog(`Created sample README.md in ${docsDir}`);
                 }
             }
-            catch (error) {
-                safeLog(`Error creating docs directory: ${error}`);
-                process.exit(1);
-            }
+            return;
         }
-        else {
-            safeLog(`Error: Docs directory does not exist: ${docsDir}`);
-            safeLog(`Use --create-dir to create it automatically`);
+        catch (error) {
+            safeLog(`Error creating docs directory: ${error}`);
             process.exit(1);
         }
     }
@@ -144,7 +140,8 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
             {
                 name: "check_documentation_health",
                 description: "Check the health of the documentation by analyzing frontmatter, links, and navigation. " +
-                    "Returns a report with issues and a health score.",
+                    "Returns a report with issues and a health score. " +
+                    "Uses tolerance mode by default to provide a more forgiving health score for incomplete documentation.",
                 inputSchema: zodToJsonSchema(CheckDocumentationHealthSchema),
             },
             // New tools for Phase 2
@@ -241,7 +238,7 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                 if (!parsed.success) {
                     throw new Error(`Invalid arguments for check_documentation_health: ${parsed.error}`);
                 }
-                return await healthCheckHandler.checkDocumentationHealth(parsed.data.basePath);
+                return await healthCheckHandler.checkDocumentationHealth(parsed.data.basePath, { toleranceMode: parsed.data.toleranceMode });
             }
             // New tools for Phase 2
             case "create_documentation_folder": {

package/dist/schemas/tools.js

@@ -44,6 +44,7 @@ export const SearchDocumentsSchema = ToolInputSchema.extend({
 });
 export const CheckDocumentationHealthSchema = ToolInputSchema.extend({
     basePath: z.string().optional().default(""),
+    toleranceMode: z.boolean().optional().default(true),
 });
 // New schemas for Phase 2 features
 export const CreateFolderSchema = ToolInputSchema.extend({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-docs-service",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "MCP Documentation Service - A Model Context Protocol implementation for documentation management",
   "type": "module",
   "main": "dist/index.js",