@afterxleep/doc-bot 1.1.0 → 1.3.0

package/README.md

@@ -109,6 +109,28 @@ Run tests with: `npm test`
 
 **👀 See `examples/` folder for complete example files with proper frontmatter and content structure.**
 
+## Rule Enforcement
+
+Doc-bot ensures your rules are **always considered** through multiple enforcement mechanisms:
+
+### 🚨 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
+
+### 🔄 Automatic Integration
+- **System prompt injection**: Global rules injected into agent's system context via `docs://system-prompt`
+- **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.
+
 ## The manifest file
 
 The `doc-bot/manifest.json` file controls how your documentation works:

package/package.json

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

package/src/index.js

@@ -68,6 +68,12 @@ class DocsServer {
             name: 'Documentation Manifest',
             description: 'Project documentation configuration',
             mimeType: 'application/json'
+          },
+          {
+            uri: 'docs://system-prompt',
+            name: 'System Prompt Injection',
+            description: 'Critical rules that must be considered before generating any code',
+            mimeType: 'text/plain'
           }
         ]
       };
@@ -107,6 +113,16 @@ class DocsServer {
               text: JSON.stringify(manifest, null, 2)
             }]
           };
+
+        case 'docs://system-prompt':
+          const systemPrompt = await this.generateSystemPrompt();
+          return {
+            contents: [{
+              uri,
+              mimeType: 'text/plain',
+              text: systemPrompt
+            }]
+          };
           
         default:
           throw new Error(`Unknown resource: ${uri}`);
@@ -117,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',
@@ -133,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: {
@@ -152,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: {}
@@ -182,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) {
@@ -284,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;
   }
   
@@ -318,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;
   }
   
@@ -351,6 +401,50 @@ class DocsServer {
     
     return output;
   }
+
+  async generateSystemPrompt() {
+    const globalRules = await this.docService.getGlobalRules();
+    
+    if (!globalRules || globalRules.length === 0) {
+      return 'No global documentation rules defined.';
+    }
+    
+    let prompt = '# CRITICAL: Project Documentation Rules\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 += '⚠️ VIOLATION OF THESE RULES IS NOT ACCEPTABLE. Always check compliance before responding.\n';
+    
+    return prompt;
+  }
+
+  async getMandatoryRules(task) {
+    const globalRules = await this.docService.getGlobalRules();
+    
+    if (!globalRules || globalRules.length === 0) {
+      return '❌ WARNING: No project rules defined. Proceeding without guidelines.';
+    }
+    
+    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) => {
+      output += `## ${index + 1}. ${rule.metadata?.title || rule.fileName}\n`;
+      output += `${rule.content}\n\n`;
+      output += '---\n\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 output;
+  }
   
   async start() {
     // Initialize services