mcp-docs-service 0.1.1 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to the MCP Docs Service will be documented in this file.
+
+## [0.2.1] - 2023-03-12
+
+### Added
+
+- Additional documentation improvements
+- Enhanced knowledge base generation capabilities
+
+## [0.2.0] - 2023-03-12
+
+### Added
+
+- New `get_docs_knowledge_base` tool for creating comprehensive knowledge bases for LLM context
+- Knowledge base generation example in `docs/examples/knowledge-base-generator.md`
+- Support for document summaries in knowledge base
+- Organization of documents by categories and tags in knowledge base
+- Updated documentation to reflect new features
+
+### Changed
+
+- Improved documentation structure and organization
+- Updated roadmap to include knowledge base features
+- Enhanced basic usage tutorial with knowledge base examples
+- Removed unnecessary file operation tools in favor of document-specific tools
+
+### Fixed
+
+- TypeScript type errors in knowledge base implementation
+- Various documentation improvements and corrections
+
+## [0.1.1] - 2023-03-11
+
+### Added
+
+- Initial release of MCP Docs Service
+- Basic documentation management functionality
+- Support for reading, writing, editing, and deleting markdown files with frontmatter
+- Search functionality for documentation
+- Navigation generation
+- Documentation structure analysis

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Your Name
+Copyright (c) 2023 Aleks Petrov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,9 +7,26 @@ The MCP Documentation Service is a custom implementation of the Model Context Pr
 - **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
+- **Knowledge Base Generation**: Create comprehensive knowledge bases for LLM context
+- **Structure Analysis**: Analyze documentation structure and relationships
+- **Navigation Generation**: Generate navigation structures for documentation
+- **Tag Management**: Organize documentation by tags and categories
 - **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
 
+## Documentation
+
+Comprehensive documentation is available in the `docs` directory:
+
+- [Getting Started Guide](docs/guides/getting-started.md) - Introduction to the MCP Docs Manager
+- [API Overview](docs/api/overview.md) - Overview of the API and available tools
+- [Tools Reference](docs/api/tools-reference.md) - Complete reference of all available tools
+- [Basic Usage Tutorial](docs/tutorials/basic-usage.md) - Tutorial for basic usage
+- [Examples](docs/examples/) - Code examples for common tasks
+  - [Navigation Generator](docs/examples/navigation-generator.md) - Example of how to generate navigation for documentation
+  - [Knowledge Base Generator](docs/examples/knowledge-base-generator.md) - Example of how to generate a knowledge base for LLM context
+- [Roadmap](docs/roadmap.md) - Development roadmap and planned features
+
 ## Installation
 
 ### Via npx (Recommended)
@@ -193,21 +210,17 @@ 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
+### Documentation Tools
+
+- **read_document(path="path/to/doc.md")**: Read a markdown document and extract its content and metadata
+- **list_documents(basePath="")**: List all markdown documents in a directory
+- **get_structure(basePath="")**: Get the structure of the documentation directory
+- **get_navigation(basePath="")**: Get the navigation structure for the documentation
+- **get_docs_knowledge_base(basePath="", includeSummaries=true, maxSummaryLength=500)**: Create a comprehensive knowledge base of documentation for LLM context
+- **write_document(path="path/to/doc.md", content="content", metadata={...})**: Write content to a markdown document with frontmatter
+- **edit_document(path="path/to/doc.md", edits=[{oldText: "...", newText: "..."}])**: Apply edits to a markdown document while preserving frontmatter
+- **delete_document(path="path/to/doc.md")**: Delete a markdown document
+- **search_documents(basePath="", query="search term", tags=["tag1"], status="published")**: Search for markdown documents matching criteria
 
 ## License
 

package/dist/handlers/docs.d.ts

@@ -0,0 +1,17 @@
+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>;

package/dist/handlers/docs.js

@@ -0,0 +1,280 @@
+import fs from "fs/promises";
+import path from "path";
+import { validatePath } from "../utils/path.js";
+import matter from "gray-matter";
+/**
+ * Reads a markdown document and extracts its content and metadata
+ */
+export async function readDocument(docPath, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(docPath, allowedDirectories);
+        // Read the file
+        const content = await fs.readFile(normalizedPath, "utf-8");
+        // Parse frontmatter
+        const { data: metadata, content: markdownContent } = matter(content);
+        return {
+            content: [{ type: "text", text: "Document read successfully" }],
+            metadata: {
+                path: docPath,
+                content: markdownContent,
+                metadata,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error reading document: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Lists all markdown documents in a directory
+ */
+export async function listDocuments(basePath, allowedDirectories) {
+    try {
+        const normalizedBasePath = basePath
+            ? await validatePath(basePath, allowedDirectories)
+            : allowedDirectories[0];
+        const documents = [];
+        async function processDirectory(dirPath) {
+            const entries = await fs.readdir(dirPath, { withFileTypes: true });
+            for (const entry of entries) {
+                const entryPath = path.join(dirPath, entry.name);
+                if (entry.isDirectory()) {
+                    await processDirectory(entryPath);
+                }
+                else if (entry.name.endsWith(".md")) {
+                    try {
+                        const content = await fs.readFile(entryPath, "utf-8");
+                        const { data: metadata } = matter(content);
+                        documents.push({
+                            path: entryPath,
+                            name: entry.name,
+                            metadata: metadata,
+                        });
+                    }
+                    catch (error) {
+                        console.error(`Error processing ${entryPath}: ${error.message}`);
+                    }
+                }
+            }
+        }
+        await processDirectory(normalizedBasePath);
+        return {
+            content: [{ type: "text", text: `Found ${documents.length} documents` }],
+            metadata: {
+                documents,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error listing documents: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Gets the structure of the documentation directory
+ */
+export async function getStructure(basePath, allowedDirectories) {
+    try {
+        const normalizedBasePath = basePath
+            ? await validatePath(basePath, allowedDirectories)
+            : allowedDirectories[0];
+        async function buildStructure(dirPath, relativePath = "") {
+            try {
+                const entries = await fs.readdir(dirPath, { withFileTypes: true });
+                const children = [];
+                let metadata;
+                // Check if there's an index.md file to get directory metadata
+                const indexPath = path.join(dirPath, "index.md");
+                try {
+                    const indexStat = await fs.stat(indexPath);
+                    if (indexStat.isFile()) {
+                        const content = await fs.readFile(indexPath, "utf-8");
+                        const { data } = matter(content);
+                        metadata = data;
+                    }
+                }
+                catch (error) {
+                    // No index.md file, that's fine
+                }
+                // Process all entries
+                for (const entry of entries) {
+                    const entryPath = path.join(dirPath, entry.name);
+                    const entryRelativePath = path.join(relativePath, entry.name);
+                    if (entry.isDirectory()) {
+                        const subDir = await buildStructure(entryPath, entryRelativePath);
+                        children.push(subDir);
+                    }
+                    else if (entry.name.endsWith(".md") && entry.name !== "index.md") {
+                        try {
+                            const content = await fs.readFile(entryPath, "utf-8");
+                            const { data } = matter(content);
+                            children.push({
+                                name: entry.name,
+                                path: entryRelativePath,
+                                type: "file",
+                                metadata: data,
+                                children: [],
+                            });
+                        }
+                        catch (error) {
+                            children.push({
+                                name: entry.name,
+                                path: entryRelativePath,
+                                type: "file",
+                                error: error.message,
+                                children: [],
+                            });
+                        }
+                    }
+                }
+                // Sort children by order metadata if available, then by name
+                children.sort((a, b) => {
+                    const orderA = a.metadata?.order ?? Infinity;
+                    const orderB = b.metadata?.order ?? Infinity;
+                    if (orderA !== orderB) {
+                        return orderA - orderB;
+                    }
+                    return a.name.localeCompare(b.name);
+                });
+                return {
+                    name: path.basename(dirPath),
+                    path: relativePath,
+                    type: "directory",
+                    metadata,
+                    children,
+                };
+            }
+            catch (error) {
+                return {
+                    name: path.basename(dirPath),
+                    path: relativePath,
+                    type: "directory",
+                    error: error.message,
+                    children: [],
+                };
+            }
+        }
+        const structure = await buildStructure(normalizedBasePath);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: "Documentation structure retrieved successfully",
+                },
+            ],
+            metadata: {
+                structure,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error getting structure: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Gets the navigation structure for the documentation
+ */
+export async function getNavigation(basePath, allowedDirectories) {
+    try {
+        // First get the structure
+        const structureResponse = await getStructure(basePath, allowedDirectories);
+        if (structureResponse.isError) {
+            return structureResponse;
+        }
+        const structure = structureResponse.metadata?.structure;
+        // Build navigation from structure
+        function buildNavigation(structure) {
+            const sections = [];
+            function processNode(node, parentPath = []) {
+                // Skip nodes with errors
+                if (node.error) {
+                    return;
+                }
+                if (node.type === "directory") {
+                    // Create a section for this directory
+                    const section = {
+                        title: node.metadata?.title || node.name,
+                        path: node.path ? `/${node.path}` : null,
+                        items: [],
+                        order: node.metadata?.order ?? Infinity,
+                    };
+                    // Process children
+                    for (const child of node.children) {
+                        if (child.type === "file") {
+                            // Add file as an item
+                            section.items.push({
+                                title: child.metadata?.title || child.name.replace(/\.md$/, ""),
+                                path: `/${child.path}`,
+                                order: child.metadata?.order ?? Infinity,
+                            });
+                        }
+                        else if (child.type === "directory") {
+                            // Process subdirectory
+                            const childSections = processNode(child, [
+                                ...parentPath,
+                                node.name,
+                            ]);
+                            if (childSections) {
+                                sections.push(...childSections);
+                            }
+                        }
+                    }
+                    // Sort items by order
+                    section.items.sort((a, b) => {
+                        if (a.order !== b.order) {
+                            return a.order - b.order;
+                        }
+                        return a.title.localeCompare(b.title);
+                    });
+                    // Only add section if it has items
+                    if (section.items.length > 0) {
+                        sections.push(section);
+                    }
+                    return sections;
+                }
+                return null;
+            }
+            processNode(structure);
+            // Sort sections by order
+            sections.sort((a, b) => {
+                if (a.order !== b.order) {
+                    return a.order - b.order;
+                }
+                return a.title.localeCompare(b.title);
+            });
+            return sections;
+        }
+        const navigation = buildNavigation(structure);
+        return {
+            content: [
+                { type: "text", text: "Navigation structure retrieved successfully" },
+            ],
+            metadata: {
+                navigation,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error getting navigation: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+//# sourceMappingURL=docs.js.map

package/dist/handlers/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","sourceRoot":"","sources":["../../src/handlers/docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAShD,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAAe,EACf,kBAA4B;IAE5B,IAAI,CAAC;QACH,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QAEvE,gBAAgB;QAChB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAE3D,oBAAoB;QACpB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAErE,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC;YAC/D,QAAQ,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,eAAe;gBACxB,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,KAAK,CAAC,OAAO,EAAE,EAAE;aACnE;YACD,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAAgB,EAChB,kBAA4B;IAE5B,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,QAAQ;YACjC,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,kBAAkB,CAAC;YAClD,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE1B,MAAM,SAAS,GAAoB,EAAE,CAAC;QAEtC,KAAK,UAAU,gBAAgB,CAAC,OAAe;YAC7C,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAEnE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAEjD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;oBACxB,MAAM,gBAAgB,CAAC,SAAS,CAAC,CAAC;gBACpC,CAAC;qBAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACtC,IAAI,CAAC;wBACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;wBACtD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;wBAE3C,SAAS,CAAC,IAAI,CAAC;4BACb,IAAI,EAAE,SAAS;4BACf,IAAI,EAAE,KAAK,CAAC,IAAI;4BAChB,QAAQ,EAAE,QAA4B;yBACvC,CAAC,CAAC;oBACL,CAAC;oBAAC,OAAO,KAAU,EAAE,CAAC;wBACpB,OAAO,CAAC,KAAK,CAAC,oBAAoB,SAAS,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oBACnE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAE3C,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,SAAS,CAAC,MAAM,YAAY,EAAE,CAAC;YACxE,QAAQ,EAAE;gBACR,SAAS;aACV;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,KAAK,CAAC,OAAO,EAAE,EAAE;aACpE;YACD,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,kBAA4B;IAE5B,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,QAAQ;YACjC,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,kBAAkB,CAAC;YAClD,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAE1B,KAAK,UAAU,cAAc,CAC3B,OAAe,EACf,YAAY,GAAG,EAAE;YAEjB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnE,MAAM,QAAQ,GAAgB,EAAE,CAAC;gBAEjC,IAAI,QAAsC,CAAC;gBAE3C,8DAA8D;gBAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBACjD,IAAI,CAAC;oBACH,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC3C,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;wBACvB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;wBACtD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;wBACjC,QAAQ,GAAG,IAAwB,CAAC;oBACtC,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,gCAAgC;gBAClC,CAAC;gBAED,sBAAsB;gBACtB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;oBAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACjD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBAE9D,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;wBACxB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;wBAClE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACxB,CAAC;yBAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;wBACnE,IAAI,CAAC;4BACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;4BACtD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;4BAEjC,QAAQ,CAAC,IAAI,CAAC;gCACZ,IAAI,EAAE,KAAK,CAAC,IAAI;gCAChB,IAAI,EAAE,iBAAiB;gCACvB,IAAI,EAAE,MAAM;gCACZ,QAAQ,EAAE,IAAwB;gCAClC,QAAQ,EAAE,EAAE;6BACb,CAAC,CAAC;wBACL,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,QAAQ,CAAC,IAAI,CAAC;gCACZ,IAAI,EAAE,KAAK,CAAC,IAAI;gCAChB,IAAI,EAAE,iBAAiB;gCACvB,IAAI,EAAE,MAAM;gCACZ,KAAK,EAAE,KAAK,CAAC,OAAO;gCACpB,QAAQ,EAAE,EAAE;6BACb,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,6DAA6D;gBAC7D,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBACrB,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,IAAI,QAAQ,CAAC;oBAC7C,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,IAAI,QAAQ,CAAC;oBAE7C,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;wBACtB,OAAO,MAAM,GAAG,MAAM,CAAC;oBACzB,CAAC;oBAED,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC,CAAC,CAAC;gBAEH,OAAO;oBACL,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;oBAC5B,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,WAAW;oBACjB,QAAQ;oBACR,QAAQ;iBACT,CAAC;YACJ,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO;oBACL,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;oBAC5B,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,WAAW;oBACjB,KAAK,EAAE,KAAK,CAAC,OAAO;oBACpB,QAAQ,EAAE,EAAE;iBACb,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAE3D,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,gDAAgD;iBACvD;aACF;YACD,QAAQ,EAAE;gBACR,SAAS;aACV;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,KAAK,CAAC,OAAO,EAAE,EAAE;aACpE;YACD,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAAgB,EAChB,kBAA4B;IAE5B,IAAI,CAAC;QACH,0BAA0B;QAC1B,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAE3E,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC9B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,EAAE,SAAsB,CAAC;QAErE,kCAAkC;QAClC,SAAS,eAAe,CAAC,SAAoB;YAC3C,MAAM,QAAQ,GAAwB,EAAE,CAAC;YAEzC,SAAS,WAAW,CAAC,IAAe,EAAE,aAAuB,EAAE;gBAC7D,yBAAyB;gBACzB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACf,OAAO;gBACT,CAAC;gBAED,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;oBAC9B,sCAAsC;oBACtC,MAAM,OAAO,GAAsB;wBACjC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI;wBACxC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;wBACxC,KAAK,EAAE,EAAE;wBACT,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,QAAQ;qBACxC,CAAC;oBAEF,mBAAmB;oBACnB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAClC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;4BAC1B,sBAAsB;4BACtB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gCACjB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gCAC/D,IAAI,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE;gCACtB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,IAAI,QAAQ;6BACzC,CAAC,CAAC;wBACL,CAAC;6BAAM,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;4BACtC,uBAAuB;4BACvB,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,EAAE;gCACvC,GAAG,UAAU;gCACb,IAAI,CAAC,IAAI;6BACV,CAAC,CAAC;4BACH,IAAI,aAAa,EAAE,CAAC;gCAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;4BAClC,CAAC;wBACH,CAAC;oBACH,CAAC;oBAED,sBAAsB;oBACtB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAiB,EAAE,CAAiB,EAAE,EAAE;wBAC1D,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;4BACxB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;wBAC3B,CAAC;wBACD,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACxC,CAAC,CAAC,CAAC;oBAEH,mCAAmC;oBACnC,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC7B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACzB,CAAC;oBAED,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,OAAO,IAAI,CAAC;YACd,CAAC;YAED,WAAW,CAAC,SAAS,CAAC,CAAC;YAEvB,yBAAyB;YACzB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACrB,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;oBACxB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;gBAC3B,CAAC;gBACD,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAE9C,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,6CAA6C,EAAE;aACtE;YACD,QAAQ,EAAE;gBACR,UAAU;aACX;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,KAAK,CAAC,OAAO,EAAE,EAAE;aACrE;YACD,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/handlers/file.d.ts

@@ -0,0 +1,32 @@
+import { ToolResponse } from "../types/tools.js";
+/**
+ * Reads a file and returns its content
+ */
+export declare function readFile(filePath: string, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Writes content to a file
+ */
+export declare function writeFile(filePath: string, content: string, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Lists files in a directory
+ */
+export declare function listFiles(dirPath: string, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Gets information about a file
+ */
+export declare function getFileInfo(filePath: string, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Searches for files matching a pattern
+ */
+export declare function searchForFiles(rootPath: string, pattern: string, excludePatterns: string[] | undefined, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Applies edits to a file
+ */
+export declare function editFile(filePath: string, edits: Array<{
+    oldText: string;
+    newText: string;
+}>, allowedDirectories: string[]): Promise<ToolResponse>;
+/**
+ * Gets the directory structure as a tree
+ */
+export declare function getDirectoryTree(dirPath: string, allowedDirectories: string[]): Promise<ToolResponse>;

package/dist/handlers/file.js

@@ -0,0 +1,222 @@
+import fs from "fs/promises";
+import path from "path";
+import { validatePath } from "../utils/path.js";
+import { getFileStats, searchFiles, applyFileEdits } from "../utils/file.js";
+/**
+ * Reads a file and returns its content
+ */
+export async function readFile(filePath, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(filePath, allowedDirectories);
+        const content = await fs.readFile(normalizedPath, "utf-8");
+        return {
+            content: [{ type: "text", text: "File read successfully" }],
+            metadata: {
+                path: filePath,
+                content,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error reading file: ${error.message}` }],
+            isError: true,
+        };
+    }
+}
+/**
+ * Writes content to a file
+ */
+export async function writeFile(filePath, content, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(filePath, allowedDirectories);
+        // Ensure the directory exists
+        const dirPath = path.dirname(normalizedPath);
+        await fs.mkdir(dirPath, { recursive: true });
+        // Write the file
+        await fs.writeFile(normalizedPath, content);
+        return {
+            content: [{ type: "text", text: "File written successfully" }],
+            metadata: {
+                path: filePath,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error writing file: ${error.message}` }],
+            isError: true,
+        };
+    }
+}
+/**
+ * Lists files in a directory
+ */
+export async function listFiles(dirPath, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(dirPath, allowedDirectories);
+        const entries = await fs.readdir(normalizedPath, { withFileTypes: true });
+        const files = entries.map((entry) => ({
+            name: entry.name,
+            isDirectory: entry.isDirectory(),
+            isFile: entry.isFile(),
+        }));
+        return {
+            content: [
+                { type: "text", text: `Listed ${files.length} files in ${dirPath}` },
+            ],
+            metadata: {
+                path: dirPath,
+                files,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error listing files: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Gets information about a file
+ */
+export async function getFileInfo(filePath, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(filePath, allowedDirectories);
+        const fileInfo = await getFileStats(normalizedPath);
+        return {
+            content: [
+                { type: "text", text: "File information retrieved successfully" },
+            ],
+            metadata: {
+                path: filePath,
+                info: fileInfo,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error getting file info: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Searches for files matching a pattern
+ */
+export async function searchForFiles(rootPath, pattern, excludePatterns = [], allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(rootPath, allowedDirectories);
+        const files = await searchFiles(normalizedPath, pattern, excludePatterns);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Found ${files.length} files matching pattern "${pattern}"`,
+                },
+            ],
+            metadata: {
+                rootPath,
+                pattern,
+                excludePatterns,
+                files,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                { type: "text", text: `Error searching files: ${error.message}` },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Applies edits to a file
+ */
+export async function editFile(filePath, edits, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(filePath, allowedDirectories);
+        const diff = await applyFileEdits(normalizedPath, edits, false);
+        return {
+            content: [{ type: "text", text: "File edited successfully" }],
+            metadata: {
+                path: filePath,
+                diff,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error editing file: ${error.message}` }],
+            isError: true,
+        };
+    }
+}
+/**
+ * Gets the directory structure as a tree
+ */
+export async function getDirectoryTree(dirPath, allowedDirectories) {
+    try {
+        const normalizedPath = await validatePath(dirPath, allowedDirectories);
+        async function buildTree(currentPath) {
+            const entries = await fs.readdir(currentPath, { withFileTypes: true });
+            const result = [];
+            for (const entry of entries) {
+                const entryPath = path.join(currentPath, entry.name);
+                if (entry.isDirectory()) {
+                    const children = await buildTree(entryPath);
+                    result.push({
+                        name: entry.name,
+                        path: entryPath,
+                        type: "directory",
+                        children,
+                    });
+                }
+                else {
+                    result.push({
+                        name: entry.name,
+                        path: entryPath,
+                        type: "file",
+                    });
+                }
+            }
+            // Sort entries: directories first, then files, both alphabetically
+            result.sort((a, b) => {
+                if (a.type !== b.type) {
+                    return a.type === "directory" ? -1 : 1;
+                }
+                return a.name.localeCompare(b.name);
+            });
+            return result;
+        }
+        const tree = await buildTree(normalizedPath);
+        return {
+            content: [
+                { type: "text", text: "Directory tree retrieved successfully" },
+            ],
+            metadata: {
+                path: dirPath,
+                tree,
+            },
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Error getting directory tree: ${error.message}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+//# sourceMappingURL=file.js.map