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:
parent
e49aef65d1
commit
2d1456e5b8
7 changed files with 21 additions and 21 deletions
|
|
@ -84,10 +84,10 @@ rmcp = { version = "0.1", features = ["auth", "transport-streamable-http-client-
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run the OAuth server
|
# 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)
|
# 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
|
## Authorization Flow Description
|
||||||
|
|
|
||||||
|
|
@ -63,7 +63,7 @@ A client demonstrating how to use the sampling tool.
|
||||||
|
|
||||||
A client that communicates with an MCP server using progress notifications.
|
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
|
- Connects to the server using different transport methods
|
||||||
- Tests the progress notifications
|
- Tests the progress notifications
|
||||||
- The http transport should run the server first
|
- The http transport should run the server first
|
||||||
|
|
@ -75,22 +75,22 @@ Each example can be run using Cargo:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run the Git standard I/O client example
|
# 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
|
# 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
|
# 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
|
# Run the client collection example
|
||||||
cargo run --example clients_collection
|
cargo run -p mcp-client-examples --example clients_collection
|
||||||
|
|
||||||
# Run the OAuth client example
|
# 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
|
# 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
|
## Dependencies
|
||||||
|
|
|
||||||
|
|
@ -97,7 +97,7 @@ async fn main() -> Result<()> {
|
||||||
// Get server URL and client metadata URL from CLI (with defaults)
|
// Get server URL and client metadata URL from CLI (with defaults)
|
||||||
//
|
//
|
||||||
// Usage:
|
// 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 args: Vec<String> = env::args().collect();
|
||||||
let server_url = args
|
let server_url = args
|
||||||
.get(1)
|
.get(1)
|
||||||
|
|
|
||||||
|
|
@ -200,7 +200,7 @@ async fn test_stdio_transport(records: u32) -> Result<()> {
|
||||||
Ok(())
|
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<()> {
|
async fn test_http_transport(http_url: &str, records: u32) -> Result<()> {
|
||||||
tracing::info!("Testing HTTP Streaming Transport");
|
tracing::info!("Testing HTTP Streaming Transport");
|
||||||
tracing::info!("=====================================");
|
tracing::info!("=====================================");
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
|
||||||
///
|
///
|
||||||
/// This client demonstrates how to handle sampling requests from servers.
|
/// This client demonstrates how to handle sampling requests from servers.
|
||||||
/// It includes a mock LLM that generates simple responses.
|
/// 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)]
|
#[derive(Clone, Debug, Default)]
|
||||||
pub struct SamplingDemoClient;
|
pub struct SamplingDemoClient;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -68,7 +68,7 @@ A server that demonstrates progress notifications during long-running operations
|
||||||
|
|
||||||
- Provides a stream_processor tool that generates progress notifications
|
- Provides a stream_processor tool that generates progress notifications
|
||||||
- Demonstrates progress notifications during long-running operations
|
- 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`)
|
### Simple Auth Streamable HTTP Server (`simple_auth_streamhttp.rs`)
|
||||||
|
|
||||||
|
|
@ -95,25 +95,25 @@ Each example can be run using Cargo:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run the counter standard I/O server
|
# 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
|
# 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
|
# 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
|
# 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
|
# 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
|
# 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
|
# 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
|
## Testing with MCP Inspector
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ use tracing_subscriber::{self, EnvFilter};
|
||||||
/// Simple Sampling Demo Server
|
/// Simple Sampling Demo Server
|
||||||
///
|
///
|
||||||
/// This server demonstrates how to request LLM sampling from clients.
|
/// 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)]
|
#[derive(Clone, Debug, Default)]
|
||||||
pub struct SamplingDemoServer;
|
pub struct SamplingDemoServer;
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue