{
  "markdown": "# Zread.ai MCP Server\n\n[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)\n[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green)](https://nodejs.org/)\n[![MCP](https://img.shields.io/badge/MCP-Protocol-green)](https://modelcontextprotocol.io/)\n[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n连接 [Zread.ai](https://zread.ai) 文档平台的 MCP 服务器，让 AI 助手能够阅读 GitHub 仓库文档、搜索代码、与仓库 AI 对话。\n\n> 💡 **提示 AI**：这是一个 MCP (Model Context Protocol) 服务器，提供 9 个工具用于代码仓库分析。支持 Python 和 Node.js 两种实现，可通过 `npx` 或 `uvx` 一行命令运行。核心功能包括文档查询、仓库搜索、AI 问答。\n\n## 功能\n\n- **文档查询** - 获取仓库文档页面、目录结构、搜索关键词\n- **仓库发现** - 推荐仓库、热门榜单、搜索代码库\n- **AI 问答** - 向仓库 AI 助手提问（需 Token）\n- **文件获取** - 读取源代码文件内容（需 Token）\n\n## 快速启动\n\n```bash\nuvx zread-mcp\nnpx zread-mcp\n```\n\n### 带 Token 运行\n```bash\n# uvx (Python)\nuvx --env ZREAD_TOKEN=your-token zread-mcp\n\n# npx (Node.js) - Windows\nset ZREAD_TOKEN=your-token && npx zread-mcp\n\n# npx (Node.js) - macOS/Linux\nZREAD_TOKEN=your-token npx zread-mcp\n```\n\n### HTTP 模式 (Streamable HTTP)\n```bash\nuvx zread-mcp --transport http --port 3000\nnpx zread-mcp --transport http --port 3000\n```\n\n---\n\n## 更多运行方式\n\n### Python 生态\n\n```bash\n# uvx 从 PyPI 运行（推荐）\nuvx zread-mcp\n\n# uvx 从 GitHub 仓库运行\nuvx --from git+https://github.com/ejfkdev/zread-mcp.git zread-mcp\n\n# uv 运行远程脚本\nuv run https://raw.githubusercontent.com/ejfkdev/zread-mcp/main/zread_mcp_server.py\n\n# pipx 从 GitHub 运行\npipx run --spec git+https://github.com/ejfkdev/zread-mcp.git zread-mcp\n\n# pipx 安装到本地\npipx install git+https://github.com/ejfkdev/zread-mcp.git\nzread-mcp --transport http\n\n# 本地运行\npython zread_mcp_server.py\n```\n\n### Node.js 生态\n\n```bash\n# pnpm\npnpm dlx ejfkdev/zread-mcp\n\n# bun\nbunx ejfkdev/zread-mcp\n\n# 全局安装\nnpm install -g ejfkdev/zread-mcp\nzread-mcp-server --transport http\n```\n\n## MCP 客户端配置\n\n### npx（Node.js）\n```json\n{\n  \"mcpServers\": {\n    \"zread\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"zread-mcp-server\"],\n      \"env\": {\n        \"ZREAD_TOKEN\": \"your-token\"\n      }\n    }\n  }\n}\n```\n\n### uvx（Python）\n```json\n{\n  \"mcpServers\": {\n    \"zread\": {\n      \"command\": \"uvx\",\n      \"args\": [\"--env\", \"ZREAD_TOKEN=your-token\", \"zread-mcp\"]\n    }\n  }\n}\n```\n\n## 获取 Token\n\n部分高级功能（AI 问答、文件获取）需要 ZREAD_TOKEN：\n\n1. 访问 https://zread.ai 并登录\n2. 按 F12 打开控制台\n3. 粘贴运行：\n   ```javascript\n   prompt('复制token', JSON.parse(localStorage.getItem('CGX_AUTH_STORAGE')).state.token)\n   ```\n4. 复制弹窗中的 Token\n\n## 命令行参数\n\n```\n--transport {stdio,http,sse}  传输协议 (默认: stdio, http/sse 等价)\n--host HOST                   HTTP 模式主机 (默认: 127.0.0.1)\n--port PORT                   HTTP 模式端口 (默认: 3000)\n--token TOKEN                 ZREAD_TOKEN\n--no-token                    强制无 Token 模式\n-h, --help                    显示帮助\n```\n\n## 工具列表\n\n| 工具 | 需要 Token | 说明 |\n|------|-----------|------|\n| fetch_documentation_page | 否 | 获取文档页面 |\n| search_documentation | 否 | 搜索文档 |\n| get_documentation_outline | 否 | 获取文档大纲 |\n| discover_repositories | 否 | 发现推荐仓库 |\n| find_repositories | 否 | 搜索仓库 |\n| get_trending_repositories | 否 | 热门仓库榜单 |\n| check_repository_status | 否 | 检查仓库状态 |\n| ask_repo_ai | **是** | AI 智能问答 |\n| fetch_repository_file | **是** | 获取源代码文件 |\n\n## 开发\n\n```bash\n# 克隆仓库\ngit clone https://github.com/ejfkdev/zread-mcp.git\ncd zread-mcp\n\n# Python 测试\npython zread_mcp_server.py --test\n\n# Node.js 测试\nnode zread-mcp-server.js --test\n```\n\n## 许可证\n\nMIT License\n",
  "bytes": 3321,
  "sha": "b6dbbe2989b6da50c32a013dc32705e51b7330724d53f027fce489d80bb107fa",
  "repo_slug": "ejfkdev/zread-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_ejfkdev_zread_mcp_f82ed151/readme"
}