mcp-docs-service 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,214 @@
+# MCP Documentation Service
+
+The MCP Documentation Service is a custom implementation of the Model Context Protocol that allows AI assistants to interact with documentation. This service enables the creation, reading, updating, and deletion of documentation files, as well as searching and analyzing the documentation.
+
+## Features
+
+- **Document Management**: Create, read, update, and delete markdown documentation files
+- **Metadata Management**: Work with document frontmatter (YAML metadata)
+- **Search**: Search through documentation using keywords and filters
+- **Analytics**: Analyze documentation health and get suggestions for improvement
+- **Custom Directory Support**: Specify a custom docs directory and create it if it doesn't exist
+
+## Installation
+
+### Via npx (Recommended)
+
+The easiest way to use MCP Documentation Service is through npx:
+
+```bash
+# Use default docs directory (./docs)
+npx mcp-docs-service
+
+# Specify a custom docs directory
+npx mcp-docs-service --docs-dir ./my-custom-docs
+
+# Create the directory if it doesn't exist
+npx mcp-docs-service --docs-dir ./my-custom-docs --create-dir
+
+# Show help
+npx mcp-docs-service --help
+```
+
+### Global Installation
+
+You can also install it globally:
+
+```bash
+npm install -g mcp-docs-service
+
+# Then use it with the same options as npx
+mcp-docs-service --docs-dir ./my-custom-docs --create-dir
+```
+
+### Local Installation
+
+If you prefer to install it locally in your project:
+
+```bash
+npm install mcp-docs-service
+```
+
+### Command-Line Options
+
+The MCP Documentation Service supports the following command-line options:
+
+- `--docs-dir <path>`: Specify the docs directory (default: ./docs)
+- `--create-dir`: Create the docs directory if it doesn't exist
+- `--help`, `-h`: Show help message
+
+## Integration
+
+### With Cursor IDE
+
+Add this to your `.cursor/mcp.json` file:
+
+```json
+{
+  "mcpServers": {
+    "docs-manager": {
+      "command": "npx",
+      "args": ["-y", "mcp-docs-service"]
+    }
+  }
+}
+```
+
+To specify a custom docs directory:
+
+```json
+{
+  "mcpServers": {
+    "docs-manager": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "mcp-docs-service",
+        "--docs-dir",
+        "./my-custom-docs",
+        "--create-dir"
+      ]
+    }
+  }
+}
+```
+
+### With Claude Desktop
+
+Add this to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "docs-manager": {
+      "command": "npx",
+      "args": ["-y", "mcp-docs-service"]
+    }
+  }
+}
+```
+
+To specify a custom docs directory:
+
+```json
+{
+  "mcpServers": {
+    "docs-manager": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "mcp-docs-service",
+        "--docs-dir",
+        "./my-custom-docs",
+        "--create-dir"
+      ]
+    }
+  }
+}
+```
+
+## Programmatic Usage
+
+You can also use MCP Documentation Service programmatically in your Node.js application:
+
+```javascript
+const { MCPDocsServer } = require("mcp-docs-service");
+
+// Create a new MCP server instance with default docs directory
+const server = new MCPDocsServer("./docs");
+
+// Or with a custom docs directory
+const customServer = new MCPDocsServer("./my-custom-docs", {
+  createIfNotExists: true, // Create the directory if it doesn't exist
+  fileExtensions: [".md", ".mdx"], // Specify file extensions to consider (optional)
+});
+
+// Execute a query
+async function example() {
+  try {
+    const result = await server.executeQuery("list_files");
+    console.log(result);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+example();
+```
+
+You can also use the query function directly:
+
+```javascript
+const { query } = require("mcp-docs-service");
+
+// Execute a query with a custom docs directory
+async function example() {
+  try {
+    const result = await query("list_files", {
+      docsDir: "./my-custom-docs",
+      createIfNotExists: true,
+    });
+    console.log(result);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+example();
+```
+
+## Query Format
+
+The service uses a SQL-like query format to execute commands:
+
+```
+command_name(param1="value1", param2="value2")
+```
+
+For example:
+
+```
+get_document(path="architecture/overview.md")
+```
+
+## Available Commands
+
+### Document Operations
+
+- **list_files(directory="")**: List all markdown files (optionally in a specific directory)
+- **list_directories(directory="")**: List all directories (optionally in a specific directory)
+- **get_document(path="path/to/doc.md")**: Get a document's content and metadata
+- **create_document(path="path/to/doc.md", content="content", metadata={...})**: Create a new document
+- **update_document(path="path/to/doc.md", content="updated content", metadata={...})**: Update an existing document
+- **delete_document(path="path/to/doc.md")**: Delete a document
+
+### Search & Analysis
+
+- **search_documents(query="search term", directory="", tags=["tag1"], status="published")**: Search documents
+- **analyze_docs(directory="")**: Analyze documentation health
+- **get_health_score()**: Get overall documentation health score
+- **get_suggestions()**: Get suggestions for improving documentation
+
+## License
+
+MIT

package/dist/cli/bin.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * MCP Documentation Management Service CLI
+ * This is the entry point for the CLI when run via npx
+ */
+export {};

package/dist/cli/bin.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * MCP Documentation Management Service CLI
+ * This is the entry point for the CLI when run via npx
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("./index.js");
+// Parse command line arguments
+const args = process.argv.slice(2);
+const options = {
+    docsDir: "./docs",
+    createIfNotExists: false,
+    help: false,
+};
+// Process arguments
+for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === "--docs-dir" && i + 1 < args.length) {
+        options.docsDir = args[++i];
+    }
+    else if (arg === "--create-dir") {
+        options.createIfNotExists = true;
+    }
+    else if (arg === "--help" || arg === "-h") {
+        options.help = true;
+    }
+}
+// Show help if requested
+if (options.help) {
+    console.log(`
+MCP Documentation Service
+
+Usage:
+  npx mcp-docs-service [options]
+
+Options:
+  --docs-dir <path>  Specify the docs directory (default: ./docs)
+  --create-dir       Create the docs directory if it doesn't exist
+  --help, -h         Show this help message
+  `);
+    process.exit(0);
+}
+// Start the main process
+(0, index_js_1.main)(options).catch((error) => {
+    console.error("Fatal error:", error);
+    process.exit(1);
+});
+//# sourceMappingURL=bin.js.map

package/dist/cli/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":";;AAEA;;;GAGG;;AAEH,yCAAkC;AAElC,+BAA+B;AAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACnC,MAAM,OAAO,GAAG;IACd,OAAO,EAAE,QAAQ;IACjB,iBAAiB,EAAE,KAAK;IACxB,IAAI,EAAE,KAAK;CACZ,CAAC;AAEF,oBAAoB;AACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;IACpC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAEpB,IAAI,GAAG,KAAK,YAAY,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;SAAM,IAAI,GAAG,KAAK,cAAc,EAAE;QACjC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;KAClC;SAAM,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;KACrB;CACF;AAED,yBAAyB;AACzB,IAAI,OAAO,CAAC,IAAI,EAAE;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;GAUX,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;AAED,yBAAyB;AACzB,IAAA,eAAI,EAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IAC5B,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * CLI interface for the MCP Documentation Management Service
+ *
+ * This script is meant to be run from the command line to start the MCP server.
+ * It reads queries from stdin, processes them, and writes results to stdout.
+ *
+ * Usage:
+ *   npx mcp-docs-service [options]
+ */
+/**
+ * Main function to process stdin commands
+ */
+export declare function main(options?: {
+    docsDir: string;
+    createIfNotExists: boolean;
+}): Promise<void>;

package/dist/cli/index.js

@@ -0,0 +1,96 @@
+"use strict";
+/**
+ * CLI interface for the MCP Documentation Management Service
+ *
+ * This script is meant to be run from the command line to start the MCP server.
+ * It reads queries from stdin, processes them, and writes results to stdout.
+ *
+ * Usage:
+ *   npx mcp-docs-service [options]
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const index_js_1 = require("../index.js");
+const readline = __importStar(require("readline"));
+/**
+ * Main function to process stdin commands
+ */
+async function main(options = {
+    docsDir: "./docs",
+    createIfNotExists: false,
+}) {
+    console.error("MCP Documentation Management Service started.");
+    console.error(`Using docs directory: ${options.docsDir}`);
+    if (options.createIfNotExists) {
+        console.error("Will create directory if it doesn't exist");
+    }
+    console.error("Reading from stdin, writing results to stdout...");
+    // Create a custom query function that uses the specified docs directory
+    const query = (sql) => (0, index_js_1.query)(sql, {
+        docsDir: options.docsDir,
+        createIfNotExists: options.createIfNotExists,
+    });
+    // Create readline interface
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+        terminal: false,
+    });
+    // Handle process termination
+    process.on("SIGINT", () => {
+        console.error("\nMCP Documentation Management Service terminated.");
+        process.exit(0);
+    });
+    // Process lines from stdin
+    rl.on("line", async (line) => {
+        if (line.trim()) {
+            try {
+                // Process the command and write the result to stdout
+                const result = await query(line.trim());
+                console.log(JSON.stringify(result));
+            }
+            catch (error) {
+                // Log errors to stderr and write error result to stdout
+                console.error(`Error processing command: ${error instanceof Error ? error.message : String(error)}`);
+                console.log(JSON.stringify({
+                    success: false,
+                    error: error instanceof Error ? error.message : String(error),
+                }));
+            }
+        }
+    });
+    // Handle end of input
+    rl.on("close", () => {
+        console.error("Input stream closed. Waiting for output to flush...");
+        // Add a delay before exiting to ensure all output is flushed
+        setTimeout(() => {
+            console.error("Exiting...");
+            process.exit(0);
+        }, 1000);
+    });
+}
+exports.main = main;
+//# sourceMappingURL=index.js.map

package/dist/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,0CAAqD;AACrD,mDAAqC;AAErC;;GAEG;AACI,KAAK,UAAU,IAAI,CACxB,UAGI;IACF,OAAO,EAAE,QAAQ;IACjB,iBAAiB,EAAE,KAAK;CACzB;IAED,OAAO,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC/D,OAAO,CAAC,KAAK,CAAC,yBAAyB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1D,IAAI,OAAO,CAAC,iBAAiB,EAAE;QAC7B,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAC5D;IACD,OAAO,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAElE,wEAAwE;IACxE,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE,CAC5B,IAAA,gBAAa,EAAC,GAAG,EAAE;QACjB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;KAC7C,CAAC,CAAC;IAEL,4BAA4B;IAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;QAClC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IAEH,6BAA6B;IAC7B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;QACxB,OAAO,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,2BAA2B;IAC3B,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;YACf,IAAI;gBACF,qDAAqD;gBACrD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;aACrC;YAAC,OAAO,KAAc,EAAE;gBACvB,wDAAwD;gBACxD,OAAO,CAAC,KAAK,CACX,6BACE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,CACH,CAAC;gBACF,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,SAAS,CAAC;oBACb,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;iBAC9D,CAAC,CACH,CAAC;aACH;SACF;IACH,CAAC,CAAC,CAAC;IAEH,sBAAsB;IACtB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAClB,OAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACrE,6DAA6D;QAC7D,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,EAAE,IAAI,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AArED,oBAqEC"}

package/dist/core/docAnalyzer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Document Analyzer for generating insights about documentation
+ */
+import { DocAnalysisResult } from "../types/index.js";
+import { DocManager } from "./docManager.js";
+export declare class DocAnalyzer {
+    private docManager;
+    constructor(docManager: DocManager);
+    /**
+     * Analyze the documentation and generate insights
+     */
+    analyzeDocumentation(directory?: string): Promise<DocAnalysisResult>;
+    /**
+     * Find documentation gaps (directories with few or no documents)
+     */
+    findDocumentationGaps(): Promise<Record<string, number>>;
+    /**
+     * Calculate overall documentation health score (0-100)
+     */
+    calculateHealthScore(): Promise<number>;
+    /**
+     * Generate suggestions for improving documentation
+     */
+    generateSuggestions(): Promise<string[]>;
+}

package/dist/core/docAnalyzer.js

@@ -0,0 +1,118 @@
+"use strict";
+/**
+ * Document Analyzer for generating insights about documentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocAnalyzer = void 0;
+class DocAnalyzer {
+    constructor(docManager) {
+        this.docManager = docManager;
+    }
+    /**
+     * Analyze the documentation and generate insights
+     */
+    async analyzeDocumentation(directory) {
+        const summaries = await this.docManager.getAllDocumentSummaries(directory);
+        // Count documents by status
+        const byStatus = {};
+        summaries.forEach((doc) => {
+            const status = doc.status || "undefined";
+            byStatus[status] = (byStatus[status] || 0) + 1;
+        });
+        // Count documents by directory
+        const byDirectory = {};
+        summaries.forEach((doc) => {
+            const dirPath = doc.path.split("/").slice(0, -1).join("/");
+            byDirectory[dirPath] = (byDirectory[dirPath] || 0) + 1;
+        });
+        // Find documents missing descriptions
+        const missingDescriptions = summaries.filter((doc) => !doc.description);
+        // Find recently updated documents (if lastUpdated is available)
+        let recentlyUpdated = [];
+        const docsWithDates = summaries.filter((doc) => doc.lastUpdated);
+        if (docsWithDates.length > 0) {
+            recentlyUpdated = docsWithDates
+                .sort((a, b) => {
+                const dateA = a.lastUpdated ? new Date(a.lastUpdated).getTime() : 0;
+                const dateB = b.lastUpdated ? new Date(b.lastUpdated).getTime() : 0;
+                return dateB - dateA;
+            })
+                .slice(0, 5); // Get the 5 most recently updated
+        }
+        return {
+            documentCount: summaries.length,
+            byStatus,
+            byDirectory,
+            recentlyUpdated,
+            missingDescriptions,
+        };
+    }
+    /**
+     * Find documentation gaps (directories with few or no documents)
+     */
+    async findDocumentationGaps() {
+        const directories = await this.docManager.listDirectories();
+        const gaps = {};
+        for (const dir of directories) {
+            const files = await this.docManager.listMarkdownFiles(dir);
+            if (files.length < 2) {
+                // Consider a directory with less than 2 docs as a gap
+                gaps[dir] = files.length;
+            }
+        }
+        return gaps;
+    }
+    /**
+     * Calculate overall documentation health score (0-100)
+     */
+    async calculateHealthScore() {
+        const summaries = await this.docManager.getAllDocumentSummaries();
+        if (summaries.length === 0) {
+            return 0; // No documents
+        }
+        // Calculate metrics
+        const withDescription = summaries.filter((doc) => doc.description).length;
+        const withTags = summaries.filter((doc) => doc.tags && doc.tags.length > 0).length;
+        const withStatus = summaries.filter((doc) => doc.status).length;
+        // Calculate score components (each worth up to 33.3 points)
+        const descriptionScore = (withDescription / summaries.length) * 33.3;
+        const tagsScore = (withTags / summaries.length) * 33.3;
+        const statusScore = (withStatus / summaries.length) * 33.3;
+        // Calculate the overall score
+        const healthScore = descriptionScore + tagsScore + statusScore;
+        return Math.round(healthScore);
+    }
+    /**
+     * Generate suggestions for improving documentation
+     */
+    async generateSuggestions() {
+        const analysis = await this.analyzeDocumentation();
+        const gaps = await this.findDocumentationGaps();
+        const healthScore = await this.calculateHealthScore();
+        const suggestions = [];
+        // Suggest adding descriptions to documents that lack them
+        if (analysis.missingDescriptions &&
+            analysis.missingDescriptions.length > 0) {
+            suggestions.push(`Add descriptions to ${analysis.missingDescriptions.length} documents that are missing them.`);
+        }
+        // Suggest creating documents in empty or sparse directories
+        if (Object.keys(gaps).length > 0) {
+            for (const [dir, count] of Object.entries(gaps)) {
+                suggestions.push(`Add more documentation to the ${dir} directory (currently has ${count} documents).`);
+            }
+        }
+        // General suggestions based on health score
+        if (healthScore < 50) {
+            suggestions.push("Improve overall documentation quality by adding proper metadata to existing documents.");
+        }
+        // Suggestion for adding status to documents
+        if (analysis.byStatus &&
+            analysis.byStatus["undefined"] &&
+            analysis.byStatus["undefined"] > 0) {
+            suggestions.push(`Add status (draft, review, or published) to ${analysis.byStatus["undefined"]} documents.`);
+        }
+        return suggestions;
+    }
+}
+exports.DocAnalyzer = DocAnalyzer;
+//# sourceMappingURL=docAnalyzer.js.map

package/dist/core/docAnalyzer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docAnalyzer.js","sourceRoot":"","sources":["../../src/core/docAnalyzer.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAKH,MAAa,WAAW;IAGtB,YAAY,UAAsB;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CAAC,SAAkB;QAC3C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAE3E,4BAA4B;QAC5B,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACxB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,WAAW,CAAC;YACzC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,+BAA+B;QAC/B,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACxB,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3D,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,sCAAsC;QACtC,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAExE,gEAAgE;QAChE,IAAI,eAAe,GAAiB,EAAE,CAAC;QACvC,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAEjE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,eAAe,GAAG,aAAa;iBAC5B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACb,MAAM,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,MAAM,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,OAAO,KAAK,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kCAAkC;SACnD;QAED,OAAO;YACL,aAAa,EAAE,SAAS,CAAC,MAAM;YAC/B,QAAQ;YACR,WAAW;YACX,eAAe;YACf,mBAAmB;SACpB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;QAC5D,MAAM,IAAI,GAA2B,EAAE,CAAC;QAExC,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YAC3D,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpB,sDAAsD;gBACtD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;aAC1B;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB;QACxB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC;QAElE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1B,OAAO,CAAC,CAAC,CAAC,eAAe;SAC1B;QAED,oBAAoB;QACpB,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;QAC1E,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CACzC,CAAC,MAAM,CAAC;QACT,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAEhE,4DAA4D;QAC5D,MAAM,gBAAgB,GAAG,CAAC,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QACrE,MAAM,SAAS,GAAG,CAAC,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QACvD,MAAM,WAAW,GAAG,CAAC,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE3D,8BAA8B;QAC9B,MAAM,WAAW,GAAG,gBAAgB,GAAG,SAAS,GAAG,WAAW,CAAC;QAE/D,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAChD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAEtD,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,0DAA0D;QAC1D,IACE,QAAQ,CAAC,mBAAmB;YAC5B,QAAQ,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EACvC;YACA,WAAW,CAAC,IAAI,CACd,uBAAuB,QAAQ,CAAC,mBAAmB,CAAC,MAAM,mCAAmC,CAC9F,CAAC;SACH;QAED,4DAA4D;QAC5D,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC/C,WAAW,CAAC,IAAI,CACd,iCAAiC,GAAG,6BAA6B,KAAK,cAAc,CACrF,CAAC;aACH;SACF;QAED,4CAA4C;QAC5C,IAAI,WAAW,GAAG,EAAE,EAAE;YACpB,WAAW,CAAC,IAAI,CACd,wFAAwF,CACzF,CAAC;SACH;QAED,4CAA4C;QAC5C,IACE,QAAQ,CAAC,QAAQ;YACjB,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC9B,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,EAClC;YACA,WAAW,CAAC,IAAI,CACd,+CAA+C,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAC3F,CAAC;SACH;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AApJD,kCAoJC"}

package/dist/core/docManager.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Document Manager for handling file operations
+ */
+import { DocContent, DocCreateParams, DocSummary, DocUpdateParams, SearchOptions } from "../types/index.js";
+export declare class DocManager {
+    private baseDir;
+    private options;
+    constructor(baseDir?: string, options?: {
+        createIfNotExists?: boolean;
+        fileExtensions?: string[];
+    });
+    /**
+     * Initialize the docs directory
+     */
+    private initializeDirectory;
+    /**
+     * List all markdown files in a directory recursively
+     */
+    listMarkdownFiles(dir?: string): Promise<string[]>;
+    /**
+     * Get document content and metadata
+     */
+    getDocument(filePath: string): Promise<DocContent | null>;
+    /**
+     * List directories in the docs folder
+     */
+    listDirectories(dir?: string): Promise<string[]>;
+    /**
+     * Create a new document
+     */
+    createDocument(params: DocCreateParams): Promise<boolean>;
+    /**
+     * Update an existing document
+     */
+    updateDocument(params: DocUpdateParams): Promise<boolean>;
+    /**
+     * Delete a document
+     */
+    deleteDocument(filePath: string): Promise<boolean>;
+    /**
+     * Basic search for documents matching query
+     */
+    searchDocuments(options: SearchOptions): Promise<DocSummary[]>;
+    /**
+     * Get all documents as summaries
+     */
+    getAllDocumentSummaries(directory?: string): Promise<DocSummary[]>;
+}