Skip to content

Commit 3552728

Browse files
committed
feat(docs): Adjust installation commands
1 parent f793a61 commit 3552728

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22

33
Model Context Protocol (MCP) server that provides up-to-date documentation for the Zig programming language standard library and builtin functions.
44

5+
It uses the same approach as Zig's official autodoc (ziglang.org) by reading STD lib source files directly through a WASM module. However instead of returning HTML, it outputs Markdown which significantly reduces token usage.
6+
57
> [!TIP]
68
> Add `use zigdocs` to your prompt if you want to explicitly instruct the LLM to use Zig docs tools. Otherwise, LLM will automatically decide when to utilize MCP tools based on the context of your questions.
79
10+
<p align="center" width="100%">
11+
<img src="https://raw.githubusercontent.com/zig-wasm/.github/refs/heads/main/static/readme_mcp_1.gif" width="49%" />
12+
<img src="https://raw.githubusercontent.com/zig-wasm/.github/refs/heads/main/static/readme_mcp_2.gif" width="49%" />
13+
</p>
14+
815
## Installation
916

1017
### Claude Code
1118
```bash
12-
claude mcp add zig-docs npx -y zig-docs-mcp --version master --update-policy manual
19+
claude mcp add zig-docs npx -y zig-mcp@latest --version master --update-policy manual
1320
```
1421

1522
### Claude Desktop
@@ -19,7 +26,7 @@ Add to your MCP configuration:
1926
"mcpServers": {
2027
"zig-docs": {
2128
"command": "npx",
22-
"args": ["-y", "zig-docs-mcp", "--version", "master", "--update-policy", "manual"]
29+
"args": ["-y", "zig-mcp@latest", "--version", "master", "--update-policy", "manual"]
2330
}
2431
}
2532
}
@@ -38,19 +45,19 @@ The CLI provides flexible options for version control and update management:
3845

3946
```bash
4047
# Start MCP server with defaults (master branch, manual updates)
41-
zig-docs-mcp
48+
zig-mcp
4249

4350
# Use specific Zig version
44-
zig-docs-mcp --version 0.13.0
51+
zig-mcp --version 0.13.0
4552

4653
# Enable automatic daily updates
47-
zig-docs-mcp --update-policy daily
54+
zig-mcp --update-policy daily
4855

4956
# Update documentation without starting server
50-
zig-docs-mcp update --version 0.14.1
57+
zig-mcp update --version 0.14.1
5158

5259
# Start local web server to view documentation
53-
zig-docs-mcp view --version 0.14.1
60+
zig-mcp view --version 0.14.1
5461
```
5562

5663
**Version options**:
@@ -65,6 +72,6 @@ zig-docs-mcp view --version 0.14.1
6572
## Cache
6673

6774
Documentation is fetched from ziglang.org and cached in platform-specific directories:
68-
- Linux: `~/.cache/zig-docs-mcp/`
69-
- macOS: `~/Library/Caches/zig-docs-mcp/`
70-
- Windows: `%LOCALAPPDATA%\zig-docs-mcp\`
75+
- Linux: `~/.cache/zig-mcp/`
76+
- macOS: `~/Library/Caches/zig-mcp/`
77+
- Windows: `%LOCALAPPDATA%\zig-mcp\`

0 commit comments

Comments
 (0)