@afterxleep/doc-bot 1.2.0 → 1.4.0

package/README.md

@@ -111,13 +111,48 @@ Run tests with: `npm test`
 
 ## Rule Enforcement
 
-Doc-bot ensures your rules are **always considered** through MCP system prompt injection:
+Doc-bot ensures your rules are **always considered** through multiple enforcement mechanisms:
 
-- **Global Rules**: Automatically injected into the agent's system prompt as critical requirements
-- **Contextual Rules**: Applied when working with matching files/patterns  
-- **Automatic Compliance**: Agent must check rules before generating any code
+### 🚨 Mandatory Rule Checking
+- **`check_project_rules` tool**: Must be called before ANY code generation
+- **Aggressive descriptions**: All tools emphasize mandatory rule compliance
+- **Rule reminders**: Every tool response includes compliance warnings
 
-The `docs://system-prompt` resource delivers your global rules directly to the agent's context, making rule violations impossible to ignore.
+### 🔄 Automatic Integration
+- **Enhanced system prompt injection**: Comprehensive MCP usage protocol injected via `docs://system-prompt`
+- **Documentation discovery**: Available topics automatically extracted and presented to agent
+- **Tool usage instructions**: Explicit requirements for when and how to use each MCP tool
+- **Contextual rules**: Applied when working with matching files/patterns  
+- **Multiple touchpoints**: Rules enforced at every interaction level
+
+### ⚠️ Compliance Warnings
+All tool responses include explicit warnings that rules are:
+- **NON-NEGOTIABLE**: Must be followed without exception
+- **MANDATORY**: Violation will result in rejection
+- **CRITICAL**: Require acknowledgment before proceeding
+
+This multi-layered approach makes rule violations virtually impossible to ignore.
+
+## System Prompt Integration
+
+The `docs://system-prompt` resource automatically injects comprehensive instructions into the AI agent's system context:
+
+### 📋 MCP Usage Protocol
+- Explicit instructions to **ALWAYS** call `check_project_rules` before code generation
+- **NEVER generate code without checking documentation** requirement
+- Mandatory acknowledgment of rule compliance
+
+### 🏷️ Automatic Topic Discovery
+- Extracts available documentation topics from your project
+- Presents them to the agent for context awareness
+- Includes topics from metadata, filenames, and content analysis
+
+### 🛠️ Tool Usage Requirements
+- Specifies when and how to use each MCP tool
+- Maps tools to specific use cases (file-specific docs, search, etc.)
+- Ensures comprehensive documentation coverage
+
+The system prompt is regenerated on each request to reflect current documentation state.
 
 ## The manifest file
 

package/package.json

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

package/src/index.js

@@ -133,6 +133,20 @@ class DocsServer {
     this.server.setRequestHandler(ListToolsRequestSchema, async () => {
       return {
         tools: [
+          {
+            name: 'check_project_rules',
+            description: '⚠️ MANDATORY: Must be called before generating ANY code. Returns critical project rules and coding standards that MUST be followed.',
+            inputSchema: {
+              type: 'object',
+              properties: {
+                task: {
+                  type: 'string',
+                  description: 'Brief description of the coding task about to be performed'
+                }
+              },
+              required: ['task']
+            }
+          },
           {
             name: 'search_documentation',
             description: 'Search documentation by query',
@@ -149,7 +163,7 @@ class DocsServer {
           },
           {
             name: 'get_relevant_docs',
-            description: 'Get context-aware documentation suggestions',
+            description: 'Get context-aware documentation suggestions including project rules that must be followed',
             inputSchema: {
               type: 'object',
               properties: {
@@ -168,7 +182,7 @@ class DocsServer {
           },
           {
             name: 'get_global_rules',
-            description: 'Get always-apply documentation rules',
+            description: 'Get critical project rules that must ALWAYS be followed when writing code',
             inputSchema: {
               type: 'object',
               properties: {}
@@ -198,6 +212,16 @@ class DocsServer {
       
       try {
         switch (name) {
+          case 'check_project_rules':
+            const task = args?.task || 'code generation';
+            const mandatoryRules = await this.getMandatoryRules(task);
+            return {
+              content: [{
+                type: 'text',
+                text: mandatoryRules
+              }]
+            };
+            
           case 'search_documentation':
             const query = args?.query;
             if (!query) {
@@ -300,6 +324,9 @@ class DocsServer {
       output += `\n${doc.content}\n\n---\n\n`;
     });
     
+    // Add rule reminder to all search results
+    output += '\n⚠️ REMINDER: Before implementing any code, use the check_project_rules tool to ensure compliance.\n';
+    
     return output;
   }
   
@@ -334,22 +361,29 @@ class DocsServer {
       output += `**Confidence:** ${relevant.confidence.toFixed(2)}\n\n`;
     }
     
+    // Add rule reminder for contextual docs
+    output += '\n⚠️ CRITICAL: These rules are MANDATORY and must be followed before generating code.\n';
+    
     return output;
   }
   
   formatGlobalRules(globalRules) {
     if (!globalRules || globalRules.length === 0) {
-      return 'No global rules defined.';
+      return '❌ WARNING: No global rules defined. Consider adding project rules for code consistency.';
     }
     
-    let output = '# Global Rules (Always Apply)\n\n';
-    output += 'These rules should be applied to all interactions:\n\n';
+    let output = '🚨 MANDATORY Global Rules (ALWAYS Apply) 🚨\n\n';
+    output += '⚠️ CRITICAL: These rules are NON-NEGOTIABLE and must be followed in ALL code generation:\n\n';
     
-    globalRules.forEach(rule => {
-      output += `## ${rule.metadata?.title || rule.fileName}\n`;
+    globalRules.forEach((rule, index) => {
+      output += `## ${index + 1}. ${rule.metadata?.title || rule.fileName}\n`;
       output += `${rule.content}\n\n`;
+      output += '---\n\n';
     });
     
+    output += '✅ ACKNOWLEDGMENT REQUIRED: You must confirm compliance with these rules before proceeding.\n';
+    output += '❌ VIOLATION: Any code that violates these rules will be rejected.\n';
+    
     return output;
   }
   
@@ -370,22 +404,138 @@ class DocsServer {
 
   async generateSystemPrompt() {
     const globalRules = await this.docService.getGlobalRules();
+    const allDocs = await this.docService.getAllDocuments();
+    
+    let prompt = '# CRITICAL: Project Documentation and MCP Server Integration\n\n';
+    
+    // Add MCP server usage instructions
+    prompt += '## 🔧 MANDATORY: MCP Server Usage Protocol\n\n';
+    prompt += 'You have access to a doc-bot MCP server with the following MANDATORY requirements:\n\n';
+    prompt += '### 🚨 BEFORE ANY CODE GENERATION:\n';
+    prompt += '1. **ALWAYS** call `check_project_rules` tool first to get critical project rules\n';
+    prompt += '2. **NEVER generate code without checking project documentation**\n';
+    prompt += '3. **REQUIRED** to acknowledge rule compliance before proceeding\n\n';
+    
+    prompt += '### 📚 Available Documentation Resources:\n';
+    if (allDocs && allDocs.length > 0) {
+      const docTopics = this.extractDocumentationTopics(allDocs);
+      prompt += 'This project has documentation covering:\n';
+      docTopics.forEach(topic => {
+        prompt += `- ${topic}\n`;
+      });
+      prompt += '\n';
+    }
+    
+    prompt += '### 🛠️ Required MCP Tool Usage:\n';
+    prompt += '- Use `check_project_rules` before ANY code generation\n';
+    prompt += '- Use `get_relevant_docs` when working with specific files/patterns\n';
+    prompt += '- Use `search_documentation` to find specific guidance\n';
+    prompt += '- Use `get_global_rules` for comprehensive rule review\n\n';
+    
+    // Add project-specific rules
+    if (globalRules && globalRules.length > 0) {
+      prompt += '## 📋 Project-Specific Rules (NON-NEGOTIABLE)\n\n';
+      prompt += 'IMPORTANT: You MUST follow these rules before generating ANY code:\n\n';
+      
+      globalRules.forEach((rule, index) => {
+        prompt += `### Rule ${index + 1}: ${rule.metadata?.title || rule.fileName}\n`;
+        prompt += `${rule.content}\n\n`;
+      });
+    }
+    
+    prompt += '---\n\n';
+    prompt += '⚠️ **CRITICAL COMPLIANCE REQUIREMENTS:**\n';
+    prompt += '- VIOLATION OF THESE RULES IS NOT ACCEPTABLE\n';
+    prompt += '- ALWAYS use MCP tools before coding\n';
+    prompt += '- ACKNOWLEDGE rule compliance before responding\n';
+    prompt += '- NEVER assume - always check documentation\n';
+    
+    return prompt;
+  }
+
+  extractDocumentationTopics(docs) {
+    const topics = new Set();
+    
+    docs.forEach(doc => {
+      // Add topics from metadata
+      if (doc.metadata?.topics) {
+        doc.metadata.topics.forEach(topic => topics.add(topic));
+      }
+      
+      // Add topics from keywords
+      if (doc.metadata?.keywords) {
+        doc.metadata.keywords.forEach(keyword => topics.add(keyword));
+      }
+      
+      // Add filename-based topics
+      const fileName = doc.fileName.replace(/\.(md|txt)$/, '');
+      const fileTopics = fileName.split(/[-_]/).map(part => 
+        part.charAt(0).toUpperCase() + part.slice(1)
+      );
+      fileTopics.forEach(topic => topics.add(topic));
+      
+      // Add content-based topics (simple heuristic)
+      if (doc.content) {
+        const contentTopics = this.extractContentTopics(doc.content);
+        contentTopics.forEach(topic => topics.add(topic));
+      }
+    });
+    
+    return Array.from(topics).slice(0, 10); // Limit to top 10 topics
+  }
+
+  extractContentTopics(content) {
+    const topics = new Set();
+    
+    // Extract from headers
+    const headers = content.match(/^#+\s+(.+)$/gm);
+    if (headers) {
+      headers.forEach(header => {
+        const topic = header.replace(/^#+\s+/, '').trim();
+        if (topic.length > 3 && topic.length < 50) {
+          topics.add(topic);
+        }
+      });
+    }
+    
+    // Extract common programming topics
+    const programmingPatterns = [
+      'Swift', 'SwiftUI', 'iOS', 'macOS', 'Architecture', 'Testing',
+      'Performance', 'Security', 'Privacy', 'Patterns', 'Components',
+      'API', 'Database', 'UI', 'UX', 'Analytics', 'Configuration'
+    ];
+    
+    programmingPatterns.forEach(pattern => {
+      if (content.toLowerCase().includes(pattern.toLowerCase())) {
+        topics.add(pattern);
+      }
+    });
+    
+    return Array.from(topics);
+  }
+
+  async getMandatoryRules(task) {
+    const globalRules = await this.docService.getGlobalRules();
     
     if (!globalRules || globalRules.length === 0) {
-      return 'No global documentation rules defined.';
+      return '❌ WARNING: No project rules defined. Proceeding without guidelines.';
     }
     
-    let prompt = '# CRITICAL: Project Documentation Rules\n\n';
-    prompt += 'IMPORTANT: You MUST follow these rules before generating ANY code:\n\n';
+    let output = '🚨 MANDATORY PROJECT RULES - MUST FOLLOW BEFORE CODING 🚨\n\n';
+    output += `Task: ${task}\n\n`;
+    output += '⚠️ CRITICAL: These rules are NON-NEGOTIABLE and must be followed:\n\n';
     
     globalRules.forEach((rule, index) => {
-      prompt += `## Rule ${index + 1}: ${rule.metadata?.title || rule.fileName}\n`;
-      prompt += `${rule.content}\n\n`;
+      output += `## ${index + 1}. ${rule.metadata?.title || rule.fileName}\n`;
+      output += `${rule.content}\n\n`;
+      output += '---\n\n';
     });
     
-    prompt += '⚠️ VIOLATION OF THESE RULES IS NOT ACCEPTABLE. Always check compliance before responding.\n';
+    output += '✅ CONFIRMATION REQUIRED: You MUST acknowledge these rules before generating code.\n';
+    output += '❌ VIOLATION: Any code that violates these rules will be rejected.\n\n';
+    output += '🔄 Next step: Generate code that strictly follows ALL the above rules.\n';
     
-    return prompt;
+    return output;
   }
   
   async start() {