Merge remote-tracking branch 'upstream/main' into revision-2025-03-26

Author: 4t145

.github/workflows/ci.yml

@@ -56,15 +56,7 @@ jobs:
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
 
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: ${{ runner.os }}-cargo-
+      - uses: Swatinem/rust-cache@v2
 
       - name: Run clippy
         run: cargo clippy --all-targets --all-features -- -D warnings
@@ -93,19 +85,28 @@ jobs:
       - name: Create venv for python
         run: uv venv
 
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: ${{ runner.os }}-cargo-
+      - uses: Swatinem/rust-cache@v2
 
       - name: Run tests
         run: cargo test --all-features
 
+  doc:
+    name: Generate Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Generate documentation
+        run: |
+          cargo doc --no-deps -p rmcp -p rmcp-macros
+        env:
+          RUSTDOCFLAGS: -Dwarnings
+
   release:
     name: Release crates
     runs-on: ubuntu-latest
@@ -117,15 +118,7 @@ jobs:
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
 
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: ${{ runner.os }}-cargo-
+      - uses: Swatinem/rust-cache@v2
 
       - name: Cargo login
         run: cargo login ${{ secrets.CRATES_TOKEN }}
@@ -146,4 +139,4 @@ jobs:
       - name: Publish rmcp
         if: ${{ startsWith(github.ref, 'refs/tags/release') }}
         continue-on-error: true 
-        run: cargo publish -p rmcp 
+        run: cargo publish -p rmcp 

Cargo.toml

@@ -1,4 +1,4 @@
-cargo-features = ["edition2024"]
+
 
 [workspace]
 members = ["crates/rmcp", "crates/rmcp-macros", "examples/*"]

README.md

@@ -3,6 +3,7 @@
 </div>
 
 # RMCP
+
 [![Crates.io Version](https://img.shields.io/crates/v/rmcp)](https://crates.io/crates/rmcp)
 ![Release status](https://github.com/modelcontextprotocol/rust-sdk/actions/workflows/release.yml/badge.svg)
 [![docs.rs](https://img.shields.io/docsrs/rmcp)](https://docs.rs/rmcp/latest/rmcp)
@@ -12,21 +13,28 @@ An official rust Model Context Protocol SDK implementation with tokio async runt
 ## Usage
 
 ### Import
+
 ```toml
 rmcp = { version = "0.1", features = ["server"] }
 ## or dev channel
 rmcp = { git = "https://github.com/modelcontextprotocol/rust-sdk", branch = "main" }
 ```
 
 ### Quick start
+
 Start a client in one line:
+
 ```rust
 use rmcp::{ServiceExt, transport::TokioChildProcess};
 use tokio::process::Command;
 
-let client = ().serve(
-    TokioChildProcess::new(Command::new("npx").arg("-y").arg("@modelcontextprotocol/server-everything"))?
-).await?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let client = ().serve(
+        TokioChildProcess::new(Command::new("npx").arg("-y").arg("@modelcontextprotocol/server-everything"))?
+    ).await?;
+    Ok(())
+}
 ```
 
 #### 1. Build a transport
@@ -43,48 +51,55 @@ For client, the sink item is [`ClientJsonRpcMessage`](crate::model::ClientJsonRp
 For server, the sink item is [`ServerJsonRpcMessage`](crate::model::ServerJsonRpcMessage) and stream item is [`ClientJsonRpcMessage`](crate::model::ClientJsonRpcMessage)
 
 ##### These types is automatically implemented [`IntoTransport`](crate::transport::IntoTransport) trait
+
 1. The types that already implement both [`Sink`](futures::Sink) and [`Stream`](futures::Stream) trait.
 2. A tuple of sink `Tx` and stream `Rx`: `(Tx, Rx)`.
 3. The type that implement both [`tokio::io::AsyncRead`] and [`tokio::io::AsyncWrite`] trait.
-4. A tuple of [`tokio::io::AsyncRead`] `R `and [`tokio::io::AsyncWrite`] `W`:  `(R, W)`.
+4. A tuple of [`tokio::io::AsyncRead`] `R `and [`tokio::io::AsyncWrite`] `W`: `(R, W)`.
 
 For example, you can see how we build a transport through TCP stream or http upgrade so easily. [examples](examples/README.md)
 
 #### 2. Build a service
+
 You can easily build a service by using [`ServerHandler`](crates/rmcp/src/handler/server.rs) or [`ClientHandler`](crates/rmcp/src/handler/client.rs).
 
 ```rust, ignore
 let service = common::counter::Counter::new();
 ```
 
 #### 3. Serve them together
+
 ```rust, ignore
 // this call will finish the initialization process
 let server = service.serve(transport).await?;
 ```
 
 #### 4. Interact with the server
+
 Once the server is initialized, you can send requests or notifications:
 
 ```rust, ignore
-// request 
+// request
 let roots = server.list_roots().await?;
 
 // or send notification
 server.notify_cancelled(...).await?;
 ```
 
 #### 5. Waiting for service shutdown
+
 ```rust, ignore
 let quit_reason = server.waiting().await?;
 // or cancel it
 let quit_reason = server.cancel().await?;
 ```
 
 ### Use marcos to declaring tool
+
 Use `toolbox` and `tool` macros to create tool quickly.
 
 Check this [file](examples/servers/src/common/calculator.rs).
+
 ```rust, ignore
 use rmcp::{ServerHandler, model::ServerInfo, schemars, tool};
 
@@ -137,33 +152,39 @@ impl ServerHandler for Calculator {
 }
 
 ```
+
 The only thing you should do is to make the function's return type implement `IntoCallToolResult`.
 
-And you can just implement `IntoContents`, and the return value will be marked as success automatically. 
+And you can just implement `IntoContents`, and the return value will be marked as success automatically.
 
 If you return a type of `Result<T, E>` where `T` and `E` both implemented `IntoContents`, it's also OK.
 
 ### Manage Multi Services
+
 For many cases you need to manage several service in a collection, you can call `into_dyn` to convert services into the same type.
+
 ```rust, ignore
 let service = service.into_dyn();
 ```
 
-
 ### Examples
+
 See [examples](examples/README.md)
 
 ### Features
+
 - `client`: use client side sdk
 - `server`: use server side sdk
 - `macros`: macros default
+
 #### Transports
+
 - `transport-io`: Server stdio transport
 - `transport-sse-server`: Server SSE transport
 - `transport-child-process`: Client stdio transport
 - `transport-sse`: Client sse transport
 
 ## Related Resources
-- [MCP Specification](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
 
+- [MCP Specification](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
 - [Schema](https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.ts)

crates/rmcp-macros/Cargo.toml

@@ -1,4 +1,4 @@
-cargo-features = ["edition2024"]
+
 
 [package]
 name = "rmcp-macros"

crates/rmcp-macros/src/tool.rs

@@ -347,7 +347,7 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
             #input_fn_vis fn #tool_attr_fn_ident() -> rmcp::model::Tool {
                 rmcp::model::Tool {
                     name: #name.into(),
-                    description: #description.into(),
+                    description: Some(#description.into()),
                     input_schema: #schema.into(),
                     annotations: None
                 }

crates/rmcp/Cargo.toml

@@ -1,4 +1,4 @@
-cargo-features = ["edition2024"]
+
 
 [package]
 name = "rmcp"
@@ -95,5 +95,11 @@ path = "tests/test_with_python.rs"
 
 [[test]]
 name = "test_with_js"
-required-features = ["server", "transport-sse-server"]
-path = "tests/test_with_js.rs"
+required-features = ["server", "client", "transport-sse-server", "transport-child-process"]
+path = "tests/test_with_js.rs"
+
+[[test]]
+name = "test_notification"
+required-features = ["server", "client"]
+path = "tests/test_notification.rs"
+