@afterxleep/doc-bot 1.7.11 → 1.8.0

package/README.md

@@ -99,7 +99,7 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
      "mcpServers": {
        "doc-bot": {
          "command": "npx",
-         "args": ["@afterxleep/doc-bot"]
+         "args": ["@afterxleep/doc-bot@latest"]
        }
      }
    }
@@ -111,7 +111,7 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
      "mcpServers": {
        "doc-bot": {
          "command": "npx",
-         "args": ["@afterxleep/doc-bot", "--docs", "./my-custom-docs"]
+         "args": ["@afterxleep/doc-bot@latest", "--docs", "./my-custom-docs"]
        }
      }
    }
@@ -123,7 +123,7 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
      "mcpServers": {
        "doc-bot": {
          "command": "npx",
-         "args": ["@afterxleep/doc-bot", "--verbose"]
+         "args": ["@afterxleep/doc-bot@latest", "--verbose"]
        }
      }
    }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@afterxleep/doc-bot",
-  "version": "1.7.11",
+  "version": "1.8.0",
   "description": "Generic MCP server for intelligent documentation access in any project",
   "main": "src/index.js",
   "bin": {

package/src/index.js

@@ -267,6 +267,15 @@ class DocsServer {
               properties: {},
               additionalProperties: false
             }
+          },
+          {
+            name: 'get_document_index',
+            description: 'Get an index of all documents in the store with title, description, and last updated date.',
+            inputSchema: {
+              type: 'object',
+              properties: {},
+              additionalProperties: false
+            }
           }
         ]
       };
@@ -372,6 +381,16 @@ class DocsServer {
                 text: `✅ Documentation refreshed successfully!\n\n**Files indexed:** ${docCount}\n**Last updated:** ${new Date().toLocaleString()}\n\n💡 All manually added files should now be available for search and reading.`
               }]
             };
+
+          case 'get_document_index':
+            const documentIndex = await this.docService.getDocumentIndex();
+            
+            return {
+              content: [{
+                type: 'text',
+                text: await this.formatDocumentIndex(documentIndex)
+              }]
+            };
             
           default:
             throw new Error(`Unknown tool: ${name}`);
@@ -554,6 +573,31 @@ class DocsServer {
     return output;
   }
 
+  async formatDocumentIndex(documentIndex) {
+    if (!documentIndex || documentIndex.length === 0) {
+      return 'No documents found in the store.';
+    }
+    
+    let output = '# Document Index\n\n';
+    output += `Found ${documentIndex.length} document(s) in the store:\n\n`;
+    
+    documentIndex.forEach((doc, index) => {
+      output += `## ${index + 1}. ${doc.title}\n\n`;
+      output += `**File:** ${doc.fileName}\n`;
+      
+      if (doc.description) {
+        output += `**Description:** ${doc.description}\n`;
+      }
+      
+      output += `**Last Updated:** ${new Date(doc.lastUpdated).toLocaleString()}\n\n`;
+      output += '---\n\n';
+    });
+    
+    output += '💡 **Next Steps:** Use the `read_specific_document` tool with the file name to get the full content of any document above.\n';
+    
+    return output;
+  }
+
   async createOrUpdateRule({ fileName, title, description, keywords, alwaysApply, content }) {
     const fs = require('fs-extra');
     const path = require('path');

package/src/index.test.js

@@ -0,0 +1,109 @@
+const { DocumentationService } = require('./services/DocumentationService');
+const fs = require('fs-extra');
+const path = require('path');
+
+describe('DocumentationService get_document_index functionality', () => {
+  let docService;
+  let tempDocsPath;
+
+  beforeEach(async () => {
+    // Create a temporary directory for test documents
+    tempDocsPath = path.join(__dirname, '../test-docs');
+    await fs.ensureDir(tempDocsPath);
+    
+    // Create test documents
+    const testDocs = [
+      {
+        fileName: 'react-guide.md',
+        content: '---\nalwaysApply: false\ntitle: "React Component Guide"\ndescription: "Learn how to build React components"\nkeywords: ["react", "components", "jsx"]\n---\n\n# React Components\n\nThis guide covers React components.'
+      },
+      {
+        fileName: 'testing-standards.md',
+        content: '---\nalwaysApply: true\ntitle: "Testing Standards"\ndescription: "Project testing requirements"\nkeywords: ["testing", "jest", "standards"]\n---\n\n# Testing Standards\n\nAll code must have tests.'
+      },
+      {
+        fileName: 'api-design.md',
+        content: '---\nalwaysApply: false\ntitle: "API Design Guidelines"\ndescription: "REST API design patterns"\nkeywords: ["api", "rest", "design"]\n---\n\n# API Design\n\nFollow REST principles.'
+      }
+    ];
+
+    // Write test documents to temp directory
+    for (const doc of testDocs) {
+      await fs.writeFile(path.join(tempDocsPath, doc.fileName), doc.content);
+    }
+
+    // Create DocumentationService instance
+    docService = new DocumentationService(tempDocsPath);
+    await docService.initialize();
+  });
+
+  afterEach(async () => {
+    // Clean up temporary directory
+    await fs.remove(tempDocsPath);
+  });
+
+  describe('getDocumentIndex method', () => {
+    it('should be implemented and return document index', async () => {
+      expect(typeof docService.getDocumentIndex).toBe('function');
+      
+      const index = await docService.getDocumentIndex();
+      
+      expect(Array.isArray(index)).toBe(true);
+      expect(index.length).toBe(3);
+      
+      // Check that each document has required fields
+      index.forEach(doc => {
+        expect(doc).toHaveProperty('title');
+        expect(doc).toHaveProperty('description');
+        expect(doc).toHaveProperty('fileName');
+        expect(doc).toHaveProperty('lastUpdated');
+        expect(typeof doc.lastUpdated).toBe('string');
+      });
+    });
+
+    it('should return documents sorted by title', async () => {
+      const index = await docService.getDocumentIndex();
+      
+      // Should be sorted alphabetically by title
+      expect(index[0].title).toBe('API Design Guidelines');
+      expect(index[1].title).toBe('React Component Guide');
+      expect(index[2].title).toBe('Testing Standards');
+    });
+
+    it('should include metadata from frontmatter', async () => {
+      const index = await docService.getDocumentIndex();
+      
+      const reactDoc = index.find(doc => doc.fileName === 'react-guide.md');
+      expect(reactDoc.title).toBe('React Component Guide');
+      expect(reactDoc.description).toBe('Learn how to build React components');
+      
+      const testingDoc = index.find(doc => doc.fileName === 'testing-standards.md');
+      expect(testingDoc.title).toBe('Testing Standards');
+      expect(testingDoc.description).toBe('Project testing requirements');
+    });
+
+    it('should use file name as title when no title in metadata', async () => {
+      // Create a document without title metadata
+      const docWithoutTitle = '---\ndescription: "A document without title"\n---\n\nSome content';
+      await fs.writeFile(path.join(tempDocsPath, 'no-title.md'), docWithoutTitle);
+      
+      // Reload documents to pick up the new file
+      await docService.reload();
+      
+      const index = await docService.getDocumentIndex();
+      const noTitleDoc = index.find(doc => doc.fileName === 'no-title.md');
+      
+      expect(noTitleDoc.title).toBe('no-title.md');
+      expect(noTitleDoc.description).toBe('A document without title');
+    });
+
+    it('should handle empty description gracefully', async () => {
+      const index = await docService.getDocumentIndex();
+      
+      // All test documents should have descriptions, but let's test the structure
+      index.forEach(doc => {
+        expect(typeof doc.description).toBe('string');
+      });
+    });
+  });
+});

package/src/services/DocumentationService.js

@@ -308,6 +308,22 @@ class DocumentationService {
     return results;
   }
   
+  async getDocumentIndex() {
+    const index = [];
+    
+    for (const doc of this.documents.values()) {
+      index.push({
+        title: doc.metadata?.title || doc.fileName,
+        description: doc.metadata?.description || '',
+        fileName: doc.fileName,
+        lastUpdated: doc.lastModified.toISOString()
+      });
+    }
+    
+    // Sort by title for consistent ordering
+    return index.sort((a, b) => a.title.localeCompare(b.title));
+  }
+  
 }
 
 module.exports = { DocumentationService };