基本能力
产品定位
Greptile MCP Server 是一个中间件服务，专注于提供实时代码搜索和索引功能，适用于开发团队和代码管理场景。
核心功能
- WebSocket 服务器：支持实时通信，包含连接管理和心跳机制。
- 代理管理：创建和管理不同代码仓库的代理实例。
- 代码仓库集成：通过 Greptile API 支持代码仓库的索引。
- 查询处理：处理和验证搜索查询，支持流式结果返回。
- 安全性：通过 API 密钥认证保护 WebSocket 连接。
- 配置管理：基于环境的配置，支持自定义 API 端点。
- 监控：全面的日志系统和性能指标。
- 客户端 SDK：提供 WebSocket 客户端实现，包含连接管理功能。
适用场景
- 开发团队需要实时搜索和索引多个代码仓库的场景。
- 需要流式传输搜索结果以提高开发效率的场景。
- 需要安全、可配置的代码搜索中间件的场景。
工具列表
- WebSocket 客户端：用于与服务器建立实时连接，支持注册代理和发送查询。
- cURL 工具：用于创建和管理代理实例。
- npm 脚本：用于开发、测试和构建项目。
常见问题解答
- 如何设置环境变量？：复制
.env.example到.env并编辑配置。 - 如何启动服务器？：运行
npm start命令。 - 如何测试？：运行
npm test或npm run test:coverage进行测试和覆盖率检查。
使用教程
使用依赖
确保已安装 Node.js 和 npm。
安装教程
# 克隆仓库
git clone https://github.com/yourusername/greptile-mcp.git
# 安装依赖
npm install
# 设置环境变量
cp .env.example .env
# 编辑 .env 文件配置
# 启动服务器
npm start调试方式
# 开发模式运行
npm run dev
# 运行测试
npm test
# 运行特定测试文件
npm test -- tests/server.test.js
# 运行覆盖率测试
npm run test:coverage