MCP Sdk Rs

🚀 模型上下文協議（MCP）Rust SDK

本SDK使用Rust實現了模型上下文協議（MCP），旨在達成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目前仍在開發中，尚未準備好投入生產使用。