README
🚀 来自 Sourcegraph 的 MCP 服务器
本项目是一个整合了 Sourcegraph 的 MCP(模型上下文协议)服务器,它能够为大语言模型(LLM)提供代码搜索和分析功能,有效提升代码处理效率。
🚀 快速开始
在使用任何服务器工具之前,您需要生成一个 API 访问令牌。具体步骤如下:
- 访问您的 Sourcegraph 实例(例如 https://sourcegraph.com)
- 点击右上角的个人资料图标
- 导航至 设置 > 访问令牌
- 创建具有适当作用域的新令牌
- 复制令牌并将其设置为环境变量
环境变量
服务器使用两个环境变量,这些变量可以在您的本地环境或 MCP 服务器配置中设置。
SRC_ACCESS_TOKEN:您的 Sourcegraph 访问令牌(见上文)SRC_ENDPOINT(可选):您的 Sourcegraph 实例 URL(默认为 https://sourcegraph.com)
📦 安装指南
1. 使用 TypeScript 构建服务器
yarn run build
2. 配置 MCP 服务器
有许多 MCP 客户端可供使用,但以下是一些示例:
安装脚本
为了方便,提供了一个可选的安装脚本,可以自动设置 Cursor 的正确配置。该脚本会引导您完成 Sourcegraph 环境变量的设置,因此在开始之前请准备好您的访问令牌。
./install_cursor.sh
3. 验证安装
完成设置步骤后,确认服务器是否与您的 MCP 客户端正确配置,方法是提示客户端使用 testSourcegraphConnection 工具。
✨ 主要特性
服务器向 LLM 提供以下工具:
testSourcegraphConnection:测试与 Sourcegraph 的连接并返回版本信息search:在 Sourcegraph 中搜索代码并限制结果数量getFileContent:检索特定仓库中的文件内容searchReactPropUsage:在 Sourcegraph 中搜索使用特定 React 组件的特定属性的代码
Scan to join WeChat group