Skip to content

Fix typo for Claude desktop config file path correction and add more example for Windows, Linux, and MacOS #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 9, 2025
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
73 changes: 47 additions & 26 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading