rust-sdk/examples/README.md

2 KiB

Model Context Protocol Examples

This directory contains examples demonstrating how to use the Model Context Protocol (MCP) Rust SDK.

Structure

  • clients/: Examples of MCP clients
  • servers/: Examples of MCP servers
  • macros/: Examples of MCP macros

Running Client Examples

The client examples demonstrate different ways to connect to MCP servers.

Available Examples

You can run the examples in two ways:

Option 1: From the examples/clients directory

cd examples/clients
cargo run --example clients
cargo run --example sse
cargo run --example stdio
cargo run --example stdio_integration

Option 2: From the root directory

cargo run -p mcp-client-examples --example clients
cargo run -p mcp-client-examples --example sse
cargo run -p mcp-client-examples --example stdio
cargo run -p mcp-client-examples --example stdio_integration

Running Server Examples

The server examples demonstrate how to implement MCP servers.

Available Examples

You can run the server examples in two ways:

Option 1: From the examples/servers directory

cd examples/servers
cargo run --example counter-server

Option 2: From the root directory

cargo run -p mcp-server-examples --example counter-server

Running Macros Examples

The macros examples demonstrate how to use the MCP macros to create tools.

Available Examples

You can run the macros examples in two ways:

Option 1: From the examples/macros directory

cd examples/macros
cargo run --example calculator

Option 2: From the root directory

cargo run -p mcp-macros-examples --example calculator

Notes

  • Some examples may require additional setup or running both client and server components.
  • The server examples use standard I/O for communication, so they can be connected to client examples using stdio transport.
  • For SSE examples, you may need to run a separate SSE server or use a compatible MCP server implementation.