模型上下文协议SDK

一个Rust实现的模型上下文协议(MCP)SDK,用于AI模型与其运行时环境之间的无缝通信。

  • by jgmartin
  • Rust
  • 本地部署
  • 10 星标
  • 更新于
在 GitHub 查看 jgmartin/mcp-sdk-rs

使用说明

模型上下文协议(MCP)Rust SDK

⚠️ 警告:此SDK目前正在开发中,尚未准备好用于生产。

模型上下文协议(MCP)的Rust实现,旨在实现AI模型与其运行时环境之间的无缝通信。

特性

  • 🚀 全面实施MCP协议规范
  • 🔄 多个传输层(WebSocket、stdio)
  • ⚡ 使用Tokio支持异步/等待
  • 🛡️ 类型安全消息处理
  • 🔍 全面的错误处理
  • 📦 零拷贝序列化/反序列化

安装

将此添加到您的 Cargo.toml:

[dependencies]
mcp_sdk_rs = "0.1.0"

快速开始

客户端示例

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

#[tokio::main]
async fn main() -> Result<(), Error> {
    // Create a transport
    let transport = WebSocketTransport::new(self.url.as_str())
        .await
        .map_err(|_| Error::Internal)?;

    //Create mpsc channels for communication between the client and session
    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();

    // Create and start the session
    // Optionally pass an implementation of ClientHandler for custom handling of requests and notifications
    let session = Session::new(Arc::new(transport), response_tx, request_rx, None);
    session.start().await.map_err(|_| Error::Internal)?;

    // Create the client and make requests, receive notifications etc
    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>> {
    // Create a stdio transport
    let (transport, _) = StdioTransport::new();

    // Create and start the server
    let server = Server::new(transport);
    server.start().await?;

    Ok(())
}

传输层

SDK支持多个传输层:

WebSocket传输

  • 非常适合基于网络的通信
  • 支持安全(WSS)和标准(WS)连接
  • 内置重新连接处理

stdio运输

  • 非常适合本地过程通信
  • 轻便高效
  • 非常适合命令行工具和本地开发

错误处理

SDK通过以下方式提供全面的错误处理 Error 类型:

use mcp_sdk_rs::Error;

match result {
    Ok(value) => println!("Success: {:?}", value),
    Err(Error::Protocol(code, msg)) => println!("Protocol error {}: {}", code, msg),
    Err(Error::Transport(e)) => println!("Transport error: {}", e),
    Err(e) => println!("Other error: {}", e),
}

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

最初分叉自 https://github.com/Derek-X-Wang/mcp-rust-sdk.