@z_ai/mcp-server/README.md

MCP Server for Z.AI - A Model Context Protocol server that provides AI capabilities

# ZAI MCP Server

[中文文档](https://docs.bigmodel.cn//cn/guide/tools/mcp-server) | [English Document](https://docs.z.ai/guides/tools/mcp-server)

A Model Context Protocol (MCP) server that provides AI capabilities powered by Z.AI.

## Environment Variables

- `Z_AI_MODE` - The platform to use for AI services (default: `ZHIPU`)  ZHIPU or ZAI
- `Z_AI_API_KEY` - Your API key
 
For ZAI: Use ZAI platform https://z.ai/model-api , the api base url is `https://api.z.ai/api/paas/v4/`    
For ZHIPU: Use Zhipu AI platform https://bigmodel.cn , the api base url is `https://open.bigmodel.cn/api/paas/v4/`

## Usage

### Use this MCP Server in Claude Code

It is recommended to use the version Node.js 22+, Claude Code 1.0.100+.

For ZAI Use,

```shell
claude mcp add zai-mcp-server --env Z_AI_API_KEY=your_api_key Z_AI_MODE=ZAI -- npx -y @z_ai/mcp-server
```

For ZHIPU Use,

```shell
claude mcp add zai-mcp-server --env Z_AI_API_KEY=your_api_key Z_AI_MODE=ZHIPU -- npx -y @z_ai/mcp-server
```

### Use this MCP Server in Others MCP Client

**Note**: You need to configure `Z_AI_MODE` as `ZAI` or `ZHIPU` depending on the platform.

```json
{
  "mcpServers": {
    "zai-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@z_ai/mcp-server"
      ],
      "env": {
        "Z_AI_API_KEY": "your_api_key",
        "Z_AI_MODE": "ZHIPU"
      }
    }
  }
}
```

### Run with MCP Inspector

```
node ./build/index.js

npx @modelcontextprotocol/inspector node ./build/index.js

```