Skip to content

Commit eb9b08e

Browse files
AfiriumAfirium
committed
fix(docs): Remove duplicate instructions
1 parent aaba5a5 commit eb9b08e

File tree

1 file changed

+51
-107
lines changed

1 file changed

+51
-107
lines changed

‎README.md‎

Lines changed: 51 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -12,90 +12,80 @@ It uses the same approach as Zig's official autodoc (ziglang.org) by reading STD
1212
<img src="https://raw.githubusercontent.com/zig-wasm/.github/refs/heads/main/static/readme_mcp_2.gif" width="49%" />
1313
</p>
1414

15-
## Installation
16-
17-
### Claude Code
15+
## Tools
1816

19-
Using Node:
17+
- **`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.
18+
- **`get_builtin_function`** - Search for Zig builtin functions by name and get their documentation, signatures, and usage information. Returns all matching functions ranked by relevance.
19+
- **`search_std_lib`** - Search the Zig standard library for declarations by name. Returns a list of matching items with their fully qualified names. Use this to discover available types, functions, and constants in the standard library.
20+
- **`get_std_lib_item`** - Get detailed documentation for a specific standard library item by its fully qualified name (e.g., "std.ArrayList.init"). Returns comprehensive documentation including function signatures, parameters, errors, examples, and source code. Set `get_source_file: true` to retrieve the entire source file where the item is implemented.
2021

21-
```bash
22-
claude mcp add zig-docs npx -y zig-mcp@latest --version master --update-policy manual
23-
```
22+
## Commands
2423

25-
Using Bun:
24+
The CLI provides flexible options for version control and update management:
2625

2726
```bash
28-
claude mcp add zig-docs bunx zig-mcp@latest --version master --update-policy manual
29-
```
27+
# Start MCP server with defaults (master branch, manual updates)
28+
zig-mcp
3029

31-
### Roo Code
30+
# Use specific Zig version
31+
zig-mcp --version 0.14.1
3232

33-
1. Click the **MCP** button in Roo Code
34-
2. Select **"Edit Global MCP"** or **"Edit Project MCP"**
35-
3. Add the following configuration:
33+
# Enable automatic daily updates
34+
zig-mcp --update-policy daily
3635

37-
Using Node:
36+
# Update documentation without starting server
37+
zig-mcp update --version 0.15.1
3838

39-
```json
40-
{
41-
"mcpServers": {
42-
"zig-docs": {
43-
"command": "npx",
44-
"args": ["-y", "zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
45-
}
46-
}
47-
}
39+
# Start local web server to view documentation
40+
zig-mcp view --version 0.15.1
4841
```
4942

50-
Using Bun:
43+
**Version options**:
44+
- `master` (default) - Latest development version from Zig's master branch
45+
- `0.14.1`, `0.14.0`, etc. - Specific Zig release versions
5146

52-
```json
53-
{
54-
"mcpServers": {
55-
"zig-docs": {
56-
"command": "bunx",
57-
"args": ["zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
58-
}
59-
}
60-
}
61-
```
47+
**Update policies**:
48+
- `manual` (default) - No automatic updates, manual control only
49+
- `daily` - Check for documentation updates once per day
50+
- `startup` - Update documentation every time the server starts
6251

63-
### Augment Code
52+
## Cache
6453

65-
Navigate to **Settings → MCP Servers → Add Server**, or edit the configuration directly:
54+
Documentation is fetched from ziglang.org and cached in platform-specific directories:
55+
- Linux: `~/.cache/zig-mcp/`
56+
- macOS: `~/Library/Caches/zig-mcp/`
57+
- Windows: `%LOCALAPPDATA%\zig-mcp\`
6658

67-
Using Node:
59+
## Installation
6860

69-
```json
70-
{
71-
"mcpServers": {
72-
"zig-docs": {
73-
"command": "npx",
74-
"args": ["-y", "zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
75-
}
76-
}
77-
}
61+
### Claude Code
62+
Using npx (Node.js)
63+
```bash
64+
claude mcp add zig-docs npx -y zig-mcp@latest --version master --update-policy manual
7865
```
7966

80-
Using Bun:
81-
82-
```json
83-
{
84-
"mcpServers": {
85-
"zig-docs": {
86-
"command": "bunx",
87-
"args": ["zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
88-
}
89-
}
90-
}
67+
Using bunx (Bun)
68+
```bash
69+
claude mcp add zig-docs bunx zig-mcp@latest --version master --update-policy manual
9170
```
9271

72+
### Roo Code
73+
74+
1. Click the **MCP** button in Roo Code
75+
2. Select **"Edit Global MCP"** or **"Edit Project MCP"**
76+
3. Add the configuration from the JSON template below
77+
78+
### Augment Code
79+
80+
Navigate to **Settings → MCP Servers → Add Server** and use the JSON template below.
81+
9382
### Claude Desktop
9483

95-
Add to your MCP configuration:
84+
Add the JSON configuration below to your MCP settings file.
9685

97-
Using Node:
86+
### JSON Configuration Template
9887

88+
**Node.js:**
9989
```json
10090
{
10191
"mcpServers": {
@@ -107,8 +97,7 @@ Using Node:
10797
}
10898
```
10999

110-
Using Bun:
111-
100+
**Bun:**
112101
```json
113102
{
114103
"mcpServers": {
@@ -118,48 +107,3 @@ Using Bun:
118107
}
119108
}
120109
}
121-
```
122-
123-
## Tools
124-
125-
- **`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.
126-
- **`get_builtin_function`** - Search for Zig builtin functions by name and get their documentation, signatures, and usage information. Returns all matching functions ranked by relevance.
127-
- **`search_std_lib`** - Search the Zig standard library for declarations by name. Returns a list of matching items with their fully qualified names. Use this to discover available types, functions, and constants in the standard library.
128-
- **`get_std_lib_item`** - Get detailed documentation for a specific standard library item by its fully qualified name (e.g., "std.ArrayList.init"). Returns comprehensive documentation including function signatures, parameters, errors, examples, and source code. Set `get_source_file: true` to retrieve the entire source file where the item is implemented.
129-
130-
## Commands
131-
132-
The CLI provides flexible options for version control and update management:
133-
134-
```bash
135-
# Start MCP server with defaults (master branch, manual updates)
136-
zig-mcp
137-
138-
# Use specific Zig version
139-
zig-mcp --version 0.13.0
140-
141-
# Enable automatic daily updates
142-
zig-mcp --update-policy daily
143-
144-
# Update documentation without starting server
145-
zig-mcp update --version 0.14.1
146-
147-
# Start local web server to view documentation
148-
zig-mcp view --version 0.14.1
149-
```
150-
151-
**Version options**:
152-
- `master` (default) - Latest development version from Zig's master branch
153-
- `0.14.1`, `0.14.0`, etc. - Specific Zig release versions
154-
155-
**Update policies**:
156-
- `manual` (default) - No automatic updates, manual control only
157-
- `daily` - Check for documentation updates once per day
158-
- `startup` - Update documentation every time the server starts
159-
160-
## Cache
161-
162-
Documentation is fetched from ziglang.org and cached in platform-specific directories:
163-
- Linux: `~/.cache/zig-mcp/`
164-
- macOS: `~/Library/Caches/zig-mcp/`
165-
- Windows: `%LOCALAPPDATA%\zig-mcp\`

0 commit comments

Comments
 (0)