# Zread

> Search and read GitHub repository docs via the Zhipu CodePlan MCP zread server. Use when you need quick repo structure lookup or documentation search without cloning. Triggers: zread, search_doc, repo structure, read_file, GitHub docs search.

- Skill: `zkl2333/zread` (Agent Skill)
- Install (CLI): `npx skillmds@latest add zkl2333/zread`
- Raw SKILL.md: https://api.skillmd.com/api/skills/zkl2333/zread/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: zkl2333 (https://skillmd.com/u/zkl2333)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/zkl2333/zread

---


## Prerequisites (mcporter)

Add this server to your `mcporter.json` (merge under `mcpServers`):

```json
"zread": {
  "baseUrl": "https://open.bigmodel.cn/api/mcp/zread/mcp",
  "headers": {
    "Authorization": "Bearer YOUR_ZHIPU_API_KEY",
    "Accept": "application/json, text/event-stream"
  }
}
```

Based on the Zhipu CodePlan MCP server configuration, this skill provides functionality for searching GitHub repositories (documents, issues, commits).

**Usage:**
Call the `zread` tool with the `search_doc` function, providing the `repo_name` and `query` parameters.

**Parameters:**
- `repo_name` (string, required): The GitHub repository name in the format `owner/repo`.
- `query` (string, required): The search term or question.

**Example:**
```bash
mcporter call zread.search_doc repo_name="openclaw/openclaw" query="documentation"
```

