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

Author: 4t145

.devcontainer/devcontainer.json

@@ -0,0 +1,41 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/rust
+{
+	"name": "Rust",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/rust:1-1-bullseye",
+	"features": {
+		"ghcr.io/devcontainers/features/node:1": {},
+		"ghcr.io/devcontainers/features/python:1": {
+			"version": "3.10",
+			"toolsToInstall": "uv"
+		}
+	},
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"editor.formatOnSave": true,
+				"[rust]": {
+					"editor.defaultFormatter": "rust-lang.rust-analyzer"
+				}
+			}
+		}
+	},
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "uv venv"
+	// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
+	// "mounts": [
+	// 	{
+	// 		"source": "devcontainer-cargo-cache-${devcontainerId}",
+	// 		"target": "/usr/local/cargo",
+	// 		"type": "volume"
+	// 	}
+	// ]
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/workflows/ci.yml

@@ -60,6 +60,14 @@ jobs:
 
       - name: Run clippy
         run: cargo clippy --all-targets --all-features -- -D warnings
+  
+  spelling:
+    name: spell check with typos
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Spell Check Repo
+      uses: crate-ci/typos@master
 
   test:
     name: Run Tests

README.md

@@ -188,3 +188,7 @@ See [examples](examples/README.md)
 
 - [MCP Specification](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
 - [Schema](https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.ts)
+
+## Development with Dev Container
+
+See [docs/DEVCONTAINER.md](docs/DEVCONTAINER.md) for instructions on using Dev Container for development.

crates/rmcp-macros/src/tool.rs

@@ -213,11 +213,11 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
     // let mut fommated_fn_args: Punctuated<FnArg, Comma> = Punctuated::new();
     let mut unextractable_args_indexes = HashSet::new();
     for (index, mut fn_arg) in input_fn.sig.inputs.iter_mut().enumerate() {
-        enum Catched {
+        enum Caught {
             Param(ToolFnParamAttrs),
             Aggregated(PatType),
         }
-        let mut catched = None;
+        let mut caught = None;
         match &mut fn_arg {
             FnArg::Receiver(_) => {
                 continue;
@@ -244,15 +244,15 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
                                                 "input param must have an ident as name",
                                             ));
                                         };
-                                        catched.replace(Catched::Param(ToolFnParamAttrs {
+                                        caught.replace(Caught::Param(ToolFnParamAttrs {
                                             serde_meta: Vec::new(),
                                             schemars_meta: Vec::new(),
                                             ident: arg_ident,
                                             rust_type: pat_type.ty.clone(),
                                         }));
                                     }
                                     ParamMarker::Aggregated => {
-                                        catched.replace(Catched::Aggregated(pat_type.clone()));
+                                        caught.replace(Caught::Aggregated(pat_type.clone()));
                                     }
                                 }
                             } else if meta_list.path.is_ident(SERDE_IDENT) {
@@ -268,8 +268,8 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
                         }
                     }
                 }
-                match catched {
-                    Some(Catched::Param(mut param)) => {
+                match caught {
+                    Some(Caught::Param(mut param)) => {
                         param.serde_meta = serde_metas;
                         param.schemars_meta = schemars_metas;
                         match &mut tool_macro_attrs.params {
@@ -282,7 +282,7 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
                         }
                         unextractable_args_indexes.insert(index);
                     }
-                    Some(Catched::Aggregated(rust_type)) => {
+                    Some(Caught::Aggregated(rust_type)) => {
                         tool_macro_attrs.params = ToolParams::Aggregated { rust_type };
                         unextractable_args_indexes.insert(index);
                     }
@@ -361,7 +361,7 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
         // async fn #tool_tool_call(context: rmcp::handler::server::tool::ToolCallContext<'_, Self>)
         //      -> std::result::Result<rmcp::model::CallToolResult, rmcp::Error>
         //
-        // and the block part shoule be like:
+        // and the block part should be like:
         // {
         //      use rmcp::handler::server::tool::*;
         //      let (t0, context) = <T0>::from_tool_call_context_part(context)?;

crates/rmcp/tests/test_complex_schema.rs

@@ -44,7 +44,7 @@ impl Demo {
 fn test_complex_schema() {
     let attr = Demo::chat_tool_attr();
     let input_schema = attr.input_schema;
-    let enum_numer = input_schema
+    let enum_number = input_schema
         .get("definitions")
         .unwrap()
         .as_object()
@@ -58,6 +58,6 @@ fn test_complex_schema() {
         .as_array()
         .unwrap()
         .len();
-    assert_eq!(enum_numer, 4);
+    assert_eq!(enum_number, 4);
     println!("{}", serde_json::to_string_pretty(&input_schema).unwrap());
 }

docs/DEVCONTAINER.md

@@ -0,0 +1,55 @@
+## Development with Dev Container and GitHub Codespaces
+
+This repository provides a Dev Container to easily set up a development environment. Using Dev Container allows you to work in a consistent development environment with pre-configured dependencies and tools, whether locally or in the cloud with GitHub Codespaces.
+
+### Prerequisites
+
+**For Local Development:**
+
+* [Docker Desktop](https://www.docker.com/products/docker-desktop/) or any other compatible container runtime (e.g., Podman, OrbStack) installed.
+* [Visual Studio Code](https://code.visualstudio.com/) with the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed.
+
+**For GitHub Codespaces:**
+
+* A GitHub account.
+
+### Starting Dev Container
+
+**Using Visual Studio Code (Local):**
+
+1.  Clone the repository.
+2.  Open the repository in Visual Studio Code.
+3.  Open the command palette in Visual Studio Code (`Ctrl + Shift + P` or `Cmd + Shift + P`) and execute `Dev Containers: Reopen in Container`.
+
+**Using GitHub Codespaces (Cloud):**
+
+1.  Navigate to the repository on GitHub.
+2.  Click the "<> Code" button.
+3.  Select the "Codespaces" tab.
+4.  Click "Create codespace on main" (or your desired branch).
+
+### Dev Container Configuration
+
+Dev Container settings are configured in `.devcontainer/devcontainer.json`. In this file, you can set the Docker image to use, extensions to install, port forwarding, and more. This configuration is used both for local development and GitHub Codespaces.
+
+### Development
+
+Once the Dev Container is started, you can proceed with development as usual. The container already has the necessary tools and libraries installed. In GitHub Codespaces, you will have a fully configured VS Code in your browser or desktop application.
+
+### Stopping Dev Container
+
+**Using Visual Studio Code (Local):**
+
+To stop the Dev Container, open the command palette in Visual Studio Code and execute `Remote: Close Remote Connection`.
+
+**Using GitHub Codespaces (Cloud):**
+
+GitHub Codespaces will automatically stop after a period of inactivity. You can also manually stop the codespace from the Codespaces menu in GitHub.
+
+### More Information
+
+* [Visual Studio Code Dev Containers](https://code.visualstudio.com/docs/remote/containers)
+* [Dev Container Specification](https://containers.dev/implementors/json_reference/)
+* [GitHub Codespaces](https://github.com/features/codespaces)
+
+This document describes the basic usage of Dev Container and GitHub Codespaces. Add project-specific settings and procedures as needed.

examples/rig-integration/src/chat.rs

@@ -74,17 +74,24 @@ pub async fn output_error(
     e: impl std::fmt::Display,
     output: &mut BufWriter<tokio::io::Stdout>,
 ) -> std::io::Result<()> {
-    output.write_all(b"\x1b[31mERROR: \x1b[0m").await?;
+    output
+        .write_all(b"\x1b[1;31m\xE2\x9D\x8C ERROR: \x1b[0m")
+        .await?;
     output.write_all(e.to_string().as_bytes()).await?;
     output.write_all(b"\n").await?;
+    output.flush().await?;
     Ok(())
 }
 
 pub async fn output_agent(
     content: impl std::fmt::Display,
     output: &mut BufWriter<tokio::io::Stdout>,
 ) -> std::io::Result<()> {
+    output
+        .write_all(b"\x1b[1;34m\xF0\x9F\xA4\x96 Agent: \x1b[0m")
+        .await?;
     output.write_all(content.to_string().as_bytes()).await?;
+    output.write_all(b"\n").await?;
     output.flush().await?;
     Ok(())
 }
@@ -93,22 +100,29 @@ pub async fn stream_output_toolcall(
     content: impl std::fmt::Display,
     output: &mut BufWriter<tokio::io::Stdout>,
 ) -> std::io::Result<()> {
-    output.write_all(b"\x1b[33mtool>\x1b[0m ").await?;
+    output
+        .write_all(b"\x1b[1;33m\xF0\x9F\x9B\xA0 Tool Call: \x1b[0m")
+        .await?;
     output.write_all(content.to_string().as_bytes()).await?;
     output.write_all(b"\n").await?;
+    output.flush().await?;
     Ok(())
 }
 
 pub async fn stream_output_agent_start(
     output: &mut BufWriter<tokio::io::Stdout>,
 ) -> std::io::Result<()> {
-    output.write_all(b"\x1b[34magent>\x1b[0m ").await?;
+    output
+        .write_all(b"\x1b[1;34m\xF0\x9F\xA4\x96 Agent: \x1b[0m")
+        .await?;
+    output.flush().await?;
     Ok(())
 }
 
 pub async fn stream_output_agent_finished(
     output: &mut BufWriter<tokio::io::Stdout>,
 ) -> std::io::Result<()> {
     output.write_all(b"\n").await?;
+    output.flush().await?;
     Ok(())
 }

examples/rig-integration/src/config.rs

@@ -12,7 +12,7 @@ pub struct Config {
 }
 
 impl Config {
-    pub async fn retrive(path: impl AsRef<Path>) -> anyhow::Result<Self> {
+    pub async fn retrieve(path: impl AsRef<Path>) -> anyhow::Result<Self> {
         let content = tokio::fs::read_to_string(path).await?;
         let config: Self = toml::from_str(&content)?;
         Ok(config)

examples/rig-integration/src/main.rs

@@ -11,7 +11,7 @@ pub mod config;
 pub mod mcp_adaptor;
 #[tokio::main]
 async fn main() -> anyhow::Result<()> {
-    let config = config::Config::retrive("config.toml").await?;
+    let config = config::Config::retrieve("config.toml").await?;
     let openai_client = {
         if let Some(key) = config.deepseek_key {
             deepseek::Client::new(&key)

examples/servers/src/common/calculator.rs

@@ -20,14 +20,14 @@ impl Calculator {
         (a + b).to_string()
     }
 
-    #[tool(description = "Calculate the sum of two numbers")]
+    #[tool(description = "Calculate the sub of two numbers")]
     fn sub(
         &self,
         #[tool(param)]
         #[schemars(description = "the left hand side number")]
         a: i32,
         #[tool(param)]
-        #[schemars(description = "the left hand side number")]
+        #[schemars(description = "the right hand side number")]
         b: i32,
     ) -> Json<i32> {
         Json(a - b)