RMCP

A better and clean rust Model Context Protocol SDK implementation with tokio async runtime.

Comparing to official SDK

The Official SDK has too much limit and it was originally built for goose rather than general using purpose.

All the features listed on specification would be implemented in this crate. And the first and most important thing is, this crate has the correct and intact data types. See it yourself.

Usage

Import from github

rmcp = { version = "0.1", features = ["server"] }

Quick start

1. Build a transport

The transport type must implemented [IntoTransport] trait, which allow split into a sink and a stream.

For client, the sink item is ClientJsonRpcMessage and stream item is ServerJsonRpcMessage

For server, the sink item is ServerJsonRpcMessage and stream item is ClientJsonRpcMessage

These types is automatically implemented [IntoTransport] trait

1. For type that already implement both [Sink] and [Stream] trait, they are automatically implemented [IntoTransport] trait
2. For tuple of sink Tx and stream Rx, type (Tx, Rx) are automatically implemented [IntoTransport] trait
3. For type that implement both [tokio::io::AsyncRead] and [tokio::io::AsyncWrite] trait, they are automatically implemented [IntoTransport] trait
4. For tuple of [tokio::io::AsyncRead] R and [tokio::io::AsyncWrite] W, type (R, W) are automatically implemented [IntoTransport] trait

use tokio::io::{stdin, stdout};
let transport = (stdin(), stdout());

2. Build a service

You can easily build a service by using ServerHandlerService or ClientHandlerService.

use rmcp::ServerHandlerService;
let service = ServerHandlerService::new(common::counter::Counter::new());

You can reference the server examples.

3. Serve them together

// this call will finish the initialization process
let server = rmcp::serve_server(service, transport).await?;

4. Interact with the server

Once the server is initialized, you can send requests or notifications:

// request 
let roots = server.list_roots().await?;

// or send notification
server.notify_cancelled(...).await?;

5. Waiting for service shutdown

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.

use rmcp::{ServerHandler, model::ServerInfo, schemars, tool, tool_box};

use super::counter::Counter;

#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
pub struct SumRequest {
    #[schemars(description = "the left hand side number")]
    pub a: i32,
    pub b: i32,
}
#[derive(Debug, Clone)]
pub struct Calculator;
impl Calculator {
    // async function
    #[tool(description = "Calculate the sum of two numbers")]
    fn async sum(&self, #[tool(aggr)] SumRequest { a, b }: SumRequest) -> String {
        (a + b).to_string()
    }

    // sync function
    #[tool(description = "Calculate the sum of two numbers")]
    fn sub(
        &self,
        #[tool(param)]
        // this macro will transfer the schemars and serde's attributes
        #[schemars(description = "the left hand side number")]
        a: i32,
        #[tool(param)]
        #[schemars(description = "the left hand side number")]
        b: i32,
    ) -> String {
        (a - b).to_string()
    }

    // create a static toolbox to store the tool attributes
    tool_box!(Calculator { sum, sub });
}

impl ServerHandler for Calculator {
    // impl call_tool and list_tool by querying static toolbox
    tool_box!(@derive);
    fn get_info(&self) -> ServerInfo {
        ServerInfo {
            instructions: Some("A simple calculator".into()),
            ..Default::default()
        }
    }
}

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.

If you return a type of Result<T, E> where T and E both implemented IntoContents, it's also OK.

Examples

See examples

Features

• client: use client side sdk
• server: use server side sdk

Related Resources

• MCP Specification

• Schema