Zread MCP server
io.github.ejfkdev/zread-mcp·v1.0.1·2 starsZread.ai MCP Server - 连接 zread.ai 文档平台的 MCP 服务器,让 AI 助手能够阅读 GitHub 仓库文档、搜索代码、与仓库 AI 对话。
2 stars53 downloads/wk
Reviews
Write oneNobody has reviewed Zread yet.
If you have run it, two minutes of your experience saves the next person an afternoon.
Zread tools (9)
write = sends, deletes, buys or postsRead from the package source without running it. The installed server may list more.
ask_repo_aicheck_repository_status检查仓库索引状态。 查询指定仓库在 Zread.ai 的索引状态和基本信息。 返回的 status 字段: "success"(已索引), "progress"(索引中)
discover_repositories发现推荐的代码仓库。 获取 Zread.ai 推荐的优质代码仓库,可按技术主题筛选。 适用于发现新工具、学习优秀项目。
fetch_documentation_page获取仓库文档的指定页面内容。 根据页面 slug(URL 标识符)获取该页面的完整 Markdown 文档内容。 适用于读取特定章节或页面的详细内容。 返回的 Markdown 页面内容中可能包含两种链接格式: 1. **仓库文件链接** - 格式: `[文件名](文件路径#L开始行号-L结束行号)` 例如: `[index.ts](index.ts#L1-L28)` `[package.json](package.json#L1-L77)` 这类链接指向仓库内的源代码文件,可提取文件路径和行号范围, 使用 `fetch_repository_file(repo_path, file_path, start_line, end_line)` 获取具体内容。 2. **文档导航链接** - 格式: `[标题](页面slug)` 例如: `[概述](1-overview)` `[快速开始](2
fetch_repository_file获取仓库内的源代码文件内容。 读取指定仓库中的文件内容,支持按行号范围截取。 内部自动通过 repo_path 获取 repo_id。 适用于查看源代码、配置文件等。 示例: - 获取完整文件: fetch_repository_file("owner/repo", "src/config.ts") - 获取前 50 行: fetch_repository_file("owner/repo", "src/config.ts", 1, 51) - 从第 100 行到末尾: fetch_repository_file("owner/repo", "src/config.ts", 100)
find_repositories搜索代码仓库。 根据关键词模糊搜索已索引的代码仓库。 支持仓库名称、描述、主题等字段的模糊匹配。
get_documentation_outline获取仓库文档的完整目录结构。 返回仓库的文档目录树,包含所有页面的标题、slug 和层级关系。 首次调用会自动提交索引请求,如果仓库未被索引会返回等待状态。
get_trending_repositories获取本周热门仓库榜单。 获取 GitHub 本周最受欢迎的代码仓库列表,按热度排序。 适用于了解技术趋势和热门项目。
search_documentation在仓库文档中搜索关键词。 全文搜索仓库文档,返回包含关键词的页面和相关内容片段。 适用于快速定位文档中的特定信息。
Public scan report
scanner v0.1.10 · 2026-09-27 · same rubric, same numbers if you re-run it
- Code scan2 source files scanned25/25
- –Live reliabilityno gateway calls yet and no remote to proben/a
- –Tool poisoningtools not inspected (local package is not executed); not countedn/a
- Auth qualitystatic API keys via environment variables6/15
- Maintenancerepository archived0/15
- Maintainer identityregistry namespace matches repository owner; GitHub account older than a year8/10
Findings (1)
- highRepository is archived
maint.archived
How Zread compares
Against every graded Developer tools MCP server, from our own scans and uptime checks. Updated after each scan run.
- Safety score
- 60/100
- higher than 14% of 1,119 Developer tools servers
- Tools
- 9
- the typical Developer tools server has 7
- Tools that change things
- 0%
- typical: 5%. Fewer write tools means less an agent can break
- GitHub stars
- 2
- more than 65% of 855 Developer tools servers
- Downloads a week
- 53
- more than 40% of 436 Developer tools servers with a package
What its tools let an agent do: 9 read
Install Zread in Claude Code, Cursor or VS Code
Runs npx -y zread-mcp on your machine. Read the scan report first; the gateway never runs local packages.
claude mcp add zread-mcp -- npx -y zread-mcp
What the publisher says
From the Zread repository's README, as published. We do not edit it. Read it on GitHub
Zread.ai MCP Server
连接 Zread.ai 文档平台的 MCP 服务器,让 AI 助手能够阅读 GitHub 仓库文档、搜索代码、与仓库 AI 对话。
💡 提示 AI:这是一个 MCP (Model Context Protocol) 服务器,提供 9 个工具用于代码仓库分析。支持 Python 和 Node.js 两种实现,可通过 npx 或 uvx 一行命令运行。核心功能包括文档查询、仓库搜索、AI 问答。
功能
- 文档查询 - 获取仓库文档页面、目录结构、搜索关键词
- 仓库发现 - 推荐仓库、热门榜单、搜索代码库
- AI 问答 - 向仓库 AI 助手提问(需 Token)
- 文件获取 - 读取源代码文件内容(需 Token)
快速启动
uvx zread-mcp
npx zread-mcp带 Token 运行
# uvx (Python)
uvx --env ZREAD_TOKEN=your-token zread-mcp
# npx (Node.js) - Windows
set ZREAD_TOKEN=your-token && npx zread-mcp
# npx (Node.js) - macOS/Linux
ZREAD_TOKEN=your-token npx zread-mcpHTTP 模式 (Streamable HTTP)
uvx zread-mcp --transport http --port 3000
npx zread-mcp --transport http --port 3000更多运行方式
Python 生态
# uvx 从 PyPI 运行(推荐)
uvx zread-mcp
# uvx 从 GitHub 仓库运行
uvx --from git+https://github.com/ejfkdev/zread-mcp.git zread-mcp
# uv 运行远程脚本
uv run https://raw.githubusercontent.com/ejfkdev/zread-mcp/main/zread_mcp_server.py
# pipx 从 GitHub 运行
pipx run --spec git+https://github.com/ejfkdev/zread-mcp.git zread-mcp
# pipx 安装到本地
pipx install git+https://github.com/ejfkdev/zread-mcp.git
zread-mcp --transport http
# 本地运行
python zread_mcp_server.pyNode.js 生态
# pnpm
pnpm dlx ejfkdev/zread-mcp
# bun
bunx ejfkdev/zread-mcp
# 全局安装
npm install -g ejfkdev/zread-mcp
zread-mcp-server --transport httpMCP 客户端配置
npx(Node.js)
{
"mcpServers": {
"zread": {
"command": "npx",
"args": ["-y", "zread-mcp-server"],
"env": {
"ZREAD_TOKEN": "your-token"
}
}
}
}uvx(Python)
{
"mcpServers": {
"zread": {
"command": "uvx",
"args": ["--env", "ZREAD_TOKEN=your-token", "zread-mcp"]
}
}
}获取 Token
部分高级功能(AI 问答、文件获取)需要 ZREAD_TOKEN:
- 访问 https://zread.ai 并登录
- 按 F12 打开控制台
- 粘贴运行:
prompt('复制token', JSON.parse(localStorage.getItem('CGX_AUTH_STORAGE')).state.token)- 复制弹窗中的 Token
命令行参数
--transport {stdio,http,sse} 传输协议 (默认: stdio, http/sse 等价)
--host HOST HTTP 模式主机 (默认: 127.0.0.1)
--port PORT HTTP 模式端口 (默认: 3000)
--token TOKEN ZREAD_TOKEN
--no-token 强制无 Token 模式
-h, --help 显示帮助工具列表
开发
# 克隆仓库
git clone https://github.com/ejfkdev/zread-mcp.git
cd zread-mcp
# Python 测试
python zread_mcp_server.py --test
# Node.js 测试
node zread-mcp-server.js --test许可证
MIT License
Nothing above is checked by us. What we check is on the safety report.
Zread: common questions
- Is Zread MCP server safe?
- With care: it is graded C, so read the findings first (60/100). Read the Zread safety report
- How do I install Zread?
- It runs on your machine. Copy the Claude Code, Cursor, VS Code or Claude Desktop config from the install section.
- Does Zread need an API key?
- Yes. The registry entry asks for
ZREAD_TOKEN. - Is Zread maintained?
- The last commit was 236 days ago (2026-03-13). The latest release is v1.0.1.
- What can I use instead of Zread?
- Servers from other publishers that do the same job: GitDiagram MCP server, GitHub MCP server and Gk CLI MCP server.
- How does Zread compare with other Developer tools MCP servers?
- safety score 60/100 (higher than 14% of 1,119 Developer tools servers); tools 9 (the typical Developer tools server has 7); tools that change things 0% (typical: 5%. Fewer write tools means less an agent can break). Full comparison.
Alternatives to Zread
Same job from other publishers: the closest match first, then the best rated.
- GitDiagramArchitecture diagrams, explanations and Mermaid source for public GitHub repositories.not reviewedEstablishedA
- GitHubConnect AI assistants to GitHub - manage repos, issues, PRs, and workflows through natural language.not reviewedEstablishedA
Gk CLIThe GitKraken MCP Server for managing repos, PRs, issues across GitHub, GitLab, Bitbucket and more.not reviewedEstablishedB- Agent HarnessesAgent-harness picks, decision guides, setup templates, and skills; live GitHub/HN discovery.not reviewedEstablishedA
uploads.shHost files from coding agents; stage on a branch and attach to GitHub PRs.not reviewedEstablishedA