aa8bbad491
## Summary Unlike applications, libraries provide value by remaining usable for a broad range of users, even when that means supporting older Ruby versions beyond Ruby's own EOL timeline. I maintain RuboCop, a Ruby linter. Because linters need to work across the ecosystem, they often need to keep compatibility with older Ruby versions to some extent. The trade-off is that the MCP Ruby SDK must remain compatible with Ruby 2.7. However, given the ecosystem impact, supporting Ruby 2.7 is still worthwhile. For example, bundled gems such as `csv` (Ruby >= 2.5), `bigdecimal` (Ruby >= 2.5), `json` (Ruby >= 2.7), and `language_server-protocol` (Ruby >= 2.5) tend to keep compatibility with older Ruby versions. Unlike dropping support, which imposes restrictions on users, this change broadens compatibility and does not introduce breaking changes. ## Development Note `rubocop-shopify` (2.18) supports Ruby 3.1+, and this PR does not change that. Since RuboCop can configure the runtime Ruby version and the target Ruby version for analysis independently, CI continues to run RuboCop on Ruby 4.0, while analyzing code with `TargetRubyVersion: 2.7`. When setting `TargetRubyVersion: 2.7`, several RuboCop offenses were resolved. Additionally, Sorbet-related libraries support Ruby 3.0+. Since these are not dependencies of the MCP Ruby SDK itself, they are versioned and tested in the development Gemfile.
121 lines
3 KiB
Ruby
121 lines
3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module MCP
|
|
class Prompt
|
|
class << self
|
|
NOT_SET = Object.new
|
|
|
|
attr_reader :title_value
|
|
attr_reader :description_value
|
|
attr_reader :icons_value
|
|
attr_reader :arguments_value
|
|
attr_reader :meta_value
|
|
|
|
def template(args, server_context: nil)
|
|
raise NotImplementedError, "Subclasses must implement template"
|
|
end
|
|
|
|
def to_h
|
|
{
|
|
name: name_value,
|
|
title: title_value,
|
|
description: description_value,
|
|
icons: icons&.map(&:to_h),
|
|
arguments: arguments_value&.map(&:to_h),
|
|
_meta: meta_value,
|
|
}.compact
|
|
end
|
|
|
|
def inherited(subclass)
|
|
super
|
|
subclass.instance_variable_set(:@name_value, nil)
|
|
subclass.instance_variable_set(:@title_value, nil)
|
|
subclass.instance_variable_set(:@description_value, nil)
|
|
subclass.instance_variable_set(:@icons_value, nil)
|
|
subclass.instance_variable_set(:@arguments_value, nil)
|
|
subclass.instance_variable_set(:@meta_value, nil)
|
|
end
|
|
|
|
def prompt_name(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@name_value
|
|
else
|
|
@name_value = value
|
|
end
|
|
end
|
|
|
|
def name_value
|
|
@name_value || StringUtils.handle_from_class_name(name)
|
|
end
|
|
|
|
def title(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@title_value
|
|
else
|
|
@title_value = value
|
|
end
|
|
end
|
|
|
|
def description(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@description_value
|
|
else
|
|
@description_value = value
|
|
end
|
|
end
|
|
|
|
def icons(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@icons_value
|
|
else
|
|
@icons_value = value
|
|
end
|
|
end
|
|
|
|
def arguments(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@arguments_value
|
|
else
|
|
@arguments_value = value
|
|
end
|
|
end
|
|
|
|
def meta(value = NOT_SET)
|
|
if value == NOT_SET
|
|
@meta_value
|
|
else
|
|
@meta_value = value
|
|
end
|
|
end
|
|
|
|
def define(name: nil, title: nil, description: nil, icons: [], arguments: [], meta: nil, &block)
|
|
Class.new(self) do
|
|
prompt_name name
|
|
title title
|
|
description description
|
|
icons icons
|
|
arguments arguments
|
|
define_singleton_method(:template) do |args, server_context: nil|
|
|
instance_exec(args, server_context: server_context, &block)
|
|
end
|
|
meta meta
|
|
end
|
|
end
|
|
|
|
def validate_arguments!(args)
|
|
missing = required_args - args.keys
|
|
return if missing.empty?
|
|
|
|
raise MCP::Server::RequestHandlerError.new(
|
|
"Missing required arguments: #{missing.join(", ")}", nil, error_type: :missing_required_arguments
|
|
)
|
|
end
|
|
|
|
private
|
|
|
|
def required_args
|
|
arguments_value.filter_map { |arg| arg.name.to_sym if arg.required }
|
|
end
|
|
end
|
|
end
|
|
end
|