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 分