MCP 服务器 (语言服务器协议)

一个基于 TypeScript 的语言服务器协议实现，用于代码引用搜索，支持多种搜索策略。

特性

• 🔍 使用 ripgrep 快速代码引用搜索
• 🌐 网页界面，方便搜索
• 💻 终端界面，用于命令行使用
• 📊 按文件类型分组结果
• 🔄 备用搜索机制
• 🔥 热重载支持开发

前提条件

开始之前，请确保已安装以下软件：

• Node.js (v14 或更高版本)
• npm (随 Node.js 一起提供)
• Homebrew (适用于 macOS 用户)
• ripgrep (推荐，用于更快的搜索)

安装

1. 克隆仓库

git clone <你的仓库 URL>
cd <仓库名称>/src/mcp-server/v1

2. 安装 Homebrew (仅 macOS)

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

# 将 Homebrew 添加到 PATH (按照安装后显示的说明操作)
# 通常是这些命令：
(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

# 重启你的终端或运行
source ~/.zprofile

3. 安装 ripgrep

# macOS (使用 Homebrew)
brew install ripgrep

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

# Fedora
sudo dnf install ripgrep

# Windows (使用 Chocolatey)
choco install ripgrep

4. 安装依赖

npm install

使用

构建项目

npm run build

启动服务器

生产模式

npm run start

开发模式 (带热重载)

npm run dev

访问界面

1. 网页界面

   • 打开你的浏览器并导航到：http://localhost:3000
   • 输入你的搜索词和目录
   • 查看按文件类型分组的结果

2. 终端界面

   • 终端界面随服务器自动启动
   • 按照提示输入搜索词
   • 结果将显示在终端中

搜索策略

服务器使用以下顺序的多种搜索策略：

1. ripgrep (最快)

   • 使用正则表达式进行精确和部分匹配
   • 排除常用目录 (node_modules, .git, 等)
   • 提供行号和上下文

2. grep (备用)

   • 如果 ripgrep 不可用，则使用
   • 类似的功能，但速度较慢

3. Node.js (最终备用)

   • 纯 JavaScript 实现
   • 如果 ripgrep 和 grep 均不可用，则使用

配置

环境要求

• 服务器自动检查所需的软件
• 如果缺少任何内容，则提供安装说明
• 验证正确的工作目录

TypeScript 配置

• Target: ES2020
• Module: CommonJS
• 启用严格类型检查
• 生成用于调试的源映射

故障排除

常见问题

1. 错误的目录

   • 确保你在 src/mcp-server/v1 目录中
   • 检查环境检查中显示的路径

2. Homebrew 安装

   • 如果 Homebrew 命令失败，请确保已配置 PATH
   • 检查 ~/.zprofile 中的 Homebrew 配置

3. 找不到 ripgrep

   • 验证 Homebrew 是否已安装并在 PATH 中
   • 尝试重新安装：brew reinstall ripgrep

4. 端口已被使用

   • 服务器将自动找到一个可用的端口
   • 默认端口是 3000

错误消息

如果你看到这些错误，请尝试以下操作：

1. command not found: brew

   • 重新安装 Homebrew
   • 重新配置 PATH

2. command not found: rg

   • 安装 ripgrep: brew install ripgrep
   • 验证 PATH 配置

3. EADDRINUSE

   • 端口正在使用中
   • 服务器将自动尝试另一个端口

开发

可用脚本

• npm run build: 构建项目
• npm run start: 在生产模式下启动
• npm run dev: 使用热重载启动
• npm run clean: 清理构建输出

添加新功能

1. 修改 server.ts 以实现核心功能
2. 更新 index.html 以进行网页界面更改
3. 在开发模式下运行以测试更改
4. 构建并重新启动以应用