@afterxleep/doc-bot 1.0.0 → 1.0.2

package/README.md

@@ -1,89 +1,74 @@
-# docbot
+# doc-bot
 
-[![npm version](https://img.shields.io/npm/v/docbot)](https://www.npmjs.com/package/docbot)
+[![npm version](https://img.shields.io/npm/v/@afterxleep/doc-bot)](https://www.npmjs.com/package/@afterxleep/doc-bot)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A generic, open-source MCP (Model Context Protocol) server that provides intelligent documentation access for any project. Works with AI agents like Claude Code, Cursor, and any other MCP-compatible tools.
+A generic MCP (Model Context Protocol) server that provides intelligent documentation access for any project. Works with any MCP-compatible AI tools and IDEs.
 
-## 🚀 Features
+## What is doc-bot?
 
-- **🔍 Smart Documentation Search**: Full-text search across all documentation
-- **🧠 Intelligent Inference**: Context-aware documentation suggestions based on your current work
-- **📋 Global Rules**: Always-apply documentation that's relevant to every interaction
-- **🎯 Contextual Docs**: File-specific documentation based on patterns and file types
-- **📦 Zero Config**: Works out of the box with a simple `docbot/` folder
-- **🔄 Hot Reload**: Automatically updates when documentation changes
-- **🛠️ Universal**: Works with any project, any language, any framework
+doc-bot is an intelligent documentation server that:
+- 🔍 **Searches** your project documentation instantly
+- 🧠 **Infers** relevant docs based on your current work
+- 📋 **Applies** global rules to every AI interaction
+- 🎯 **Suggests** contextual documentation based on file patterns
+- 🔄 **Updates** automatically when docs change
 
-## 📦 Installation & Usage
+## Installation
 
-### Quick Start
+1. **Create your documentation folder** in your project root (see organization section below)
 
-1. **Install and run in your project:**
-   ```bash
-   # Navigate to your project directory
-   cd your-project
-   
-   # Run the server (installs automatically)
-   npx docbot
-   ```
-
-2. **Create your documentation structure:**
-   ```bash
-   mkdir docbot
-   echo '{"name": "My Project Documentation", "globalRules": []}' > docbot/manifest.json
-   echo "# Getting Started" > docbot/README.md
-   ```
+2. **Add doc-bot to your MCP-compatible AI tool configuration**:
 
-3. **Add to your Claude Code configuration:**
+   **For Claude Code** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
    ```json
    {
      "mcpServers": {
        "docs": {
          "command": "npx",
-         "args": ["docbot"]
+         "args": ["@afterxleep/doc-bot", "--docs", "./doc-bot"]
        }
      }
    }
    ```
 
-4. **Restart Claude Code and start using intelligent documentation!**
-
-### Global Installation
+   **For Cursor or other MCP tools**: Add similar configuration pointing to your documentation folder
 
-```bash
-# Install globally
-npm install -g docbot
+3. **Restart your AI tool**
 
-# Run in any project
-docbot
-```
+## How to organize your documentation
 
-## 📁 Project Structure
-
-Create a `docbot/` folder in your project root:
+Create a `doc-bot/` folder in your project root:
 
 ```
 your-project/
-├── docbot/
-│   ├── manifest.json          # Configuration and rules
+├── doc-bot/
+│   ├── manifest.json          # Configuration file
 │   ├── core/
-│   │   ├── architecture.md    # Always-apply architecture guidelines
-│   │   ├── coding-standards.md # Coding standards for all files
-│   │   └── security.md        # Security guidelines
+│   │   ├── coding-standards.md # Always-apply coding standards
+│   │   └── security.md         # Security guidelines
 │   ├── guides/
-│   │   ├── testing.md         # Testing strategies
-│   │   ├── deployment.md      # Deployment procedures
-│   │   └── api-development.md # API development guide
+│   │   ├── testing.md          # Testing strategies
+│   │   └── api-development.md  # API development guide
 │   └── reference/
-│       ├── troubleshooting.md # Common issues and solutions
-│       └── best-practices.md  # Best practices by topic
+│       └── troubleshooting.md  # Common issues and solutions
 └── package.json
 ```
 
-## ⚙️ Configuration
+**Note:** You can use any folder name - just specify it in your MCP configuration:
+```json
+"args": ["@afterxleep/doc-bot", "--docs", "./my-custom-docs"]
+```
+
+### Documentation types:
 
-### Manifest File (`docbot/manifest.json`)
+- **Core docs** (`core/`): Critical guidelines that should always be considered
+- **Guides** (`guides/`): Step-by-step instructions for specific tasks
+- **Reference** (`reference/`): Quick lookups and troubleshooting
+
+## The manifest file
+
+The `doc-bot/manifest.json` file controls how your documentation works:
 
 ```json
 {
@@ -98,262 +83,84 @@ your-project/
     "*.test.js": ["guides/testing.md"],
     "*.spec.js": ["guides/testing.md"],
     "src/components/*": ["guides/react-components.md"],
-    "src/api/*": ["guides/api-development.md"],
-    "*.md": ["guides/documentation.md"],
-    "package.json": ["guides/dependencies.md"]
+    "src/api/*": ["guides/api-development.md"]
   },
   "inference": {
     "keywords": {
       "testing": ["guides/testing.md"],
       "deployment": ["guides/deployment.md"],
-      "api": ["guides/api-development.md"],
-      "security": ["core/security.md"],
-      "performance": ["guides/performance.md"]
+      "api": ["guides/api-development.md"]
     },
     "patterns": {
       "describe(": ["guides/testing.md"],
       "it(": ["guides/testing.md"],
-      "fetch(": ["guides/api-development.md"],
-      "console.error": ["reference/troubleshooting.md"],
-      "try {": ["reference/error-handling.md"]
+      "fetch(": ["guides/api-development.md"]
     }
   }
 }
 ```
 
-### Configuration Options
-
-- **`globalRules`**: Documentation that applies to all interactions
-- **`contextualRules`**: Documentation triggered by specific file patterns
-- **`inference.keywords`**: Documentation triggered by keywords in queries
-- **`inference.patterns`**: Documentation triggered by code patterns
-
-## 🔧 CLI Options
-
-```bash
-docbot [options]
-
-Options:
-  -p, --port <port>        Port to run server on (default: 3000)
-  -d, --docs <path>        Path to docs folder (default: ./docbot)
-  -c, --config <path>      Path to manifest file (default: ./docbot/manifest.json)
-  -v, --verbose           Enable verbose logging
-  -w, --watch             Watch for file changes
-  -h, --help              Show help
-```
-
-## 🎯 How It Works
-
-### 1. Global Rules (Always Apply)
-Documents listed in `globalRules` are automatically included in every AI interaction:
-
-```json
-{
-  "globalRules": [
-    "core/coding-standards.md",
-    "core/security.md"
-  ]
-}
-```
-
-### 2. Contextual Rules (File-Based)
-When you're working on specific files, relevant documentation is automatically suggested:
-
-```json
-{
-  "contextualRules": {
-    "*.test.js": ["guides/testing.md"],
-    "src/components/*": ["guides/react-components.md"]
-  }
-}
-```
-
-### 3. Smart Inference
-The server analyzes your queries and code to suggest relevant documentation:
-
-- **Keywords**: "testing" → `guides/testing.md`
-- **Code Patterns**: `describe(` → `guides/testing.md`
-- **File Extensions**: `.py` → Python-related docs
-
-## 📖 Documentation Format
-
-### Frontmatter Support
-Add metadata to your documentation:
-
-```markdown
----
-title: Testing Guide
-description: Comprehensive testing strategies
-category: guides
-tags: [testing, jest, react]
-alwaysApply: false
----
-
-# Testing Guide
-
-Your documentation content here...
-```
-
-### Supported Formats
-- **Markdown** (`.md`)
-- **MDX** (`.mdx`)
-- **Cursor Rules** (`.mdc`)
-
-## 🛠️ Available Tools
-
-When using with Claude Code or other MCP clients:
-
-### `search_documentation`
-```javascript
-// Search all documentation
-search_documentation({ query: "testing best practices" })
-```
-
-### `get_relevant_docs`
-```javascript
-// Get context-aware suggestions
-get_relevant_docs({ 
-  context: {
-    query: "How to test React components",
-    filePath: "src/components/UserProfile.test.tsx",
-    codeSnippet: "describe('UserProfile', () => {"
-  }
-})
-```
+### Configuration explained:
 
-### `get_global_rules`
-```javascript
-// Get always-apply documentation
-get_global_rules()
-```
+- **`globalRules`**: Documents that apply to every AI interaction
+- **`contextualRules`**: Documents triggered by specific file patterns (e.g., test files → testing guide)
+- **`inference.keywords`**: Documents suggested when certain words appear in queries
+- **`inference.patterns`**: Documents suggested when certain code patterns are detected
 
-### `get_file_docs`
-```javascript
-// Get file-specific documentation
-get_file_docs({ filePath: "src/api/users.js" })
-```
+## Development setup
 
-## 🌟 Examples
+### Running locally
 
-### React Project
-```json
-{
-  "globalRules": ["core/react-standards.md"],
-  "contextualRules": {
-    "src/components/*": ["guides/components.md"],
-    "*.test.tsx": ["guides/testing.md"]
-  },
-  "inference": {
-    "keywords": {
-      "hook": ["guides/hooks.md"],
-      "state": ["guides/state-management.md"]
-    },
-    "patterns": {
-      "useState": ["guides/hooks.md"],
-      "useEffect": ["guides/hooks.md"]
-    }
-  }
-}
-```
-
-### Node.js API Project
-```json
-{
-  "globalRules": ["core/api-standards.md", "core/security.md"],
-  "contextualRules": {
-    "routes/*": ["guides/routing.md"],
-    "middleware/*": ["guides/middleware.md"],
-    "*.test.js": ["guides/testing.md"]
-  },
-  "inference": {
-    "keywords": {
-      "authentication": ["guides/auth.md"],
-      "database": ["guides/database.md"]
-    },
-    "patterns": {
-      "app.get": ["guides/routing.md"],
-      "app.post": ["guides/routing.md"]
-    }
-  }
-}
-```
-
-## 🔄 Integration with IDEs
-
-### Claude Code
-1. Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
-   ```json
-   {
-     "mcpServers": {
-       "docs": {
-         "command": "npx",
-         "args": ["docbot"]
-       }
-     }
-   }
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/afterxleep/doc-bot.git
+   cd doc-bot
    ```
 
-### Cursor
-Configure MCP server integration (coming soon)
-
-### VS Code
-Use with Claude Code extension or MCP-compatible extensions
+2. **Install dependencies:**
+   ```bash
+   npm install
+   ```
 
-## 🧪 Testing Your Setup
+3. **Run the server:**
+   ```bash
+   npm start
+   ```
 
-1. **Create test documentation:**
+4. **Run tests:**
    ```bash
-   mkdir docbot
-   echo '{"name": "Test Docs", "globalRules": ["test.md"]}' > docbot/manifest.json
-   echo "# Test Document\nThis is a test." > docbot/test.md
+   npm test
    ```
 
-2. **Run the server:**
+5. **Run with file watching:**
    ```bash
-   npx docbot --verbose
+   npm start -- --watch
    ```
 
-3. **Test with Claude Code:**
-   - Ask: "What documentation is available?"
-   - Try: "Show me the global rules"
+### Testing your setup
 
-## 🤝 Contributing
+Ask your AI assistant something like "What documentation is available?" to test that doc-bot is working.
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+### CLI Options
 
-### Development Setup
 ```bash
-# Clone the repository
-git clone https://github.com/yourusername/docbot.git
-cd docbot
-
-# Install dependencies
-npm install
+doc-bot [options]
 
-# Run tests
-npm test
-
-# Run in development mode
-npm run dev
+Options:
+  -d, --docs <path>        Path to docs folder (required)
+  -c, --config <path>      Path to manifest file (default: <docs-path>/manifest.json)
+  -p, --port <port>        Port to run server on (default: 3000)
+  -v, --verbose           Enable verbose logging
+  -w, --watch             Watch for file changes
+  -h, --help              Show help
 ```
 
-## 📄 License
+## License
 
 MIT License - see the [LICENSE](LICENSE) file for details.
 
-## 🙏 Acknowledgments
-
-- Built on the [Model Context Protocol](https://github.com/modelcontextprotocol/specification)
-- Inspired by the need for intelligent, context-aware documentation
-- Thanks to the Claude Code and Cursor teams for MCP support
-
-## 🔗 Links
-
-- [npm package](https://www.npmjs.com/package/docbot)
-- [GitHub repository](https://github.com/yourusername/docbot)
-- [Model Context Protocol](https://github.com/modelcontextprotocol/specification)
-- [Claude Code documentation](https://docs.anthropic.com/claude/docs/claude-code)
-
----
+## Links
 
-**Made with ❤️ for developers who want intelligent documentation at their fingertips.**
+- [npm package](https://www.npmjs.com/package/@afterxleep/doc-bot)
+- [GitHub repository](https://github.com/afterxleep/doc-bot)
+- [Model Context Protocol](https://github.com/modelcontextprotocol/specification)

package/bin/doc-bot.js

@@ -8,10 +8,10 @@ const { DocsServer } = require('../src/index.js');
 program
   .name('doc-bot')
   .description('Generic MCP server for intelligent documentation access')
-  .version('1.0.0')
+  .version('1.0.2')
   .option('-p, --port <port>', 'Port to run server on', '3000')
-  .option('-d, --docs <path>', 'Path to docs folder', './docs.ai')
-  .option('-c, --config <path>', 'Path to manifest file', './docs.ai/manifest.json')
+  .requiredOption('-d, --docs <path>', 'Path to docs folder')
+  .option('-c, --config <path>', 'Path to manifest file')
   .option('-v, --verbose', 'Enable verbose logging')
   .option('-w, --watch', 'Watch for file changes')
   .parse();
@@ -20,19 +20,19 @@ const options = program.opts();
 
 async function main() {
   const docsPath = path.resolve(options.docs);
-  const configPath = path.resolve(options.config);
+  const configPath = options.config ? path.resolve(options.config) : path.resolve(options.docs, 'manifest.json');
   
-  // Check if docs.ai folder exists
+  // Check if documentation folder exists
   if (!await fs.pathExists(docsPath)) {
     console.error(`❌ Documentation folder not found: ${docsPath}`);
     console.log('');
-    console.log('📖 To get started, create a docs.ai folder in your project:');
+    console.log('📖 To get started, create your documentation folder:');
     console.log('');
-    console.log('  mkdir docs.ai');
-    console.log('  echo \'{"name": "My Project Documentation", "globalRules": []}\' > docs.ai/manifest.json');
-    console.log('  echo "# Getting Started" > docs.ai/README.md');
+    console.log(`  mkdir ${path.basename(docsPath)}`);
+    console.log(`  echo '{"name": "My Project Documentation", "globalRules": []}' > ${path.basename(docsPath)}/manifest.json`);
+    console.log(`  echo "# Getting Started" > ${path.basename(docsPath)}/README.md`);
     console.log('');
-    console.log('Then run: npx doc-bot');
+    console.log('Then configure your MCP client to use this folder.');
     process.exit(1);
   }
   

package/package.json

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