zai-zread

name	zai-zread
description	Explore GitHub repositories in depth using Z.AI ZRead — search documentation, browse directory structure, and read source files. Use when the user needs to understand an open-source project, explore a GitHub repo's codebase, read specific files, find issues or PRs, or analyze how a library works. Run scripts/zread.py via Bash.
compatibility	Requires Python 3 and Z_AI_API_KEY environment variable. Usage is quota-limited (100–4000 calls/month depending on plan).
metadata	{"author":"z-ai","version":"1.0","api-docs":"https://docs.bigmodel.cn/cn/coding-plan/mcp/zread-mcp-server"}

Z.AI ZRead Skill

Explore GitHub repositories by running scripts/zread.py with Bash. No MCP configuration needed — set Z_AI_API_KEY and call the script directly.

Prerequisites

export Z_AI_API_KEY=your_api_key

Usage

# Search docs, issues, PRs in a repo
python3 scripts/zread.py search_doc <owner/repo> <query>

# Get directory structure
python3 scripts/zread.py get_structure <owner/repo> [subdirectory]

# Read a specific file
python3 scripts/zread.py read_file <owner/repo> <file_path>

Commands

Command	When to use
search_doc	Find relevant docs, issues, PRs, or contributor info
get_structure	Understand project layout before diving in
read_file	Read the full content of a specific source file

Examples

# Search for reconciler docs in React
python3 scripts/zread.py search_doc facebook/react "reconciler algorithm"

# Browse the top-level structure of openai-python
python3 scripts/zread.py get_structure openai/openai-python

# Browse a specific subdirectory
python3 scripts/zread.py get_structure openai/openai-python src/openai

# Read a specific file
python3 scripts/zread.py read_file tiangolo/fastapi fastapi/routing.py

# Find open issues about a topic
python3 scripts/zread.py search_doc langchain-ai/langchain "memory leak"

Recommended Workflow

1. Orient: get_structure <repo> to understand the project layout.
2. Search: search_doc <repo> <topic> to find relevant docs or discussions.
3. Read: read_file <repo> <path> to examine specific implementations.
4. Synthesize: Combine findings to answer the user's question.

When to Use

• User mentions a GitHub repo and wants to understand it
• User asks "how does X library work?" or "show me the source for Y"
• User needs to find examples, config options, or API surface
• User wants to understand internal architecture of a library

Use zai-web-reader for generic webpages. Use zai-zread specifically for GitHub repositories.

Quota

Plan	Monthly Calls
Lite	100
Pro	1,000
Max	4,000

Start with get_structure to orient, then read only the files you need.