MCP Rb

🚀 MCP-RB 日本語ドキュメント

軽量級の Ruby フレームワークで、MCP（モデルコンテキストプロトコル）サーバーを実装し、Sinatra のような DSL スタイルを備えています。

🚀 クイックスタート

MCP-RBは、MCPサーバーを簡単に実装できる軽量級のRubyフレームワークです。以下に、基本的な使い方を説明します。

📦 インストール

アプリケーションの Gemfile に以下の行を追加します。

gem 'mcp-rb'

💻 使用例

基本的な使用法

以下は、MCPサーバーを作成する簡単な例です。

require 'mcp'

name "hello-world"

version "1.0.0"

# 定義するリソース
resource "hello://world" do
  name "Hello World"
  description "一条简单的“你好，世界”消息"
  call { "你好，世界！" }
end

# 定義するリソーステンプレート
resource_template "hello://{user_name}" do
  name "Hello User"
  description "一条简单的问候用户的消息"
  call { |args| "你好，#{args[:user_name]}！" }
end

# 定義するツール
tool "greet" do
  description "按名字打招呼"
  argument :name, String, required: true, description: "要打招呼的名字"
  call do |args|
    "你好，#{args[:name]}！"
  end
end

# 定義するネストパラメータ付きのツール
tool "greet_full_name" do
  description "按全名打招呼"
  argument :person, required: true, description: "要打招呼的人" do
    argument :first_name, String, required: false, description: "名字"
    argument :last_name, String, required: false, description: "姓氏"
  end
  call do |args|
    "你好，第一个人名：#{args[:person][:first_name]} 姓氏：#{args[:person][:last_name]}！"
  end
end

# 定義する配列パラメータ付きのツール
tool "group_greeting" do
  description "一次向多人打招呼"
  argument :people, Array, required: true, items: String, description: "要打招呼的人"
  call do |args|
    args[:people].map { |person| "你好，#{person}！" }.join(", ")
  end
end

📚 ドキュメント

サポートされている仕様

参考：MCP 2024-11-05

• 基本プロトコル
  • ping
  • stdio トランスポート
• サーバー機能
  • リソース
    • resources/read
    • resources/list
    • resources/templates/list
  • ツール
    • tools/list
    • tools/call

未サポートの機能は記載されていません。

テスト

rake test
rake test:unit # ユニットテストのみを実行し、実際に動作するサーバーのテストをスキップする

MCP Inspectorを使用してテストするには、以下のコマンドを実行します。

bunx @modelcontextprotocol/inspector $(pwd)/examples/hello_world.rb

コードフォーマット

bundle exec standardrb --fix

rakeタスクを使用することもできます。

rake lint      # standardrbを使用してコードスタイルをチェックする
rake lint:fix  # standardrbの問題を自動的に修正する

リリース

新しいバージョンをリリースするには、以下の手順を実行します。

1. lib/mcp/version.rb のバージョン番号を更新します。
2. CHANGELOG.md を更新します。
3. gitタグを作成します。

git add .
git commit -m "发布 v.x.y.z"
git tag v.x.y.z
git push --tags

4. ビルドしてRubyGemsにプッシュします。

gem build mcp-rb.gemspec
gem push mcp-rb-*.gem

変更履歴

CHANGELOG.md を参照してください。