Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,87 @@ It uses the same approach as Zig's official autodoc (ziglang.org) by reading STD
## Installation

### Claude Code

Using Node:

```bash
claude mcp add zig-docs npx -y zig-mcp@latest --version master --update-policy manual
```

Using Bun:

```bash
claude mcp add zig-docs bunx zig-mcp@latest --version master --update-policy manual
```

### Roo Code

1. Click the **MCP** button in Roo Code
2. Select **"Edit Global MCP"** or **"Edit Project MCP"**
3. Add the following configuration:

Using Node:

```json
{
"mcpServers": {
"zig-docs": {
"command": "npx",
"args": ["-y", "zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
}
}
}
```

Using Bun:

```json
{
"mcpServers": {
"zig-docs": {
"command": "bunx",
"args": ["zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
}
}
}
```

### Augment Code

Navigate to **Settings → MCP Servers → Add Server**, or edit the configuration directly:

Using Node:

```json
{
"mcpServers": {
"zig-docs": {
"command": "npx",
"args": ["-y", "zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
}
}
}
```

Using Bun:

```json
{
"mcpServers": {
"zig-docs": {
"command": "bunx",
"args": ["zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
}
}
}
```

### Claude Desktop

Add to your MCP configuration:

Using Node:

```json
{
"mcpServers": {
Expand All @@ -32,6 +107,19 @@ Add to your MCP configuration:
}
```

Using Bun:

```json
{
"mcpServers": {
"zig-docs": {
"command": "bunx",
"args": ["zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
}
}
}
```

## Tools

- **`list_builtin_functions`** - Lists all available Zig builtin functions. Builtin functions are provided by the compiler and are prefixed with '@'. The comptime keyword on a parameter means that the parameter must be known at compile time. Use this to discover what functions are available, then use 'get_builtin_function' to get detailed documentation.
Expand Down