Greptile MCP 服务器

一个基于 WebSocket 的服务器，支持跨多个代码仓库的实时代码搜索和索引功能。它充当客户端和 Greptile API 之间的中间件，为管理多个搜索上下文和流式传输结果提供增强的功能。

功能特性

• 🔌 WebSocket 服务器: 具有连接管理和心跳机制的实时通信
• 👥 代理管理: 为不同的代码仓库创建和管理代理实例
• 🔍 代码仓库集成: 通过 Greptile API 支持代码仓库索引
• 🔎 查询处理: 处理和验证搜索查询，并提供流式结果
• 🔐 安全性: 使用 API 密钥认证保护 WebSocket 连接
• ⚙️ 配置: 基于环境变量的配置，支持自定义 API 端点
• 📊 监控: 具有性能指标的综合日志记录系统
• 📚 客户端 SDK: 具有连接管理的 WebSocket 客户端实现

安装

# 克隆代码仓库
git clone https://github.com/yourusername/greptile-mcp.git

# 安装依赖
npm install

# 设置环境变量
cp .env.example .env
# 编辑 .env 文件进行配置

# 启动服务器
npm start

环境变量

# 服务器配置
PORT=3000
HOST=0.0.0.0
NODE_ENV=production

# Greptile API 配置
GREPTILE_API_KEY=your-api-key
GITHUB_TOKEN=your-github-token
GREPTILE_BASE_URL=https://api.greptile.com/v2

# 认证配置
AUTH_ENABLED=false
API_KEY=your-api-key-here
TOKEN_HEADER_NAME=X-API-Key

# 速率限制配置
RATE_LIMIT_ENABLED=true
RATE_LIMIT_WINDOW_MS=900000
RATE_LIMIT_MAX=100

# 日志配置
LOG_LEVEL=info
LOG_FORMAT=combined

使用方法

创建代理

curl -X POST http://localhost:3000/api/agents \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Demo Agent",
    "description": "Testing agent",
    "repositoryUrl": "https://github.com/facebook/react",
    "branch": "main"
  }'

WebSocket 连接

import WebSocket from 'ws';

const ws = new WebSocket('ws://localhost:3000');
const agentId = 'your-agent-id';

ws.on('open', () => {
  // 注册连接
  ws.send(JSON.stringify({
    type: 'register',
    agentId: agentId
  }));
});

ws.on('message', (data) => {
  const message = JSON.parse(data.toString());
  console.log('Received:', message);
});

查询代码

// 注册之后
ws.send(JSON.stringify({
  type: 'query',
  query: 'Find function main',
  options: {
    stream: true,
    maxResults: 5,
    includeContext: true
  }
}));

开发

# 在开发模式下运行
npm run dev

# 运行测试
npm test

# 运行代码检查
npm run lint

# 构建用于生产环境
npm run build

测试

该项目包含全面的测试：

# 运行所有测试
npm test

# 运行特定的测试文件
npm test -- tests/server.test.js

# 运行并生成覆盖率报告
npm run test:coverage

贡献

1. Fork 该代码仓库
2. 创建您的特性分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到该分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

许可证

该项目基于 MIT 许可证 - 详见 LICENSE 文件。

鸣谢

• Greptile API 提供核心搜索功能
• ws 提供 WebSocket 实现
• 所有为该项目做出贡献的贡献者