Zread - AI Repository Reading Assistant
中文 | English
Zread
ejfkdev47 ดาว
AI-powered CLI and MCP server for browsing GitHub project documentation (unofficial tool)
- ทรานสปอร์ต
- stdio
- สถานะ
- โลคัล
Power your agent
การติดตั้งจากผู้เผยแพร่ ไม่ใช่เอนด์พอยต์ของ PlugMCP
URL แบบรีโมตหรือคำสั่งบนเครื่องของคุณ? การติดตั้งสองแบบต่างกันอย่างไร
รันบน PlugMCP
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
เปิดจากผู้เผยแพร่
中文 | English
AI-powered CLI and MCP server for browsing GitHub project documentation (unofficial tool)
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:
Highlights:
llms.txt and llms-full.txt (CLI only)# Run with uvx
uvx zread
# Or with pipx
pipx run zread
# stdio mode
uvx zread mcp
# HTTP mode
uvx zread mcp http
AI Q&A requires a free token from your Zread.ai account.
Set your token:
export ZREAD_TOKEN=your-token
Usage:
# Interactive multi-turn chat
zread ai openclaw/openclaw
# Single question
zread ai facebook/react "How is this project structured?"
# Start the MCP server
zread mcp [stdio|http|sse] [address] [options]
# Show the documentation outline
zread ls <repo> [-l zh|en] [-j] [-p]
# Read a documentation page or a source file
zread cat <repo> [slug_or_path] [-l zh|en] [-j] [-p]
#
# Automatic argument detection:
# - If the first argument is only repo and the second is a slug/index (for example 1-overview, 1), it reads a zread doc page
# - Other forms (for example README.md, owner/repo/README.md#L1-10, github.com/owner/repo/README.md#L1-10) read a GitHub file
# Search
zread find <query> # Search GitHub repositories
zread find <repo> <query> # Search within a repository's docs
# Discover recommended repositories
zread rand [topic] [-l zh|en] [-j] [-p]
# Show trending repositories
zread top [weeks] [-l zh|en] [-j] [-p]
# Show repository status and metadata (silently submits unindexed repos and refreshes stale docs)
zread stat <repo> [-l zh|en] [-j] [-p]
# Ask the repository AI (requires a free account token)
zread ai <repo> [question] [-l zh|en] [-t token] [-p] [-j] [-m model]
# Export repository docs locally and generate llms.txt / llms-full.txt
zread cp <repo> [output_dir] [-l zh|en] [-c concurrency]
The CLI supports plain text and JSON output and works well in pipelines:
# MCP server
uvx zread mcp # stdio mode (default)
uvx zread mcp http # HTTP mode
uvx zread mcp http :8080 # Custom port
uvx zread mcp http 0.0.0.0:3000/custom # Custom address and path
# Docs
uvx zread ls golang/go
uvx zread cat vuejs/vue
uvx zread cat vuejs/vue 1
uvx zread cat vuejs/vue 1-overview
uvx zread cat golang/go README.md
uvx zread cat python/cpython Lib/http/client.py
uvx zread cat github.com/facebook/react/README.md#L1-10
uvx zread cat facebook/react/README.md#L1-10
uvx zread cat facebook/react README.md 5 10
uvx zread cat facebook/react README.md 5-10
uvx zread cat facebook/react README.md 5~
uvx zread cat facebook/react/README.md 5:
uvx zread find facebook/react hooks
# Discovery
uvx zread top
uvx zread top 4
uvx zread rand python
uvx zread rand awesome-list
# Repository info
uvx zread stat torvalds/linux
# AI Q&A
uvx zread ai golang/go "How do I choose between channels and mutexes?" -t your-token
uvx zread ai python/cpython --model claude-sonnet-4.6 -t your-token
uvx zread ai rust-lang/rust
# Export docs
uvx zread cp golang/go
uvx zread cp python/cpython -l zh
uvx zread cp vuejs/vue -c 20
Add the following configuration to any MCP-compatible client:
{
"mcpServers": {
"zread": {
"command": "uvx",
"args": ["--env", "ZREAD_TOKEN=your-token", "zread", "mcp"]
}
}
}
AI Q&A requires a free JWT token from your Zread.ai account:
prompt(
"copy token",
JSON.parse(localStorage.getItem("CGX_AUTH_STORAGE")).state.token,
);
You can also configure zread using a config file. The priority is: CLI arguments > Environment variables > Config file.
Config file locations:
~/.config/zread/zread.toml$XDG_CONFIG_HOME/zread/zread.toml (if set) or ~/.config/zread/zread.toml%APPDATA%\zread\zread.tomlConfig file format (TOML):
[zread]
token = "your-token-here"
lang = "zh" # optional, defaults to "zh"
model = "glm-5.1" # optional, defaults to "glm-5.1", also supports "claude-sonnet-4.6"
Contributions are welcome. See CONTRIBUTING.md for details.
MIT License. See LICENSE for details.
AI-powered CLI and MCP server for browsing GitHub project documentation (unofficial tool)
เครื่องมือ
ยังไม่มีรายการเครื่องมือ เซิร์ฟเวอร์แบบรีโมตจะได้รายการหลังการตรวจสอบสถานะครั้งแรก
FAQ
คัดลอกคอนฟิก stdio สำหรับ Cursor, Claude Desktop, Claude Code หรือ VS Code ได้ในหน้านี้ คอนฟิกนี้ใช้การติดตั้งของผู้เผยแพร่ ไม่ใช่พร็อกซีของ PlugMCP
ระเบียนนี้ไม่ได้ระบุตัวแปรสภาพแวดล้อมที่จำเป็น
Zread ทำงานแบบโลคัลผ่าน stdio
ตรวจสอบล่าสุดเมื่อ 2026-10-27 AI-powered CLI and MCP server for browsing GitHub project documentation (unofficial tool)