基于 AI 驱动的 CLI 和 MCP 服务器，用于浏览 GitHub 项目文档（非官方工具）
概览
Zread帮助你和你的AI更快理解代码库。跳过手动源代码挖掘，直接询问。它连接 Zread.ai，一个由AI驱动的GitHub项目文档服务。 - 🖥️ - 直接在终端运行，设置最少 - 🔌 - 集成 Claude 和 Cline 等 AI 助手 - 🔍 浏览文档、搜索代码，发现无需令牌的仓库 - 🤖 基于仓库文档的AI问答 - 🌐 多传输方式：stdio、HTTP和SSE - ⚡ 一个命令运行，零阻力启动 - 📖 - 直接在终端浏览GitHub仓库文档 - 🔍 - 跨仓库文档搜索关键词 - 🌟 - 浏览趋势排名和推荐项目 - 📥 - 本地导出仓库文档并生成llms.txt和LLMS full文档。
概述（AI 翻译）
中文 |英语
Zread帮助你和你的AI更快理解代码库。跳过手动源代码挖掘，直接询问。它连接 Zread.ai，一个由AI驱动的GitHub项目文档服务。
两个角色：
- 🖥️ CLI 工具 - 直接在终端中运行，只需最小化设置
- 🔌 MCP 服务器 - 与 Claude 和 Cline 等 AI 助手集成
精彩片段：
- 🔍 浏览文档、搜索代码，并发现无令牌的仓库
- 🤖 由仓库文档驱动的AI问答
- 🌐 多传输：stdio、HTTP 和 SSE
- ⚡ 一个指令运行，零摩擦启动
特色
- 📖 阅读文档 - 直接在终端浏览GitHub仓库文档
- 🔍 搜索文档 - 跨仓库文档搜索关键词
- 🌟 发现仓库 - 浏览热门排名和推荐项目
- 📥 导出文档 - 导出仓库文档并生成
llms.txt和llms-full.txt（仅限 CLI） - 🤖 AI 问答 - 向仓库 AI 助手提问（需免费账户令牌）
- 📄 读取源文件 - 直接检查源文件内容
- 🔌 MCP集成 - 与AI助手无缝连接
截图
本页由 AI 翻译，技术细节请以原文为准。
README
以下为原文 README 节选，完整内容请查看原文。
Zread - AI Repository Reading Assistant
中文 | English
Zread helps you and your AI understand codebases faster. Skip the manual source dive and ask directly. It connects to Zread.ai, an AI-powered GitHub project documentation service.
Two roles:
- 🖥️ CLI tool - run directly in your terminal with minimal setup
- 🔌 MCP server - integrate with AI assistants such as Claude and Cline
Highlights:
- 🔍 Browse docs, search code, and discover repositories without a token
- 🤖 AI Q&A powered by repository documentation
- 🌐 Multiple transports: stdio, HTTP, and SSE
- ⚡ One command to run, zero-friction startup
Features
安装
uvx --env ZREAD_TOKEN=your-token zread mcp配置
{
"mcpServers": {
"zread": {
"command": "uvx",
"args": ["--env", "ZREAD_TOKEN=your-token", "zread", "mcp"]
}
}
}