功能特性
文档搜索
Github 代码仓库检索文档、代码与注释
仓库结构
获取 GitHub 仓库的目录结构和文件列表,快速掌握项目布局
代码读取
读取 GitHub 仓库中指定文件的完整代码内容,深入分析实现细节
支持的工具
该服务器实现了模型上下文协议,可与任何兼容 MCP 的客户端一起使用。目前提供以下工具:search_doc- 搜索 GitHub 仓库的对应的知识文档,快速了解仓库知识,新闻,最近的 issue pr 和贡献者等。get_repo_structure- 获取 GitHub 仓库的目录结构和文件列表,了解项目模块拆分和目录组织方式。read_file- 读取 GitHub 仓库中指定文件的完整代码内容,深入文件代码的实现细节。
示例场景
快速上手开源库
快速上手开源库
通过搜索文档和获取仓库结构,快速了解开源库的核心概念、安装步骤和代码组织方式,加速学习曲线。
排查 Issue 和历史记录
排查 Issue 和历史记录
在遇到问题时,搜索仓库的 Issue 和 Commit 历史,查找是否有类似问题的解决方案或修复记录。
深入源码分析
深入源码分析
直接读取核心文件的代码内容,分析实现逻辑,辅助进行二次开发或 Debug。
依赖库调研
依赖库调研
在引入新的依赖库之前,通过查看其仓库结构和文档,评估其活跃度、代码质量和维护情况。
安装与使用
快速开始
获取访问令牌
- 个人版套餐的用户,通过 个人编程套餐 > 套餐概览,新建 API Key
- 团队版套餐的成员,通过 团队编程套餐 > 我的套餐,获取 API Key(团队套餐 Key 与平台其他 API Key 不通用,使用团队额度请务必使用团队套餐 Key)
支持的客户端
- Claude Code
- Cline (VS Code)
- OpenCode
- Crush
- Goose
- Roo Code, Kilo Code 其它
一键安装命令注意替换里面的 手动配置编辑 Claude Code 的配置文件, 位于用户目录下
your_api_key 为您上一步获取到的 API Key.claude.json 的 MCP 部分:故障排除
访问令牌无效
访问令牌无效
连接超时
连接超时
问题: MCP 服务器连接超时解决方案:
- 检查网络连接
- 确认防火墙设置
- 验证服务器 URL 是否正确
- 增加超时时间设置
仓库访问失败
仓库访问失败
问题: 无法搜索或读取指定仓库内容解决方案:
- 确认仓库是否存在且为开源(公开)仓库
- 检查仓库名称拼写是否正确 (owner/repo)
- 访问 zread.ai 搜索此开源仓库是否被收纳支持