mcp-ragex

jbenshetler/mcp-ragex

3.4

If you are the rightful owner of mcp-ragex and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

RAGex MCP Server is a secure, intelligent server for Claude and AI assistants, providing advanced code search capabilities.

RAGex - AI-Powered Code Search for Claude

Stop creating duplicate code. Give Claude semantic search superpowers to find and reuse existing patterns in your codebase.

TL;DR - Quick Installation & Setup

Install:

curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash

Setup:

cd your-project
ragex start                    # Index your codebase (1-5 minutes)
ragex register claude | sh     # Connect to Claude Code

Test:

ragex search "auth functions"     # Semantic search
ragex search "async def" --regex   # Pattern search

What you get: Claude Code can now semantically understand your entire codebase, find existing patterns, and reuse code instead of duplicating it. Works with both semantic search ("find authentication logic") and fast regex patterns ("async def.*test").

Table of Contents

๐Ÿšจ The Problem

Claude Code can't find existing code in your project, leading to:

  • โŒ Duplicate functions - "I'll create a new authentication system..." (when one exists)
  • โŒ Missed patterns - Ignores your coding conventions and best practices
  • โŒ Inefficient workflow - You resort to manual grep/search to guide Claude

โœจ The Solution

RAGex gives Claude semantic understanding of your entire codebase:

  • ๐Ÿ” Semantic search - "Find auth functions" โ†’ discovers UserValidator, loginHandler, AuthMiddleware
  • โšก Lightning fast - Sub-second search across thousands of files using ripgrep + vector embeddings
  • ๐Ÿง  Context aware - Understands code relationships, not just text matching
  • ๐Ÿ›ก๏ธ Secure & private - Runs locally in Docker, no code leaves your machine

Features

๐Ÿ” Intelligent Search Modes

  • Auto-detection: Automatically chooses the best search mode based on query patterns
  • Regex mode: Fast pattern matching with ripgrep for exact patterns
  • Semantic mode: Natural language search using sentence-transformers embeddings

๐Ÿš€ Performance & Security

  • Fast code search using ripgrep with regex support
  • Security-first design with input validation and path restrictions
  • File type filtering supporting 30+ programming languages
  • Enhanced file exclusions with multi-level .rgignore support and comprehensive defaults
  • Configurable limits to prevent resource exhaustion
  • JSON-RPC interface following MCP standards

๐Ÿง  AI-Powered Features

  • Semantic code search using sentence-transformers embeddings
  • Query enhancement with abbreviation expansion and context addition
  • Intelligent fallback when primary search mode fails
  • Teaching system that guides Claude Code to optimal search usage

๐Ÿš€ Quick Start

One-Line Install

curl -sSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/main/install.sh | bash

What happens:

  • โœ… Auto-detects your platform (AMD64/ARM64/CUDA)
  • โœ… Pulls optimized Docker image (~3GiB/2GiB/13GB)
  • โœ… Installs ragex CLI to ~/.local/bin
  • โœ… Creates isolated user data volume
๐Ÿ“‹ Installation Options & Details

Installation with Options

# Enable network access + better model (recommended)
curl -sSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/main/install.sh | bash -s -- --network --model balanced

# Force CPU version (smaller download)
curl -sSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/main/install.sh | bash -s -- --cpu --network

# Force CUDA (NVIDIA GPU)
curl -sSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/main/install.sh | bash -s -- --cuda --model accurate

Platform Auto-Detection

The CUDA model image is substantially (8X) faster at indexing, with no performance difference for queries.

PlatformAuto-SelectedImage Size
AMD64 + NVIDIA GPUCUDA~13GB
AMD64 (no GPU)CPU~3GB
ARM64 (Apple Silicon)CPU~2GB

Security Modes

  • Default (Secure): No network access, only pre-bundled models
  • Network Enabled: Can download additional models (--network flag)

Embedding Models

The fast model is generally good enough for Python and JavaScript because code is first parsed with tree-sitter.

ModelSizeQualitySpeedUse Case
fast90MBGoodFastestDefault, Recommended for most users
balanced435MBBetterFastImprovement for more complex code bases
accurate1.3GBBestSlowerLarge codebases
multilingual435MBGoodFastMulti-language projects

Manual Installation

If you prefer to inspect the script first:

curl -sSL https://get.ragex.dev -o install.sh
cat install.sh  # Review the script
bash install.sh --network --model balanced

Your First Project

cd your-project
ragex start                    # Index codebase (1-5 minutes)
ragex register claude | sh     # Connect to Claude Code

Test It Works

# Test semantic search
ragex search "auth functions"     # Finds authentication code
ragex search "error handling"     # Finds error handling patterns
ragex search "database queries"   # Finds DB-related code

# Test regex search  
ragex search "async def" --regex   # Find async functions
ragex search "TODO|FIXME" --regex  # Find code comments

๐Ÿ“น Video Demos

Note: Video demonstrations will be added soon using asciinema/term-svg captures showing real-world usage scenarios.

๐ŸŽฏ What You Get

Before RAGex

You: "Add user authentication to this Express app"
Claude: "I'll create a comprehensive authentication system..."
        [Creates 200 lines of new auth code]
        [Duplicates existing middleware patterns]
        [Ignores your error handling conventions]

After RAGex

You: "Add user authentication to this Express app"
Claude: "I found your existing auth middleware at middleware/auth.js:15
         and your user model at models/User.js:8. Let me extend these
         patterns to add the authentication you need..."
        [Reuses existing patterns]
        [Follows your conventions]
        [Builds on your architecture]

Semantic Search Magic

Your QueryRAGex FindsWhy It's Smart
"auth functions"validateToken(), loginUser(), AuthMiddlewareUnderstands authentication concepts
"database queries"getUserById(), saveToRedis(), queryBuilderRecognizes data access patterns
"error handling"try/catch blocks, errorMiddleware, logError()Groups error-related code
"file upload"multer config, uploadToS3(), validateFile()Connects upload-related logic

๐Ÿ“– Complete Examples

Project Isolation

Each project gets its own semantic index:

# Work project with accurate model
cd ~/work/api-server
ragex start --model accurate
# โ†’ Creates: ragex_1000_a1b2c3d4ef567890

# Personal project with fast model  
cd ~/personal/blog
ragex start --model fast
# โ†’ Creates: ragex_1000_f9e8d7c6b5a43210

ragex ls -l
# PROJECT          ID                         MODEL     INDEXED   PATH
# api-server       ragex_1000_a1b2c3d4ef567890 accurate  yes      ~/work/api-server
# blog             ragex_1000_f9e8d7c6b5a43210 fast      yes      ~/personal/blog

Advanced Search Patterns

# Semantic search (natural language)
ragex search "functions that validate user input"
ragex search "code that handles file uploads"
ragex search "database connection error handling"
ragex search "JWT token verification logic"

# Regex search (exact patterns)
ragex search "async def.*test" --regex    # Async test functions
ragex search "app\.get\(.*api" --regex      # Express API routes
ragex search "interface.*Props" --regex    # TypeScript interfaces

# Search with limits and JSON output
ragex search "auth" --limit 10 --json     # Top 10 results as JSON

Project Management

# List and inspect projects
ragex ls                         # Show all your projects
ragex ls -l                      # Detailed view with models/status
ragex ls "api-*"                 # Filter projects by pattern
ragex info                       # Current project details

# Clean up old projects
ragex rm "old-project-*"         # Remove projects matching pattern
ragex rm ragex_1000_abc123       # Remove by specific ID

# Configuration
ragex configure                  # Show current config
ragex configure --cpu            # Switch to CPU mode
ragex configure --cuda           # Switch to CUDA mode

๐Ÿ”ง CLAUDE.md Setup

Add this to your project's CLAUDE.md file to optimize Claude Code's search behavior:

# Code Search Guidelines

**IMPORTANT: This project has RAGex MCP enabled for intelligent code search.**

## Search Strategy (Priority Order)

1. **FIRST: Use RAGex MCP tools** - Semantic understanding of your codebase
   - `search_code()` with semantic mode for concepts: "auth functions", "error handling"
   - `search_code()` with regex mode for patterns: "async def.*test", "TODO|FIXME"
   - `search_code_simple()` for quick searches with auto-detection

2. **FALLBACK: Use built-in search tools** - Only if RAGex fails or is unavailable
   - `Grep` for text patterns
   - `Glob` for file discovery

## RAGex Search Modes

RAGex automatically detects the best search mode:

- **Semantic Mode**: Natural language queries
  - `"functions that handle user authentication"`
  - `"error handling for database connections"`
  - `"code that validates JWT tokens"`

- **Regex Mode**: Pattern matching (use `--regex` or detected automatically)
  - `"async def.*test"` โ†’ finds async test functions
  - `"app\.get\(.*api"` โ†’ finds Express API routes
  - `"interface.*Props"` โ†’ finds TypeScript interfaces

- **Symbol Mode**: Exact names (detected automatically)
  - `"UserService"` โ†’ finds UserService class
  - `"validateInput"` โ†’ finds validateInput function

## Effective Query Examples

```bash
# Semantic search (recommended)
search_code("user authentication and session management")
search_code("database connection error handling")
search_code("file upload processing logic")
search_code("JWT token validation functions")

# Regex patterns for exact matching
search_code("async def.*test", mode="regex")
search_code("TODO|FIXME", mode="regex")
search_code("interface.*Props", mode="regex")

# Simple interface (auto-detects everything)
search_code_simple("auth middleware")
search_code_simple("error handlers")

When RAGex Finds Existing Code

  1. ANALYZE the patterns before writing new code
  2. EXTEND existing functions rather than duplicating logic
  3. FOLLOW established architecture and naming conventions
  4. REUSE utility functions, middleware, and helpers
  5. UNDERSTAND the codebase structure and relationships

Search Tips

  • Be specific with domain terms: "JWT", "middleware", "validation", "serialization"
  • Use natural language for concepts, patterns for exact matches
  • RAGex understands code relationships, not just text matching
  • Results include file paths and line numbers for easy navigation
  • Try different phrasings if first search doesn't find what you need

Benefits

  • Faster development: Reuse existing patterns instead of recreating
  • Consistent architecture: Follow established project conventions
  • Better code discovery: Find forgotten utilities and helpers
  • Reduced duplication: Stop reinventing the wheel

**Why this helps:**
- Prioritizes RAGex MCP tools over built-in search
- Provides concrete examples for different search modes
- Guides Claude toward code reuse and architectural consistency
- Sets clear expectations for search capabilities and workflow

## ๐Ÿ“‹ Installation Details

<details>
<summary>Click to expand full installation guide from doc/installation-guide.md</summary>

### Quick Start (One-Line Installation)

#### Basic Installation (Auto-Detection)
```bash
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash

This will:

  • Auto-detect your platform (AMD64, ARM64, or CUDA)
  • Install with secure defaults (no network access for containers)
  • Use the pre-bundled fast embedding model
Installation with Options
# Install with network access enabled and balanced model as default
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash -s -- --network --model balanced

# Force CPU version (smaller image) with network access
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash -s -- --cpu --network --model accurate

# Force CUDA version (requires NVIDIA GPU)
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash -s -- --cuda --model balanced

Installation Parameters

Platform Selection
  • Auto-detection (default): Automatically detects platform and CUDA support
  • --cpu: Force CPU-only version (works on AMD64 and ARM64)
  • --cuda: Force CUDA version (AMD64 only, requires NVIDIA GPU + nvidia-docker)
Network Configuration
  • No flag (default): Secure mode - containers run without network access
  • --network: Enable network access for containers (allows downloading additional models)
Default Embedding Model
  • No flag (default): Uses 'fast' model (pre-bundled in all images)
  • --model <name>: Sets default model for new projects
    • Valid options: fast, balanced, accurate, multilingual

Docker Image Sizes

PlatformImage SizeUse Case
AMD64 CPU~3.2 GiBGeneral use, smaller download
ARM64 CPU~2.2 GiBApple Silicon Macs, ARM servers
CUDA~13.1 GiBNVIDIA GPU acceleration

Embedding Models

ModelSizeSpeedQualityUse Case
fast~90 MBFastestGoodQuick prototyping, smaller codebases
balanced~435 MBModerateBetterProduction use, balanced performance
accurate~1.3 GBSlowerBestLarge codebases, maximum quality
multilingual~435 MBModerateGoodMulti-language projects

Security Modes

Secure Mode (Default)
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash
  • Containers run with --network none
  • No external network access from containers
  • Only pre-bundled fast model available
  • Suitable for air-gapped environments
Network-Enabled Mode
curl -fsSL https://raw.githubusercontent.com/jbenshetler/mcp-ragex/refs/heads/main/install.sh | bash -s -- --network
  • Containers can access external networks
  • Can download additional embedding models on demand
  • Required for using balanced, accurate, or multilingual models

Post-Installation

Verify Installation
ragex --help
ragex info
Quick Start
cd your-project
ragex index .          # Index current directory
ragex search "query"   # Search your code
Configuration
ragex configure        # Show current configuration
ragex ls              # List indexed projects

Troubleshooting

Docker Not Found
โŒ Docker not found. Please install Docker first.

Solution: Install Docker from https://docs.docker.com/get-docker/

Docker Daemon Not Running
โŒ Docker daemon not running. Please start Docker.

Solution: Start Docker Desktop or run sudo systemctl start docker

Unsupported Architecture
โŒ Unsupported architecture: s390x

Solution: RAGex currently supports AMD64 and ARM64 only

Integration with Claude Code

After installation, register RAGex with Claude Code:

# Get the registration command
ragex register claude

# Run the output command (example):
claude mcp add ragex ~/.local/bin/ragex-mcp --scope project

This enables RAGex as an MCP server for Claude Code, providing intelligent code search capabilities directly in your Claude conversations.

๐Ÿš€ Advanced Usage

Multiple Projects

# Work on different projects simultaneously
cd ~/work/api-server && ragex start --model accurate
cd ~/personal/blog && ragex start --model fast 
cd ~/opensource/cli-tool && ragex start --model balanced

# Switch between projects automatically
ragex ls                        # See all projects
cd ~/work/api-server           # RAGex automatically uses api-server index
ragex search "authentication"   # Searches only api-server code

Environment Variables

# Customize behavior
export RAGEX_EMBEDDING_MODEL=balanced    # Default model for new projects
export RAGEX_LOG_LEVEL=DEBUG             # Enable debug logging
export RAGEX_DOCKER_IMAGE=custom:tag     # Use custom Docker image

# Log rotation settings
export RAGEX_LOG_MAX_SIZE=100m           # Max log file size
export RAGEX_LOG_MAX_FILES=5             # Number of rotated logs to keep

Development & Debugging

# View logs
ragex log                       # Current project logs
ragex log -f                    # Follow logs in real-time
ragex log --tail 50            # Last 50 lines

# Status and info
ragex status                    # Check daemon status
ragex info                      # Project details
ragex configure                 # Current configuration

# Development mode
ragex bash                      # Get shell inside container
RAGEX_DEBUG=1 ragex start      # Enable debug output

Data Management

# Your data is isolated by user ID
docker volume ls | grep ragex_user_$(id -u)

# Project data structure:
# /data/models/                   # Shared embedding models (90MB-1.3GB)
# /data/projects/ragex_1000_*/    # Individual project indexes
#   โ”œโ”€โ”€ chroma_db/               # Vector database  
#   โ””โ”€โ”€ project_info.json        # Project metadata

# Backup a project
ragex export my-project backup.tar.gz

# Check disk usage
ragex ls -l                     # Shows index sizes

# Clean up old projects
ragex rm "test-*"               # Remove test projects
ragex rm ragex_1000_old123      # Remove specific project

Uninstall

# Complete removal (WARNING: Deletes all indexed data)
# Stop all ragex containers
docker ps -a -f "name=ragex_" -q | xargs -r docker stop
docker ps -a -f "name=ragex_" -q | xargs -r docker rm

# Remove images and volumes
docker images "*ragex*" -q | xargs -r docker rmi
docker volume ls -f "name=ragex_user_" -q | xargs -r docker volume rm

# Remove binaries and config
rm -rf ~/.config/ragex ~/.local/bin/ragex ~/.local/bin/ragex-mcp

# Unregister from Claude Code
claude mcp remove ragex --scope project

โšก Performance & Architecture

๐Ÿ”Œ MCP Communication Through Docker

The MCP protocol uses stdin/stdout for communication. The ragex wrapper script handles this transparently:

# When Claude Code runs:
claude mcp add ragex /home/user/.local/bin/ragex

# It communicates like this:
Claude Code โ†โ†’ ragex script โ†โ†’ Docker container โ†โ†’ MCP Server
           stdin/stdout    stdin/stdout      stdin/stdout

Key points:

  • The ragex script acts as a bridge between Claude Code and the Docker container
  • For MCP server mode, Docker runs with -i (interactive) but NOT -t (no TTY)
  • TTY would break JSON-RPC communication by adding terminal control codes
  • The wrapper preserves stdin/stdout pipes for proper MCP protocol communication

๐Ÿ—๏ธ Container Structure

/app/                     # Application code (read-only)
โ”œโ”€โ”€ src/                  # Source code
โ”œโ”€โ”€ scripts/              # Utility scripts
โ”œโ”€โ”€ requirements.txt      # Python dependencies
โ””โ”€โ”€ entrypoint.sh        # Container entrypoint

/data/                    # User-specific persistent data (volume)
โ”œโ”€โ”€ models/              # Shared embedding models (400MB-1.3GB)
โ””โ”€โ”€ projects/            # Project-specific data
    โ”œโ”€โ”€ ragex_1000_abc123/  # Project 1
    โ”‚   โ”œโ”€โ”€ chroma_db/      # ChromaDB vector database  
    โ”‚   โ””โ”€โ”€ project_info.json # Project metadata
    โ””โ”€โ”€ ragex_1000_def456/  # Project 2
        โ”œโ”€โ”€ chroma_db/
        โ””โ”€โ”€ project_info.json

/workspace/              # Your code (volume, read-only)
โ””โ”€โ”€ [current project]    # Code to be indexed

๐Ÿ”ง Environment Variables

Docker containers support these environment variables:

# Project identification (automatically set by wrapper)
WORKSPACE_PATH=/path/to/your/project    # Workspace being indexed
PROJECT_NAME=ragex_1000_abc123          # Generated project ID

# Data directories (automatically configured)
RAGEX_PROJECT_DATA_DIR=/data/projects/ragex_1000_abc123  # Project data
RAGEX_CHROMA_PERSIST_DIR=/data/projects/ragex_1000_abc123/chroma_db  # ChromaDB
TRANSFORMERS_CACHE=/data/models         # Shared model cache
SENTENCE_TRANSFORMERS_HOME=/data/models # Sentence transformers cache

# User configuration
RAGEX_EMBEDDING_MODEL=fast              # Model preset (fast/balanced/accurate)
RAGEX_CHROMA_COLLECTION=code_embeddings # Collection name

# System configuration
RAGEX_LOG_LEVEL=INFO                    # Log level (DEBUG, INFO, WARN, ERROR) - default: INFO
LOG_LEVEL=INFO                          # Fallback log level (RAGEX_LOG_LEVEL takes precedence)
DOCKER_CONTAINER=true                   # Indicates running in container

๐Ÿณ Production Deployment

Use the production Docker Compose for deployment:

# Production setup with resource limits
docker compose -f docker-compose.prod.yml up -d

# Check status
docker compose -f docker-compose.prod.yml ps

# View logs
docker compose -f docker-compose.prod.yml logs ragex

Integration

๐Ÿ–ฅ๏ธ Claude Code (CLI)

Docker Integration (Recommended)

Register the Docker-based MCP server:

cd /path/to/your/project
claude mcp add ragex /path/to/mcp-ragex/ragex --scope project

The ragex script automatically handles Docker execution and volume mounting.

Manual Integration

For manual/development setups:

# Option 1: Using wrapper script
claude mcp add ragex /path/to/mcp-ragex/mcp_ragex.sh --scope project

# Option 2: Direct Python command
claude mcp add ragex uv run /path/to/mcp-ragex/src/server.py --scope project

๐Ÿ–ฑ๏ธ Claude Desktop (App)

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "ragex": {
      "command": "/path/to/mcp-ragex/ragex",
      "env": {
        "RAGEX_DATA_DIR": "/path/to/persistent/data"
      }
    }
  }
}

โœ… Verifying MCP Connection

After configuration, verify the MCP server is connected:

# In Claude Code, use the /mcp command
/mcp

This will show the status of all configured MCP servers. You should see ragex in the list.

Usage Examples

Example Semantic Search

This is what happened in the CLI:

โ— Let me try a broader semantic search:

โ— Let me search for admin endpoints:
 โŽฟ  Interrupted by user

> /exit
 โŽฟ  (no content)

> Try the ragex semantic search again.

โ— Task(Search for reindex endpoints)
 โŽฟ  Done (8 tool uses ยท 79.3k tokens ยท 1m 32.2s)

โ— Based on the search results, I found the department reindexing endpoints. The main force reindex endpoint is:

 POST /admin/reindex/department in /docprocessor/workflows_api.py (line 834)

And this is what the Ctrl-R logs show:

โ— I'll search for the function that adds documents to OpenSearch and check the field structure, then verify all 11 documents have extracted text.

โ— Task(Task: Find OpenSearch indexing function

   Prompt: Search for the function that indexes documents to OpenSearch. Look for:
   1. Functions that create or update documents in OpenSearch
   2. The field names used when indexing, particularly for extracted text
   3. Index operations, PUT or POST requests to OpenSearch
   4. Document structure being sent to OpenSearch

   Use search terms like:
   - opensearch index document
   - _doc PUT POST
   - index_document
   - create_document
   - extracted_text content text)
 โŽฟ  Search(pattern: "index.*document|create.*document|update.*document", path: "undefined")
      โŽฟ  Found 55 files
         /home/jeff/clients/search/contextsearch/tests/ui/README.md
         /home/jeff/clients/search/contextsearch/tests/ocr/output_metadata.json
         /home/jeff/clients/search/contextsearch/tests/ocr/output_rmeta_fixed.json
         /home/jeff/clients/search/contextsearch/tests/needs_porting/test_workflow_implementation.py
         /home/jeff/clients/search/contextsearch/tests/obsolete/test_workflow_celery_integration.py
         /home/jeff/clients/search/contextsearch/tests/obsolete/test_workflow_integration.py
         /home/jeff/clients/search/contextsearch/tests/docprocessor/test_workflows_real_files.py
         /home/jeff/clients/search/contextsearch/tests/functional/cache/test_cache_repopulation.py
         /home/jeff/clients/search/contextsearch/tests/functional/cache/test_comprehensive_cache_validation.py
         /home/jeff/clients/search/contextsearch/tests/functional/integration/filesystem_scanner.py
         /home/jeff/clients/search/contextsearch/tests/functional/nlp/test_batch_size_one.py
         /home/jeff/clients/search/contextsearch/tests/functional/search/test_date_filtering.py
         /home/jeff/clients/search/contextsearch/tests/functional/search/test_entity_filtering.py
         /home/jeff/clients/search/contextsearch/tests/functional/search/test_force_reindexing.py
         /home/jeff/clients/search/contextsearch/samples/simulate_tasks.py

๐Ÿ” Intelligent Search Modes

Auto-Detection (Recommended)
# Claude Code automatically detects the best search mode
search_code("DatabaseConnection")              # โ†’ symbol mode
search_code("functions that handle auth")      # โ†’ semantic mode  
search_code("error.*Exception")                # โ†’ regex mode
Explicit Mode Selection
# Symbol search - when you know exact names
search_code("AuthenticationService")

# Semantic search - when you know the concept
search_code("functions that validate user input", mode="semantic")

# Regex search - when you know the pattern
search_code("handleError.*Exception", mode="regex")

๐Ÿง  Semantic Search Examples

# Find authentication-related code
search_code("functions that handle user authentication")

# Find error handling patterns
search_code("error handling for database connections")

# Find file processing code
search_code("code that processes uploaded files")

# Find validation logic
search_code("functions that validate user input")

๐Ÿ“‹ Symbol Search Examples

# Find specific classes
search_code("UserService")

# Find specific functions
search_code("validateInput")

# Find methods
search_code("submitToQueue")

๐Ÿ”ง Regex Search Examples

# Find async functions
search_code("async def", mode="regex")

# Find TODO comments
search_code("TODO|FIXME", mode="regex")

# Find error handling blocks
search_code("try.*except", mode="regex")

๐Ÿ›  Advanced Features

Capability Discovery
# Check available search modes
get_search_capabilities()
Simple Search Interface
# Just search - auto-detects everything
search_code_simple("database connection error")
Raw Output Format
search_code("submit_file", format="raw")

Returns simple file:line format for programmatic use.

๐Ÿ“ File Type and Path Filtering

# Search only Python files
search_code("class.*User", file_types=["py"])

# Search specific directories
search_code("test_", paths=["tests", "src/tests"])

# Combine filters
search_code("async def", file_types=["py"], paths=["src"])

Logging and Debugging

Setting Log Levels

RAGex uses RAGEX_LOG_LEVEL to control logging verbosity. The default is INFO.

# Set log level before starting daemon
export RAGEX_LOG_LEVEL=DEBUG
ragex start

# Or set for a single command
RAGEX_LOG_LEVEL=DEBUG ragex start

# For very verbose debugging (generates lots of output)
RAGEX_LOG_LEVEL=TRACE ragex start

Available Log Levels:

  • TRACE: Very detailed debugging (ignore decisions, file system operations)
  • DEBUG: Detailed debugging info (file processing, embeddings, scores)
  • INFO: General operation info (search queries, index progress) - default
  • WARN: Warnings and potential issues only
  • ERROR: Error messages only

Important: The log level is set when the daemon starts and cannot be changed without restarting:

# To change log level after daemon is running:
ragex stop
RAGEX_LOG_LEVEL=DEBUG ragex start

Viewing Logs

# View daemon logs for current project
ragex log

# Follow logs in real-time
ragex log -f

# View last 50 lines
ragex log --tail 50

# View logs for specific project
ragex log project-name

# View MCP server logs (when using with Claude)
tail -f /tmp/ragex-mcp.log

Log Rotation and Storage

RAGex automatically manages log file sizes through Docker's log rotation to prevent disk space issues:

Default Log Limits:

  • Daemon logs: 50MB per file, 3 files maximum (150MB total)
  • Admin commands: 10MB per file, 2 files maximum (20MB total)

Customizing Log Rotation:

# Set custom log rotation limits
export RAGEX_LOG_MAX_SIZE=100m      # Maximum size per log file
export RAGEX_LOG_MAX_FILES=5        # Maximum number of log files to keep

# Apply settings when starting daemon
ragex stop
ragex start

# View current log rotation settings
ragex configure

Available Size Units:

  • k or kb: Kilobytes (e.g., 500k)
  • m or mb: Megabytes (e.g., 50m)
  • g or gb: Gigabytes (e.g., 1g)

Log Storage Location:

  • Logs are stored inside Docker containers and managed by Docker's log driver
  • Use ragex log to view logs (automatic log rotation is handled transparently)
  • Old log files are automatically deleted when limits are exceeded

Performance Metrics

OperationSpeedNotes
Indexing~100 symbols/secIntel i9-7900X, varies by project size
Semantic Search<100ms1000+ symbols, cached embeddings
Regex Search<50msPowered by ripgrep, sub-second for large codebases
Project SwitchingInstantAutomatic workspace detection

Real-World Timing

  • Small projects (1k-10k LOC): 70 seconds initial indexing
  • Medium projects (10k-100k LOC): 130 seconds initial indexing
  • Large projects (100k+ LOC): 5+ minutes initial indexing
  • Subsequent searches: Sub-second response times

Docker Resource Usage

ComponentMemoryCPUStorage
Base container~100MBLow~3-13GB (varies by image)
During indexing~500MB peakHighTemporary spike
During search~300MBLowPersistent
ChromaDB index~50MBN/A~1MB per 1000 symbols

Security & Privacy

๐Ÿ”’ Enterprise-Ready Security:

  • โœ… Air-gapped mode - No network access required (secure default)
  • โœ… Local processing - Code never leaves your machine
  • โœ… Input validation - All queries sanitized and validated
  • โœ… Path restrictions - Searches confined to project directories
  • โœ… Resource limits - Protection against resource exhaustion
  • โœ… No shell execution - Direct subprocess calls only

Architecture Overview

graph TD
    A[Claude Code] -->|MCP Protocol| B[RAGex Server]
    B --> C[Query Router]
    C -->|Semantic Queries| D[Vector Search]
    C -->|Regex Patterns| E[Ripgrep Search]
    C -->|Symbol Names| F[Tree-sitter Search]
    
    D --> G[ChromaDB]
    D --> H[Sentence Transformers]
    E --> I[ripgrep]
    F --> J[Tree-sitter AST]
    
    K[Docker Container] --> L[Project Isolation]
    L --> M[User Volume]
    M --> N[Project 1 Index]
    M --> O[Project 2 Index]
    M --> P[Shared Models]

Key Components:

  • ๐Ÿง  Vector Search: Semantic understanding via sentence-transformers + ChromaDB
  • โšก Regex Search: Lightning-fast pattern matching with ripgrep
  • ๐ŸŒณ AST Parsing: Code structure analysis with Tree-sitter
  • ๐Ÿณ Docker Isolation: Secure, reproducible environment per user
  • ๐Ÿ“ Project Separation: SHA256-based unique project identification

Search Intelligence

flowchart LR
    A[User Query] --> B{Query Analysis}
    B -->|"auth login"| C[Semantic Mode]
    B -->|"async def.*"| D[Regex Mode] 
    B -->|"handleSubmit"| E[Symbol Mode]
    
    C --> F[Vector Similarity]
    D --> G[Pattern Matching]
    E --> H[AST Analysis]
    
    F --> I{Results Found?}
    G --> I
    H --> I
    
    I -->|Yes| J[Return Results]
    I -->|No| K[Try Fallback Mode]
    K --> J

Smart Features:

  1. ๐ŸŽฏ Auto-detection - Analyzes query patterns to choose optimal search mode
  2. ๐Ÿ”„ Intelligent fallback - Tries alternative modes if primary search fails
  3. ๐Ÿ“Š Result ranking - Semantic relevance scoring for better matches
  4. ๐Ÿ’ก Query enhancement - Expands abbreviations and adds context
  5. ๐ŸŽ“ Learning system - Guides Claude Code to optimal usage patterns

Supported Languages

FeatureSupported Languages
Regex SearchAll file types (universal)
Semantic SearchPython, JavaScript, TypeScript, JSX, TSX, C/C++, HTML, CSS
Symbol ExtractionPython, JavaScript, TypeScript (Tree-sitter AST parsing)
Planned SupportGo, Rust, Java, C#, PHP, Ruby

File Type Detection

  • Automatic: Based on file extensions
  • Configurable: Via .gitignore patterns
  • Smart Exclusions: Skips binaries, generated files, dependencies

Smart File Exclusions

๐ŸŽฏ Comprehensive Defaults (automatically applied):

# Dependencies
node_modules/, .venv/, __pycache__/, vendor/

# Build artifacts  
build/, dist/, target/, .next/, .nuxt/

# IDE files
.vscode/, .idea/, *.swp, .DS_Store

# Logs and temp
*.log, .tmp/, .cache/

# Media files
*.jpg, *.png, *.mp4, *.zip, *.pdf

โš™๏ธ Customizable per Project:

  • Uses standard .gitignore syntax
  • Multi-level support (project/directory/subdirectory)
  • Respects existing .gitignore files
  • ragex init creates comprehensive .gitignore template

๐ŸŒŸ Why RAGex?

The RAGex Advantage

Traditional ToolsRAGex
๐Ÿ˜ซ Text-only search๐Ÿง  Semantic understanding
๐Ÿ“ Manual copy-paste workflow๐Ÿ”„ Intelligent code reuse
๐ŸŒ Grep through everythingโšก Vector-powered speed
๐Ÿ” Find exact matches only๐ŸŽฏ Conceptual similarity
๐Ÿ˜ฐ "Did I check all files?"โœ… Comprehensive indexing
๐Ÿšซ Works against Claude๐Ÿค Enhances Claude's abilities

Success Stories

Before RAGex:

"Claude, add authentication to this Express app" โ†’ Creates duplicate middleware (200+ lines) โ†’ Ignores existing user models
โ†’ Breaks established patterns

After RAGex:

"Claude, add authentication to this Express app" โ†’ Finds existing auth.middleware.js:15 โ†’ Extends current User model
โ†’ Follows project conventions โ†’ 90% less code, 100% more consistency

Enterprise Benefits

  • ๐Ÿ“ˆ Faster development - Reuse > Rewrite
  • ๐ŸŽฏ Consistent patterns - Claude follows your architecture
  • ๐Ÿ” Better code discovery - Find forgotten utilities and helpers
  • ๐Ÿงน Reduced duplication - Stop reinventing the wheel
  • ๐Ÿ“š Knowledge preservation - Your codebase becomes searchable documentation

๐Ÿค Contributing & Support

Getting Help

Development

# Get the code
git clone https://github.com/jbenshetler/mcp-ragex.git
cd mcp-ragex

# Local development setup
make install-cpu && ragex start

# Run tests
uv run tests/test_server.py
pytest tests/

# Build documentation
make docs

Roadmap

  • ๐Ÿš€ Multi-language support - Go, Rust, Java, C#
  • ๐Ÿ” Hybrid search - Combine semantic + keyword results
  • ๐Ÿ“ฑ IDE extensions - VS Code, JetBrains, Vim
  • ๐ŸŒ Cloud deployment - Kubernetes, AWS, GCP
  • ๐Ÿง  Custom embeddings - Fine-tune models for your domain

โญ Star us on GitHub | ๐Ÿณ Docker Hub | ๐Ÿ“ฆ GitHub Packages

Made with โค๏ธ for developers who believe in smart code reuse