MCP Sdk Rs

🚀 模型上下文协议（MCP）Rust SDK

模型上下文协议（MCP）Rust SDK 由 Rust 实现，致力于达成 AI 模型与其运行时环境间的无缝通信。不过需要注意的是，此 SDK 目前仍在开发中，尚未可投入生产使用。

🚀 快速开始

客户端示例

use mcp_sdk_rs::{Client, transport::WebSocketTransport};

#[tokio::main]
async fn main() -> Result<(), Error> {
    // 创建一个传输层实例
    let transport = WebSocketTransport::new(self.url.as_str())
        .await
        .map_err(|_| Error::Internal)?;

    //创建用于客户端和会话之间通信的mpsc通道
    let (request_tx, request_rx): (UnboundedSender<Message>, UnboundedReceiver<Message>) =
        tokio::sync::mpsc::unbounded_channel();
    let (response_tx, response_rx): (UnboundedSender<Message>, UnboundedReceiver<Message>) =
        tokio::sync::mpsc::unbounded_channel();

    // 创建并启动会话
    // 可选地传递一个ClientHandler的实现来处理自定义请求和通知
    let session = Session::new(Arc::new(transport), response_tx, request_rx, None);
    session.start().await.map_err(|_| Error::Internal)?;

    // 创建客户端并发送请求，接收通知等
    let client = Client::new(request_tx, response_rx);
    let response = client.request(
        "tools/call",
        Some(json!({
            "name": "methondName",
            "arguments": json!({})
        })),
    )
    .await?
}

服务器端示例

use mcp_sdk_rs::{Server, transport::StdioTransport};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建一个标准输入输出传输层实例
    let (transport, _) = StdioTransport::new();

    // 创建并启动服务器
    let server = Server::new(transport);
    server.start().await?;

    Ok(())
}

✨ 主要特性

• 🚀 完整实现 MCP 协议规范。
• 🔄 支持多种传输层，包括 WebSocket 和标准输入输出。
• ⚡ 借助 Tokio 实现异步/等待支持。
• 🛡️ 实现类型安全的消息处理。
• 🔍 具备全面的错误处理能力。
• 📦 支持零复制序列化/反序列化。

📦 安装指南

将以下内容添加到Cargo.toml：

[dependencies]
mcp_sdk_rs = "0.1.0"

💻 使用示例

基础用法

// 客户端示例
use mcp_sdk_rs::{Client, transport::WebSocketTransport};

#[tokio::main]
async fn main() -> Result<(), Error> {
    // 创建一个传输层实例
    let transport = WebSocketTransport::new(self.url.as_str())
        .await
        .map_err(|_| Error::Internal)?;

    //创建用于客户端和会话之间通信的mpsc通道
    let (request_tx, request_rx): (UnboundedSender<Message>, UnboundedReceiver<Message>) =
        tokio::sync::mpsc::unbounded_channel();
    let (response_tx, response_rx): (UnboundedSender<Message>, UnboundedReceiver<Message>) =
        tokio::sync::mpsc::unbounded_channel();

    // 创建并启动会话
    // 可选地传递一个ClientHandler的实现来处理自定义请求和通知
    let session = Session::new(Arc::new(transport), response_tx, request_rx, None);
    session.start().await.map_err(|_| Error::Internal)?;

    // 创建客户端并发送请求，接收通知等
    let client = Client::new(request_tx, response_rx);
    let response = client.request(
        "tools/call",
        Some(json!({
            "name": "methondName",
            "arguments": json!({})
        })),
    )
    .await?
}

// 服务器端示例
use mcp_sdk_rs::{Server, transport::StdioTransport};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建一个标准输入输出传输层实例
    let (transport, _) = StdioTransport::new();

    // 创建并启动服务器
    let server = Server::new(transport);
    server.start().await?;

    Ok(())
}

📚 详细文档

传输层

SDK 支持以下多种传输层：

WebSocket 传输层

• 适用于基于网络的通信场景。
• 支持安全（WSS）和标准（WS）连接。
• 内置重连处理机制。

标准输入输出传输层

• 适合本地进程间通信。
• 轻量高效。
• 适合命令行工具和本地开发环境。

错误处理

SDK 通过Error类型提供全面的错误处理：

use mcp_sdk_rs::Error;

match result {
    Ok(value) => println!("成功: {:?}", value),
    Err(Error::Protocol(code, msg)) => println!("协议错误代码{}：{}", code, msg),
    Err(Error::Transport(e)) => println!("传输错误：{}", e),
    Err(e) => println!("其他错误：{}", e),
}

📄 许可证

此项目根据 MIT 许可证授权 - 有关详细信息，请参阅LICENSE文件。最初是从https://github.com/Derek-X-Wang/mcp-rust-sdk分支出来的。

⚠️ 重要提示

此 SDK 目前仍在开发中，尚未准备好投入生产使用。