Class: MCP::Prompt

Inherits:
Object
  • Object
show all
Defined in:
lib/mcp/prompt.rb,
lib/mcp/prompt/result.rb,
lib/mcp/prompt/message.rb,
lib/mcp/prompt/argument.rb

Defined Under Namespace

Classes: Argument, Message, Result

Constant Summary collapse

NOT_SET = 
Object.new

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.arguments_value ⇒ Object (readonly)

Returns the value of attribute arguments_value.



15
16
17
 
# File 'lib/mcp/prompt.rb', line 15

def arguments_value
  @arguments_value
end

.description_value ⇒ Object (readonly)

Returns the value of attribute description_value.



13
14
15
 
# File 'lib/mcp/prompt.rb', line 13

def description_value
  @description_value
end

.icons_value ⇒ Object (readonly)

Returns the value of attribute icons_value.



14
15
16
 
# File 'lib/mcp/prompt.rb', line 14

def icons_value
  @icons_value
end

.meta_value ⇒ Object (readonly)

Returns the value of attribute meta_value.



16
17
18
 
# File 'lib/mcp/prompt.rb', line 16

def meta_value
  @meta_value
end

.title_value ⇒ Object (readonly)

Returns the value of attribute title_value.



12
13
14
 
# File 'lib/mcp/prompt.rb', line 12

def title_value
  @title_value
end

Class Method Details

.arguments(value = NOT_SET) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/mcp/prompt.rb', line 79

def arguments(value = NOT_SET)
  if value == NOT_SET
    @arguments_value
  else
    @arguments_value = Array(value)
  end
end

.define(name: nil, title: nil, description: nil, icons: [], arguments: [], meta: nil, &block) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/mcp/prompt.rb', line 95

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

.description(value = NOT_SET) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/mcp/prompt.rb', line 63

def description(value = NOT_SET)
  if value == NOT_SET
    @description_value
  else
    @description_value = value
  end
end

.icons(value = NOT_SET) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/mcp/prompt.rb', line 71

def icons(value = NOT_SET)
  if value == NOT_SET
    @icons_value
  else
    @icons_value = value
  end
end

.inherited(subclass) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/mcp/prompt.rb', line 33

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, [])
  subclass.instance_variable_set(:@meta_value, nil)
end

.meta(value = NOT_SET) ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/mcp/prompt.rb', line 87

def meta(value = NOT_SET)
  if value == NOT_SET
    @meta_value
  else
    @meta_value = value
  end
end

.name_value ⇒ Object 



51
52
53
 
# File 'lib/mcp/prompt.rb', line 51

def name_value
  @name_value || StringUtils.handle_from_class_name(name)
end

.prompt_name(value = NOT_SET) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/mcp/prompt.rb', line 43

def prompt_name(value = NOT_SET)
  if value == NOT_SET
    @name_value
  else
    @name_value = value
  end
end

.template(args, server_context: nil) ⇒ Object

Raises:



18
19
20
 
# File 'lib/mcp/prompt.rb', line 18

def template(args, server_context: nil)
  raise NotImplementedError, "Subclasses must implement template"
end

.title(value = NOT_SET) ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/mcp/prompt.rb', line 55

def title(value = NOT_SET)
  if value == NOT_SET
    @title_value
  else
    @title_value = value
  end
end

.to_h ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/mcp/prompt.rb', line 22

def to_h
  {
    name: name_value,
    title: title_value,
    description: description_value,
    icons: icons_value&.then { |icons| icons.empty? ? nil : icons.map(&:to_h) },
    arguments: arguments_value.empty? ? nil : arguments_value.map(&:to_h),
    _meta: meta_value,
  }.compact
end

.validate_arguments!(args) ⇒ Object

Raises:



109
110
111
112
113
114
115
116
117
 
# File 'lib/mcp/prompt.rb', line 109

def validate_arguments!(args)
  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