Rust MCP Sdk

🚀 Rust-MCP-SDK 文檔

rust-mcp-sdk 是一個用於構建和管理 MCP（機器學習平臺）服務的 Rust 庫。它提供了服務器端和客戶端的功能模塊，還支持通過宏簡化工具結構的創建和操作，能有效提升開發效率。

🚀 快速開始

當你將 rust-mcp-sdk 作為依賴項包含在項目中時，默認情況下會啟用所有功能：

[dependencies]
rust-mcp-sdk = "0.2.0"

✨ 主要特性

可用功能

• server：激活 MCP 服務器功能，提供構建和管理 MCP 服務所需的模塊和 API。
• client：激活 MCP 客戶端功能，提供與 MCP 服務器通信的模塊和 API。
• macros：提供用於簡化 MCP 工具結構創建和操作的程序化宏。

默認行為

所有功能（server、client 和 macros）默認啟用。

功能選擇

只使用 server 功能

如果你只需要 MCP 服務器的功能，可以禁用默認功能並顯式啟用 server 特性。將以下內容添加到 Cargo.toml：

[dependencies]
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["server","macros"] }

只使用 client 功能

如果你只需要 MCP 客戶端的功能，可以禁用默認功能並顯式啟用 client 特性。將以下內容添加到 Cargo.toml：

[dependencies]
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["client"] }

處理程序 trait 選擇

rust-mcp-sdk 提供兩種類型的處理程序 trait，用於處理 MCP 消息：

• mcp_server_handler：這是推薦的 trait，用於你的 MCP 項目。它提供對所有類型 MCP 消息的默認實現，例如處理初始化或響應心跳請求。你只需要重寫和自定義與特定需求相關的 handler 函數。 參考 examples/hello-world-mcp-server/src/handler.rs 查看示例。
• mcp_server_handler_core：如果你需要對 MCP 消息有更多控制，可以考慮使用 mcp_server_handler_core。它提供三種主要方法來處理三種 MCP 消息類型：request、notification 和 error。儘管仍然在這些方法中提供類型安全的對象，但它允許你根據消息的類型和參數確定如何處理每條消息。 參考 examples/hello-world-mcp-server-core/src/handler.rs 查看示例。

⚠️ 重要提示

根據你選擇 mcp_server_handler 或 mcp_server_handler_core，你需要使用相應的 server_runtime::create_server() 或 server_runtime_core::create_server() 方法。

客戶端處理程序選擇

• mcp_client_handler：推薦的 trait，提供對所有類型 MCP 客戶端消息的默認實現。
• mcp_client_handler_core：如果你需要更多控制，可以使用此核心版本。

💻 使用示例

基礎用法

服務器端示例

use mcp_sdk::server::{McpServer, McpMessage};

#[derive(Debug)]
struct MyServerHandler {
    // 自定義狀態或屬性
}

impl McpServer for MyServerHandler {
    fn handle_message(&mut self, message: &McpMessage) -> Result<(), Box<dyn Error>> {
        // 處理消息的邏輯
        println!("收到消息：{}", message);
        Ok(())
    }
}

客戶端示例

use mcp_sdk::client::{McpClient, McpMessage};

#[derive(Debug)]
struct MyClientHandler {
    // 自定義狀態或屬性
}

impl McpClient for MyClientHandler {
    fn handle_response(&mut self, response: &McpMessage) -> Result<(), Box<dyn Error>> {
        // 處理響應的邏輯
        println!("收到響應：{}", response);
        Ok(())
    }
}

📦 安裝指南

安裝依賴

確保你已經安裝了以下工具：

• Rust 編譯器：rustup install
• 包管理器：cargo install cargo-edit

添加依賴到 Cargo.toml

在你的項目中添加 rust-mcp-sdk 依賴：

[dependencies]
rust-mcp-sdk = "0.2.0"

運行示例

克隆倉庫後，運行以下命令來運行示例項目：

cargo run --example my_example

📚 詳細文檔

提交代碼

1. 克隆倉庫：

   git clone https://github.com/rust-mcp-sdk/rust-mcp-sdk.git
   cd rust-mcp-sdk
   

2. 創建功能分支：

   git checkout -b feature/my_new_feature
   

3. 編寫代碼並測試：

   • 在 src/ 目錄下添加新文件或修改現有文件。
   • 在 examples/ 目錄下添加示例項目（如果需要）。
   • 運行測試套件：cargo test

4. 提交更改：

   git add .
   git commit -m "feat: 添加新的功能"
   

5. 創建拉取請求：

   • 轉到 GitHub 倉庫
   • 點擊“Pull Request”按鈕
   • 填寫 PR 描述並提交

提交規範

遵循以下提交規範：

1. 類型：

   • feat: 新功能的添加
   • fix: 修復問題
   • refactor: 代碼重構
   • test: 添加測試用例
   • doc: 更新文檔

2. 描述：簡明扼要地說明提交的內容。

3. 範圍：使用作用域，例如：

   • mcp-sdk: 核心庫的更改
   • examples: 示例項目的更改
   • docs: 文檔的更改

4. 格式示例：

   feat(mcp-sdk): 添加新的服務器端點支持
   fix(doc): 修復文檔中的拼寫錯誤
   

貢獻代碼

• 提交代碼時，請遵循提交規範。
• 為你的功能添加測試用例。
• 更新文檔以反映你的更改。

📄 許可證

rust-mcp-sdk 是根據 MIT 許可證發佈的。查看 LICENSE 文件獲取詳細信息。