rust-sdk/examples/README.md
jokemanfire 0d52b7d24f
fix(examples): add clients in examples's readme (#225)
Signed-off-by: jokemanfire <hu.dingyang@zte.com.cn>
2025-05-26 18:32:29 +08:00

85 lines
1.8 KiB
Markdown

# 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** `PATH-TO/claude_desktop_config.json`
Windows
```json
{
"mcpServers": {
"counter": {
"command": "PATH-TO/rust-sdk/target/release/examples/servers_std_io.exe",
"args": []
}
}
}
```
MacOS/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. It may require to restart Claude for Desktop.
4. **Once Claude Desktop is running, try chatting:**
```text
counter.say_hello
```
Or test other tools like:
```texts
counter.increment
counter.get_value
counter.sum {"a": 3, "b": 4}
```
# Client Examples
see [clients/README.md](clients/README.md)
# Server Examples
- [Server SSE](servers/src/axum.rs), using axum as web server.
- [Server stdio](servers/src/std_io.rs), using tokio async io.
# Transport Examples
- [Tcp](transport/src/tcp.rs)
- [Transport on http upgrade](transport/src/http_upgrade.rs)
- [Unix Socket](transport/src/unix_socket.rs)
- [Websocket](transport/src/websocket.rs)
# Integration
- [Rig](examples/rig-integration) A stream chatbot with rig
- [Simple Chat Client](examples/simple-chat-client) A simple chat client implementation using the Model Context Protocol (MCP) SDK.
# WASI
- [WASI-P2 runtime](wasi) How it works with wasip2
## Use Mcp Inspector
```sh
npx @modelcontextprotocol/inspector
```