fix(docs): add -p parameter to the cargo run commands in documentation (#592)

* fix(docs): Add -p mcp-client-examples to cargo run commands in clients/README.md

* fix(docs): Add -p mcp-server-examples to cargo run commands in examples/servers/README.md

* fix(docs): Add -p parameter to cargo run commands in other documentation
This commit is contained in:
DJ Chen 2026-01-14 19:54:57 -06:00 committed by GitHub
parent e49aef65d1
commit 2d1456e5b8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 21 additions and 21 deletions

View file

@ -84,10 +84,10 @@ rmcp = { version = "0.1", features = ["auth", "transport-streamable-http-client-
```bash
# Run the OAuth server
cargo run --example servers_complex_auth_streamhttp
cargo run -p mcp-server-examples --example servers_complex_auth_streamhttp
# Run the OAuth client (in another terminal)
cargo run --example clients_oauth_client
cargo run -p mcp-client-examples --example clients_oauth_client
```
## Authorization Flow Description

View file

@ -63,7 +63,7 @@ A client demonstrating how to use the sampling tool.
A client that communicates with an MCP server using progress notifications.
- Launches the `cargo run --example clients_progress_client -- --transport {stdio|http|all}` to test the progress notifications
- Launches the `cargo run -p mcp-client-examples --example clients_progress_client -- --transport {stdio|http|all}` to test the progress notifications
- Connects to the server using different transport methods
- Tests the progress notifications
- The http transport should run the server first
@ -75,22 +75,22 @@ Each example can be run using Cargo:
```bash
# Run the Git standard I/O client example
cargo run --example clients_git_stdio
cargo run -p mcp-client-examples --example clients_git_stdio
# Run the streamable HTTP client example
cargo run --example clients_streamable_http
cargo run -p mcp-client-examples --example clients_streamable_http
# Run the full-featured standard I/O client example
cargo run --example clients_everything_stdio
cargo run -p mcp-client-examples --example clients_everything_stdio
# Run the client collection example
cargo run --example clients_collection
cargo run -p mcp-client-examples --example clients_collection
# Run the OAuth client example
cargo run --example clients_oauth_client
cargo run -p mcp-client-examples --example clients_oauth_client
# Run the sampling standard I/O client example
cargo run --example clients_sampling_stdio
cargo run -p mcp-client-examples --example clients_sampling_stdio
```
## Dependencies

View file

@ -97,7 +97,7 @@ async fn main() -> Result<()> {
// Get server URL and client metadata URL from CLI (with defaults)
//
// Usage:
// cargo run --example clients_oauth_client -- <server_url> <client_metadata_url>
// cargo run -p mcp-client-examples --example clients_oauth_client -- <server_url> <client_metadata_url>
let args: Vec<String> = env::args().collect();
let server_url = args
.get(1)

View file

@ -200,7 +200,7 @@ async fn test_stdio_transport(records: u32) -> Result<()> {
Ok(())
}
// Test HTTP transport, must run the server with `cargo run --example servers_progress_demo -- http` in the servers directory
// Test HTTP transport, must run the server with `cargo run -p mcp-client-examples --example servers_progress_demo -- http` in the servers directory
async fn test_http_transport(http_url: &str, records: u32) -> Result<()> {
tracing::info!("Testing HTTP Streaming Transport");
tracing::info!("=====================================");

View file

@ -12,7 +12,7 @@ use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
///
/// This client demonstrates how to handle sampling requests from servers.
/// It includes a mock LLM that generates simple responses.
/// Run with: cargo run --example clients_sampling_stdio
/// Run with: cargo run -p mcp-client-examples --example clients_sampling_stdio
#[derive(Clone, Debug, Default)]
pub struct SamplingDemoClient;

View file

@ -68,7 +68,7 @@ A server that demonstrates progress notifications during long-running operations
- Provides a stream_processor tool that generates progress notifications
- Demonstrates progress notifications during long-running operations
- Can be run with `cargo run --example servers_progress_demo -- {stdio|http|all}`
- Can be run with `cargo run -p mcp-server-examples --example servers_progress_demo -- {stdio|http|all}`
### Simple Auth Streamable HTTP Server (`simple_auth_streamhttp.rs`)
@ -95,25 +95,25 @@ Each example can be run using Cargo:
```bash
# Run the counter standard I/O server
cargo run --example servers_counter_stdio
cargo run -p mcp-server-examples --example servers_counter_stdio
# Run the memory standard I/O server
cargo run --example servers_memory_stdio
cargo run -p mcp-server-examples --example servers_memory_stdio
# Run the counter streamable HTTP server
cargo run --example servers_counter_streamhttp
cargo run -p mcp-server-examples --example servers_counter_streamhttp
# Run the elicitation standard I/O server
cargo run --example servers_elicitation_stdio
cargo run -p mcp-server-examples --example servers_elicitation_stdio
# Run the prompt standard I/O server
cargo run --example servers_prompt_stdio
cargo run -p mcp-server-examples --example servers_prompt_stdio
# Run the simple auth streamable HTTP server
cargo run --example servers_simple_auth_streamhttp
cargo run -p mcp-server-examples --example servers_simple_auth_streamhttp
# Run the complex auth streamable HTTP server
cargo run --example servers_complex_auth_streamhttp
cargo run -p mcp-server-examples --example servers_complex_auth_streamhttp
```
## Testing with MCP Inspector

View file

@ -12,7 +12,7 @@ use tracing_subscriber::{self, EnvFilter};
/// Simple Sampling Demo Server
///
/// This server demonstrates how to request LLM sampling from clients.
/// Run with: cargo run --example servers_sampling_stdio
/// Run with: cargo run -p mcp-server-examples --example servers_sampling_stdio
#[derive(Clone, Debug, Default)]
pub struct SamplingDemoServer;