Rust MCP Sdk

🚀 Rust-MCP-SDK ドキュメント

rust-mcp-sdk は、MCP（機械学習プラットフォーム）サービスの構築と管理に使用する Rust ライブラリです。サーバー側とクライアント側の機能モジュールを提供し、マクロを使ってツール構造の作成と操作を簡素化することができます。

🚀 クイックスタート

rust-mcp-sdk を使用するには、まず依存関係を Cargo.toml に追加する必要があります。以下のように記述します。

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

これにより、すべての機能がデフォルトで有効になります。

✨ 主な機能

利用可能な機能

• server：MCP サーバー機能を有効にし、MCP サービスの構築と管理に必要なモジュールと API を提供します。
• client：MCP クライアント機能を有効にし、MCP サーバーと通信するためのモジュールと API を提供します。
• macros：MCP ツール構造の作成と操作を簡素化するためのプログラムマクロを提供します。

デフォルトの動作

すべての機能（server、client、macros）はデフォルトで有効になっています。rust-mcp-sdk をプロジェクトの依存関係として含めると、デフォルトですべての機能が有効になります。

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

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"] }

mcp_server_handler と mcp_server_handler_core の選択

rust-mcp-sdk は、MCP メッセージを処理するための 2 種類のハンドラ trait を提供します。

• mcp_server_handler：これは MCP プロジェクトで推奨される trait です。すべてのタイプの MCP メッセージに対するデフォルトの実装を提供し、たとえば初期化の処理やハートビート要求への応答などを行います。特定の要件に関連するハンドラ関数のみをオーバーライドしてカスタマイズすることができます。 例を見るには、examples/hello-world-mcp-server/src/handler.rs を参照してください。
• mcp_server_handler_core：MCP メッセージに対するより多くの制御が必要な場合は、mcp_server_handler_core を使用することを検討してください。3 種類の MCP メッセージタイプ（request、notification、error）を処理するための 3 つの主要なメソッドを提供します。これらのメソッドでは依然として型安全なオブジェクトが提供されますが、メッセージのタイプとパラメータに応じて各メッセージをどのように処理するかを決定することができます。 例を見るには、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 と mcp_client_handler_core の選択

クライアントハンドラについても同様です。

• 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(())
    }
}

📚 ドキュメント

コードの提出

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 コンパイラ：rustup install
• パッケージマネージャ：cargo install cargo-edit

Cargo.toml に依存関係を追加する

プロジェクトに rust-mcp-sdk の依存関係を追加します。

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

サンプルを実行する

リポジトリをクローンした後、以下のコマンドを実行してサンプルプロジェクトを実行します。

cargo run --example my_example

コードの貢献

• コードを提出する際には、コミット規則に従ってください。
• 機能にテストケースを追加してください。
• 変更内容を反映するようにドキュメントを更新してください。

📄 ライセンス

rust-mcp-sdk は MIT ライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。