MCP-RB 中文文档

一个轻量级的 Ruby 框架，用于实现 MCP（模型上下文协议）服务器，并带有类似 Sinatra 的 DSL 风格。

安装

在你的应用 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

# 定义一个带有 Array 参数的工具
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

1. 构建并推送到 RubyGems

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

变更日志

查看 CHANGELOG.md