mcp-docs-service 0.1.0

package/dist/utils/index.js

@@ -0,0 +1,152 @@
+"use strict";
+/**
+ * Utility functions for the MCP Documentation Service
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateExcerpt = exports.calculateRelevance = exports.escapeRegex = exports.joinPaths = exports.getDirectoryName = exports.getFileName = exports.getFileExtension = exports.normalizePath = exports.isValidPath = void 0;
+/**
+ * Check if a path is valid
+ * @param path - Path to check
+ * @returns True if the path is valid, false otherwise
+ */
+function isValidPath(path) {
+    // Ensure path doesn't contain invalid characters or sequences
+    return !path.includes("..") && !path.includes("//") && !path.startsWith("/");
+}
+exports.isValidPath = isValidPath;
+/**
+ * Normalize a path
+ * @param path - Path to normalize
+ * @returns Normalized path
+ */
+function normalizePath(path) {
+    // Replace backslashes with forward slashes
+    path = path.replace(/\\/g, "/");
+    // Remove leading and trailing slashes
+    path = path.replace(/^\/+|\/+$/g, "");
+    // Replace multiple slashes with a single slash
+    path = path.replace(/\/+/g, "/");
+    return path;
+}
+exports.normalizePath = normalizePath;
+/**
+ * Get file extension
+ * @param path - Path to get extension from
+ * @returns File extension
+ */
+function getFileExtension(path) {
+    const match = path.match(/\.([^.]+)$/);
+    return match ? `.${match[1].toLowerCase()}` : "";
+}
+exports.getFileExtension = getFileExtension;
+/**
+ * Get file name
+ * @param path - Path to get name from
+ * @returns File name
+ */
+function getFileName(path) {
+    const match = path.match(/([^/]+)$/);
+    return match ? match[1] : "";
+}
+exports.getFileName = getFileName;
+/**
+ * Get directory name
+ * @param path - Path to get directory name from
+ * @returns Directory name
+ */
+function getDirectoryName(path) {
+    const match = path.match(/([^/]+)\/[^/]+$/);
+    return match ? match[1] : "";
+}
+exports.getDirectoryName = getDirectoryName;
+/**
+ * Join paths
+ * @param paths - Paths to join
+ * @returns Joined path
+ */
+function joinPaths(...paths) {
+    return normalizePath(paths.join("/"));
+}
+exports.joinPaths = joinPaths;
+/**
+ * Escape regex special characters
+ * @param str - String to escape
+ * @returns Escaped string
+ */
+function escapeRegex(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+exports.escapeRegex = escapeRegex;
+/**
+ * Calculate relevance score
+ * @param text - Text to search in
+ * @param query - Query to search for
+ * @returns Relevance score (0-1)
+ */
+function calculateRelevance(text, query) {
+    if (!query || !text)
+        return 0;
+    // Convert to lowercase for case-insensitive matching
+    const lowerText = text.toLowerCase();
+    const lowerQuery = query.toLowerCase();
+    // Check if the query is in the text
+    if (!lowerText.includes(lowerQuery))
+        return 0;
+    // Calculate relevance based on frequency and position
+    const frequency = (lowerText.match(new RegExp(escapeRegex(lowerQuery), "g")) || []).length;
+    const position = lowerText.indexOf(lowerQuery);
+    const textLength = text.length;
+    // Higher relevance for:
+    // - More occurrences of the query
+    // - Earlier position of the query
+    // - Shorter text (query is more significant in shorter text)
+    const frequencyFactor = Math.min(frequency / 5, 1); // Cap at 1
+    const positionFactor = 1 - position / textLength;
+    const lengthFactor = 1 - Math.min(textLength / 1000, 0.9); // Cap at 0.9
+    return frequencyFactor * 0.4 + positionFactor * 0.4 + lengthFactor * 0.2;
+}
+exports.calculateRelevance = calculateRelevance;
+/**
+ * Generate excerpt
+ * @param text - Text to generate excerpt from
+ * @param query - Query to highlight
+ * @param length - Excerpt length
+ * @returns Excerpt
+ */
+function generateExcerpt(text, query, length = 150) {
+    if (!text)
+        return "";
+    if (!query)
+        return text.substring(0, length);
+    // Find the position of the query
+    const lowerText = text.toLowerCase();
+    const lowerQuery = query.toLowerCase();
+    const position = lowerText.indexOf(lowerQuery);
+    if (position === -1) {
+        // Query not found, return the beginning of the text
+        return text.substring(0, length) + (text.length > length ? "..." : "");
+    }
+    // Calculate start and end positions for the excerpt
+    const halfLength = Math.floor(length / 2);
+    let start = Math.max(0, position - halfLength);
+    let end = Math.min(text.length, position + query.length + halfLength);
+    // Adjust if the excerpt is shorter than the desired length
+    if (end - start < length) {
+        if (start === 0) {
+            end = Math.min(text.length, length);
+        }
+        else if (end === text.length) {
+            start = Math.max(0, text.length - length);
+        }
+    }
+    // Generate the excerpt
+    let excerpt = text.substring(start, end);
+    // Add ellipsis if needed
+    if (start > 0)
+        excerpt = "..." + excerpt;
+    if (end < text.length)
+        excerpt = excerpt + "...";
+    return excerpt;
+}
+exports.generateExcerpt = generateExcerpt;
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH;;;;GAIG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,8DAA8D;IAC9D,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,IAAY;IACxC,2CAA2C;IAC3C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEhC,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEtC,+CAA+C;IAC/C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEjC,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,sCAWC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACnD,CAAC;AAHD,4CAGC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/B,CAAC;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC5C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/B,CAAC;AAHD,4CAGC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,GAAG,KAAe;IAC1C,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC;AAFD,kCAEC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,IAAY,EAAE,KAAa;IAC5D,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,CAAC,CAAC;IAE9B,qDAAqD;IACrD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAEvC,oCAAoC;IACpC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,CAAC,CAAC;IAE9C,sDAAsD;IACtD,MAAM,SAAS,GAAG,CAChB,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAChE,CAAC,MAAM,CAAC;IACT,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;IAE/B,wBAAwB;IACxB,kCAAkC;IAClC,kCAAkC;IAClC,6DAA6D;IAC7D,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW;IAC/D,MAAM,cAAc,GAAG,CAAC,GAAG,QAAQ,GAAG,UAAU,CAAC;IACjD,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa;IAExE,OAAO,eAAe,GAAG,GAAG,GAAG,cAAc,GAAG,GAAG,GAAG,YAAY,GAAG,GAAG,CAAC;AAC3E,CAAC;AA1BD,gDA0BC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,IAAY,EACZ,KAAa,EACb,SAAiB,GAAG;IAEpB,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE7C,iCAAiC;IACjC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE/C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE;QACnB,oDAAoD;QACpD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;KACxE;IAED,oDAAoD;IACpD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC1C,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC,CAAC;IAC/C,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;IAEtE,2DAA2D;IAC3D,IAAI,GAAG,GAAG,KAAK,GAAG,MAAM,EAAE;QACxB,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACrC;aAAM,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,EAAE;YAC9B,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;SAC3C;KACF;IAED,uBAAuB;IACvB,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEzC,yBAAyB;IACzB,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;IACzC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM;QAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;IAEjD,OAAO,OAAO,CAAC;AACjB,CAAC;AAxCD,0CAwCC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "mcp-docs-service",
+  "version": "0.1.0",
+  "description": "MCP Documentation Management Service - A Model Context Protocol implementation for documentation management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "mcp-docs-service": "dist/cli/bin.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"No tests yet\" && exit 0",
+    "start": "node dist/cli/bin.js"
+  },
+  "keywords": [
+    "mcp",
+    "documentation",
+    "cursor",
+    "claude",
+    "markdown",
+    "model-context-protocol"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "dependencies": {
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^18.0.0",
+    "typescript": "^4.9.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}