codexray

CodeXRay CodexRay MCP server exposes a local, zero-config tool to access the CodeXRay semantic knowledge graph and 16 MCP tools for code intelligence. Once launched via npx codexray, you gain interactive access to the CodeXRay suite and can perform project-wide symbol queries, semantic searches, call graph explorations, and more without sending code to the cloud. Use the 16 MCP tools to quickly overview a project, drill into specific symbols, inspect dependencies, and analyze code hotspots. The server is designed to run locally on your machine, keeps data private, and indexes your codebase to provide fast, TF-IDF and graph-based search results for developers and AI agents alike. The provided CLI and MCP tools let you perform both exact name-based lookups and meaning-based searches, enabling you to locate and understand code paths, relationships, and potential issues efficiently.

Prerequisites:

• Node.js 18–24 installed on your machine
• npm or pnpm or yarn installed
• A supported shell (bash/zsh on macOS/Linux, PowerShell/cmd on Windows)

1. Install Node.js if you don’t have it:

• macOS/Linux via NodeSource (example): curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - sudo apt-get install -y nodejs

• Windows: download and install from https://nodejs.org/

2. Install CodeXRay globally via npm (recommended for MCP usage):

npm install -g codexray

3. Run the MCP server using npx (no local install required per Quick Start):

npx codexray

4. If you prefer a fully local install (without npx each time), you can install npm package globally and run it:

npm install -g codexray
codexray start

5. Optional: verify installation

codexray --version

Prerequisites recap:

• Node.js 18–24
• npm/pnpm/yarn for package management
• Basic shell access to run commands

Tips and common issues:

• The MCP server runs locally; no API keys are required. Ensure your firewall allows local network traffic if you’re integrating with external tools.
• When using npx, the first run will fetch the codexray package; this may take a moment on slow connections.
• If you encounter permission errors on macOS/Linux, consider using sudo for the global installation commands or adjust npm permissions.
• The 16 MCP tools include overview, context, search, semantic search, and various exploration and analysis tools. Use codexray serve to start the interactive server interface if you prefer a GUI/interactive flow.
• Data privacy: by default, CodeXRay indexes your project locally; ensure your project directory is excluded from any cloud-sync services if necessary.
• If indexing large codebases, allocate sufficient CPU/RAM to avoid timeouts during initial indexing.