diff --git a/README.md b/README.md index d355d00..bd176a1 100644 --- a/README.md +++ b/README.md @@ -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": { @@ -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.