Zread Mcp

io.github.ejfkdev由 GitHub 账号 ejfkdev 发布v1.0.1更新于 Oct 27, 2026

Zread.ai MCP Server - 连接 zread.ai 文档平台的 MCP 服务器,让 AI 助手能够阅读 GitHub 仓库文档、搜索代码、与仓库 AI 对话。

概览

AI 生成的概览

连接 Zread.ai 文档平台的 MCP 服务器,让 AI 助手阅读 GitHub 仓库文档、搜索代码仓库并向仓库 AI 提问。

可以做什么
  • 获取、搜索文档页面并查看文档大纲
  • 发现推荐仓库、搜索仓库、查看热门仓库榜单
  • 检查仓库状态
  • 向仓库 AI 助手提问(需要 Token)
  • 读取仓库中的源代码文件(需要 Token)
适用场景
适合让助手调研开源仓库:阅读其文档、寻找相关项目,或在不克隆代码的情况下就某个代码库提问。
运行要求
通过 npx(Node.js)或 uvx(Python)在本地运行,默认 stdio,也可选用 HTTP/SSE 模式并指定主机与端口。AI 问答与文件获取工具需要 ZREAD_TOKEN 环境变量,其余工具无需 Token。需要能访问 zread.ai 的网络。
安装前请注意
该 Token 是 Zread.ai 账号凭据,README 建议从网站浏览器的 localStorage 中提取,应视为敏感信息,仅通过 ZREAD_TOKEN 环境变量传入。AI 问答与源码获取工具会把请求发送给第三方 zread.ai 服务。HTTP 模式默认绑定 127.0.0.1,若改绑其他地址会扩大访问范围。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Zread Mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Zread.ai MCP Server

[Python] [Node.js] [MCP] [License]

连接 Zread.ai 文档平台的 MCP 服务器,让 AI 助手能够阅读 GitHub 仓库文档、搜索代码、与仓库 AI 对话。

💡 提示 AI:这是一个 MCP (Model Context Protocol) 服务器,提供 9 个工具用于代码仓库分析。支持 Python 和 Node.js 两种实现,可通过 npx 或 uvx 一行命令运行。核心功能包括文档查询、仓库搜索、AI 问答。

功能

  • 文档查询 - 获取仓库文档页面、目录结构、搜索关键词
  • 仓库发现 - 推荐仓库、热门榜单、搜索代码库
  • AI 问答 - 向仓库 AI 助手提问(需 Token)
  • 文件获取 - 读取源代码文件内容(需 Token)

快速启动

bash
uvx zread-mcpnpx zread-mcp

带 Token 运行

bash
# uvx (Python)uvx --env ZREAD_TOKEN=your-token zread-mcp
# npx (Node.js) - Windowsset ZREAD_TOKEN=your-token && npx zread-mcp
# npx (Node.js) - macOS/LinuxZREAD_TOKEN=your-token npx zread-mcp

HTTP 模式 (Streamable HTTP)

bash
uvx zread-mcp --transport http --port 3000npx zread-mcp --transport http --port 3000

更多运行方式

Python 生态

bash
# 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.gitzread-mcp --transport http
# 本地运行python zread_mcp_server.py

Node.js 生态

bash
# pnpmpnpm dlx ejfkdev/zread-mcp
# bunbunx ejfkdev/zread-mcp
# 全局安装npm install -g ejfkdev/zread-mcpzread-mcp-server --transport http

MCP 客户端配置

npx(Node.js)

json
{  "mcpServers": {    "zread": {      "command": "npx",      "args": ["-y", "zread-mcp-server"],      "env": {        "ZREAD_TOKEN": "your-token"      }    }  }}

uvx(Python)

json
{  "mcpServers": {    "zread": {      "command": "uvx",      "args": ["--env", "ZREAD_TOKEN=your-token", "zread-mcp"]    }  }}

获取 Token

部分高级功能(AI 问答、文件获取)需要 ZREAD_TOKEN:

  1. 访问 https://zread.ai 并登录
  2. 按 F12 打开控制台
  3. 粘贴运行:
    javascript
    prompt('复制token', JSON.parse(localStorage.getItem('CGX_AUTH_STORAGE')).state.token)
  4. 复制弹窗中的 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                    显示帮助

工具列表

工具需要 Token说明
fetch_documentation_page否获取文档页面
search_documentation否搜索文档
get_documentation_outline否获取文档大纲
discover_repositories否发现推荐仓库
find_repositories否搜索仓库
get_trending_repositories否热门仓库榜单
check_repository_status否检查仓库状态
ask_repo_ai是AI 智能问答
fetch_repository_file是获取源代码文件

开发

bash
# 克隆仓库git clone https://github.com/ejfkdev/zread-mcp.gitcd zread-mcp
# Python 测试python zread_mcp_server.py --test
# Node.js 测试node zread-mcp-server.js --test

许可证

MIT License

来源:README.md,提交 7be9e90

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.1最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分