Skip to main content
The Zread MCP Server is a Z.AI implementation based on the Model Context Protocol (MCP). Powered by zread.ai, it provides Claude Code, Cline, and other MCP-compatible clients with knowledge documentation and code access capabilities for open source repositories.

​
Overview

This remote MCP server with open source repository Q&A capability is available to users on GLM Coding Plan, enabling your code agent to deeply understand open source projects and efficiently fetch documentation, code structure, and file content.

​
Features

Documentation Search

Search documentation, code, and comments in Github repositories

Repository Structure

Get the directory structure and file list of GitHub repositories to quickly master project layout

Code Reading

Read the complete code content of specified files in GitHub repositories to deeply analyze implementation details

​
Tools

This server implements the Model Context Protocol and works with any MCP-compatible client. Currently, it provides the following tools:
  • search_doc — Search for knowledge documentation corresponding to the GitHub repository, quickly understanding repository knowledge, news, recent issues, PRs, and contributors.
  • get_repo_structure — Get the directory structure and file list of the GitHub repository to understand project module splitting and directory organization.
  • read_file — Read the complete code content of specified files in the GitHub repository to deeply analyze the implementation details of the file code.

​
Example Scenarios

Quick Start with Open Source Libraries

Quickly understand the core concepts, installation steps, and code organization of open source libraries by searching documentation and obtaining repository structures, accelerating the learning curve.

Issue Troubleshooting and History

When encountering problems, search the repository’s Issue and Commit history to find solutions or fix records for similar problems.
Directly read the code content of core files, analyze implementation logic, and assist in secondary development or Debugging.
Before introducing a new dependency library, evaluate its activity, code quality, and maintenance status by viewing its repository structure and documentation.

​
Installation and Usage

​
Quick Start

1

Get API Key

Visit Z.AI Console to get your api key
2

Configure MCP Server

According to the client you’re using, choose the corresponding installation method from the options below.

​
Supported Clients

One-click install commandReplace your_api_key with the API key you obtained in the previous step
claude mcp add -s user -t http zread https://api.z.ai/api/mcp/zread/mcp --header "Authorization: Bearer your_api_key"
Manual configurationEdit the Claude Code configuration file under your home directory, the MCP section of .claude.json:
{
  "mcpServers": {
    "zread": {
      "type": "http",
      "url": "https://api.z.ai/api/mcp/zread/mcp",
      "headers": {
        "Authorization": "Bearer your_api_key"
      }
    }
  }
}

​
Troubleshooting

Issue: Received an invalid access token errorSolutions:
  1. Verify the token was copied correctly
  2. Check that the token is activated
  3. Ensure the token has sufficient balance
  4. Confirm the Authorization header format is correct
Issue: Connection to the MCP server timed outSolutions:
  1. Check your network connection
  2. Verify firewall settings
  3. Ensure the server URL is correct
  4. Increase client timeout settings
Issue: Unable to search or read specified repository contentSolutions:
  1. Confirm the repository exists and is open source (public)
  2. Check if the repository name is spelled correctly (owner/repo)
  3. Visit zread.ai to search if this open source repository is supported

​
Quota

The MCP quotas for the Lite, Pro and Max plans are as follows:
  • Lite: Include a total of 100 web searches, web readers and ZRead MCP calls, along with the 5-hour maximum prompt resource pool of the package for vision understanding.
  • Pro: Include a total of 1,000 web searches, web readers and ZRead MCP calls, along with the 5-hour maximum prompt resource pool of the package for vision understanding.
  • Max: Include a total of 4,000 web searches, web readers and ZRead MCP calls, along with the 5-hour maximum prompt resource pool of the package for vision understanding.

​
Resources