MCP Server (language Server Protocol)

🚀 MCP Server (Language Server Protocol)

A TypeScript-based implementation of the Language Server Protocol for code reference search, supporting multiple search strategies.

🚀 Quick Start

The MCP Server is a powerful tool for code reference search. It offers multiple search strategies and interfaces for easy use.

✨ Features

• 🔍 Fast code reference search using ripgrep.
• 🌐 A web interface for convenient searching.
• 💻 A terminal interface for command-line use.
• 📊 Results grouped by file type.
• 🔄 Multiple alternative search mechanisms.
• 🔥 Support for hot reloading during development.

📦 Installation

Prerequisites

Before you start, make sure you have the following installed:

• Node.js (v14 or higher)
• npm (comes with Node.js)
• Homebrew (for macOS users only)
• ripgrep (recommended for faster search)

Steps

1. Clone the repository

git clone <your-repository-url>
cd <repository-name>/src/mcp-server/v1

2. Install Homebrew (macOS only)

# Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Add Homebrew to PATH (follow the post-installation instructions)
# Usually these commands:
(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

# Restart the terminal or run
source ~/.zprofile

3. Install ripgrep

# macOS (using Homebrew)
brew install ripgrep

# Ubuntu/Debian
sudo apt-get update && sudo apt-get install ripgrep

# Fedora
sudo dnf install ripgrep

# Windows (using Chocolatey)
choco install ripgrep

4. Install dependencies

npm install

💻 Usage Examples

Build the project

npm run build

Start the server

Production mode

npm run start

Development mode (with hot reloading)

npm run dev

Access the interfaces

Web interface

• Open in your browser: http://localhost:3000
• Enter the search term and directory.
• View the results grouped by file type.

Terminal interface

• The terminal interface starts automatically with the server.
• Follow the prompts to enter the search term.
• The results will be displayed in the terminal.

📚 Documentation

Search Strategies

The server uses multiple search strategies in the following order:

1. ripgrep (Fastest)

   • Uses regular expressions for exact and partial matches.
   • Ignores common directories (node_modules, .git, etc.).
   • Provides line numbers and context.

2. grep (Alternative)

   • Used when ripgrep is not available.
   • Similar functionality but slower.

3. Node.js (Last resort)

   • Pure JavaScript implementation.
   • Used when both ripgrep and grep are unavailable.

Configuration

Environment requirements

• The server automatically checks for required software.
• Provides installation instructions for missing software.
• Validates the correct current directory.

TypeScript configuration

• Target: ES2020
• Module: ESNext
• Out: true
• Format: UTF-8
• Strict mode: Enabled
• Allow undeclared variables: Disabled

🔧 Troubleshooting

Network issues

If you cannot access the network, check your firewall settings or proxy configuration.

Dependency issues

If npm install fails, try running with administrative privileges:

npm install --force

Other issues

For more help, refer to the project documentation or contact the maintainers.