@afterxleep/doc-bot 1.7.0 → 1.7.2

package/README.md

@@ -97,7 +97,19 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
      "mcpServers": {
        "docbot": {
          "command": "npx",
-         "args": ["@afterxleep/doc-bot", "--docs", "./doc-bot"]
+         "args": ["@afterxleep/doc-bot"]
+       }
+     }
+   }
+   ```
+
+   **Note:** By default, doc-bot looks for a `.doc-bot` folder. To use a different folder:
+   ```json
+   {
+     "mcpServers": {
+       "docbot": {
+         "command": "npx",
+         "args": ["@afterxleep/doc-bot", "--docs", "./my-custom-docs"]
        }
      }
    }
@@ -107,11 +119,11 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
 
 ## How to organize your documentation
 
-Create a `doc-bot/` folder in your project root with markdown files using frontmatter:
+Create a `.doc-bot/` folder in your project root with markdown files using frontmatter:
 
 ```
 your-project/
-├── doc-bot/
+├── .doc-bot/
 │   ├── coding-standards.md     # Global rule (alwaysApply: true)
 │   ├── security.md             # Global rule (alwaysApply: true) 
 │   ├── testing.md              # Contextual rule (alwaysApply: false)
@@ -120,10 +132,7 @@ your-project/
 └── package.json
 ```
 
-**Note:** You can use any folder name - just specify it in your MCP configuration:
-```json
-"args": ["@afterxleep/doc-bot", "--docs", "./my-custom-docs"]
-```
+**Note:** The `.doc-bot` folder is the default location. You can use any folder name by specifying it with the `--docs` option.
 
 ### Documentation types:
 
@@ -132,7 +141,7 @@ your-project/
 
 ### Example documentation files:
 
-**Global Rule Example** (`doc-bot/coding-standards.md`):
+**Global Rule Example** (`.doc-bot/coding-standards.md`):
 ```markdown
 ---
 alwaysApply: true
@@ -150,7 +159,7 @@ keywords: ["code-quality", "standards", "best-practices"]
 - Write descriptive variable names
 ```
 
-**Contextual Rule Example** (`doc-bot/testing.md`):
+**Contextual Rule Example** (`.doc-bot/testing.md`):
 ```markdown
 ---
 alwaysApply: false
@@ -254,7 +263,7 @@ Ask your AI assistant something like "What documentation is available?" to test
 doc-bot [options]
 
 Options:
-  -d, --docs <path>        Path to docs folder (required)
+  -d, --docs <path>        Path to docs folder (default: .doc-bot)
   -c, --config <path>      Path to manifest file (optional, for backward compatibility)
   -v, --verbose           Enable verbose logging
   -w, --watch             Watch for file changes
@@ -263,14 +272,17 @@ Options:
 
 **Example usage:**
 ```bash
-# Basic usage (no manifest.json needed)
+# Basic usage with default .doc-bot folder
+doc-bot
+
+# Specify a custom docs folder
 doc-bot --docs ./my-docs
 
 # With verbose logging and file watching
-doc-bot --docs ./my-docs --verbose --watch
+doc-bot --verbose --watch
 
 # With optional manifest for backward compatibility
-doc-bot --docs ./my-docs --config ./manifest.json
+doc-bot --config ./manifest.json
 ```
 
 ## Publishing and Development
@@ -296,9 +308,9 @@ doc-bot --docs ./my-docs --config ./manifest.json
    ```json
    {
      "mcpServers": {
-       "docs": {
+       "doc-bot": {
          "command": "node",
-         "args": ["/path/to/doc-bot/bin/doc-bot.js", "--docs", "./doc-bot", "--watch"]
+         "args": ["/path/to/doc-bot/bin/doc-bot.js", "--watch"]
        }
      }
    }

package/bin/doc-bot.js

@@ -9,7 +9,7 @@ program
   .name('doc-bot')
   .description('Generic MCP server for intelligent documentation access')
   .version('1.5.0')
-  .requiredOption('-d, --docs <path>', 'Path to docs folder')
+  .option('-d, --docs <path>', 'Path to docs folder', 'doc-bot')
   .option('-c, --config <path>', 'Path to manifest file')
   .option('-v, --verbose', 'Enable verbose logging')
   .option('-w, --watch', 'Watch for file changes')
@@ -33,9 +33,9 @@ async function main() {
     console.log('📋 Use frontmatter in your markdown files:');
     console.log('   alwaysApply: true   (for global rules)');
     console.log('   alwaysApply: false  (for contextual rules)');
-    console.log('   filePatterns: ["*.js", "src/**/*"]  (when to apply contextual rules)');
     console.log('');
-    console.log('Then configure your MCP client to use this folder.');
+    console.log('💡 Tip: By default, doc-bot looks for a doc-bot folder.');
+    console.log('   Use --docs to specify a different folder.');
     process.exit(1);
   }
   

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@afterxleep/doc-bot",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Generic MCP server for intelligent documentation access in any project",
   "main": "src/index.js",
   "bin": {
     "doc-bot": "bin/doc-bot.js"
   },
   "scripts": {
-    "start": "node bin/doc-bot.js --docs ./doc-bot --verbose",
-    "start:watch": "node bin/doc-bot.js --docs ./doc-bot --verbose --watch",
-    "start:examples": "node bin/doc-bot.js --docs ./examples/documentation-files --verbose",
-    "dev": "node bin/doc-bot.js --docs ./doc-bot --verbose --watch",
+    "start": "node bin/doc-bot.js --verbose",
+    "start:watch": "node bin/doc-bot.js --verbose --watch",
+    "start:examples": "node bin/doc-bot.js --docs ./samples --verbose",
+    "dev": "node bin/doc-bot.js --verbose --watch",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",

package/src/index.js

@@ -11,8 +11,8 @@ const fs = require('fs').promises;
 class DocsServer {
   constructor(options = {}) {
     this.options = {
-      docsPath: options.docsPath || './docs.ai',
-      configPath: options.configPath || './docs.ai/manifest.json', // Optional, for backward compatibility
+      docsPath: options.docsPath || './doc-bot',
+      configPath: options.configPath || './doc-bot/manifest.json', // Optional, for backward compatibility
       verbose: options.verbose || false,
       watch: options.watch || false,
       ...options