diff --git a/examples/README.md b/examples/README.md index 123c1686..7498243f 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,36 +1,57 @@ # Quick Start With Claude Desktop 1. **Build the Server (Counter Example)** - ```sh - cargo build --release --example servers_std_io - ``` - This builds a standard input/output MCP server binary. - -2. **Add or update this section in your** `~/.config/claude-desktop/config.toml` (Linux) or `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) - ```json - { - "mcpServers": { - "counter": { - "command": "PATH-TO/rust-sdk/target/release/examples/servers_std_io.exe", - "args": [] - } - } - } - ``` + + ```sh + cargo build --release --example servers_std_io + ``` + + This builds a standard input/output MCP server binary. + +2. **Add or update this section in your** `PATH-TO/claude_desktop_config.json` + + Windows + + ```json + { + "mcpServers": { + "counter": { + "command": "PATH-TO/rust-sdk/target/release/examples/servers_std_io.exe", + "args": [] + } + } + } + ``` + + McOS/Linux + + ```json + { + "mcpServers": { + "counter": { + "command": "PATH-TO/rust-sdk/target/release/examples/servers_std_io", + "args": [] + } + } + } + ``` 3. **Ensure that the MCP UI elements appear in Claude Desktop** - The MCP UI elements will only show up in Claude for Desktop if at least one server is properly configured. + The MCP UI elements will only show up in Claude for Desktop if at least one server is properly configured. 4. **Once Claude Desktop is running, try chatting:** - ```text - counter.say_hello - ``` - Or test other tools like: - ```text - counter.increment - counter.get_value - counter.sum {"a": 3, "b": 4} - ``` + + ```text + counter.say_hello + ``` + + Or test other tools like: + + ```texts + counter.increment + counter.get_value + counter.sum {"a": 3, "b": 4} + ``` # Client Examples