Class: MCP::Server

Inherits:
Object
  • Object
show all
Includes:
Instrumentation
Defined in:
lib/mcp/server.rb,
lib/mcp/server/capabilities.rb,
lib/mcp/server/transports/stdio_transport.rb,
lib/mcp/server/transports/streamable_http_transport.rb

Defined Under Namespace

Modules: Transports Classes: Capabilities, MethodAlreadyDefinedError, RequestHandlerError

Constant Summary collapse

DEFAULT_VERSION = 
"0.1.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Instrumentation

#add_instrumentation_data, #instrument_call

Constructor Details

#initialize(description: nil, icons: [], name: "model_context_protocol", title: nil, version: DEFAULT_VERSION, website_url: nil, instructions: nil, tools: [], prompts: [], resources: [], resource_templates: [], server_context: nil, configuration: nil, capabilities: nil, transport: nil) ⇒ Server

Returns a new instance of Server.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/mcp/server.rb', line 45

def initialize(
  description: nil,
  icons: [],
  name: "model_context_protocol",
  title: nil,
  version: DEFAULT_VERSION,
  website_url: nil,
  instructions: nil,
  tools: [],
  prompts: [],
  resources: [],
  resource_templates: [],
  server_context: nil,
  configuration: nil,
  capabilities: nil,
  transport: nil
)
  @description = description
  @icons = icons
  @name = name
  @title = title
  @version = version
  @website_url = website_url
  @instructions = instructions
  @tool_names = tools.map(&:name_value)
  @tools = tools.to_h { |t| [t.name_value, t] }
  @prompts = prompts.to_h { |p| [p.name_value, p] }
  @resources = resources
  @resource_templates = resource_templates
  @resource_index = index_resources_by_uri(resources)
  @server_context = server_context
  @configuration = MCP.configuration.merge(configuration)

  validate!

  @capabilities = capabilities || default_capabilities

  @handlers = {
    Methods::RESOURCES_LIST => method(:list_resources),
    Methods::RESOURCES_READ => method(:read_resource_no_content),
    Methods::RESOURCES_TEMPLATES_LIST => method(:list_resource_templates),
    Methods::TOOLS_LIST => method(:list_tools),
    Methods::TOOLS_CALL => method(:call_tool),
    Methods::PROMPTS_LIST => method(:list_prompts),
    Methods::PROMPTS_GET => method(:get_prompt),
    Methods::INITIALIZE => method(:init),
    Methods::PING => ->(_) { {} },
    Methods::NOTIFICATIONS_INITIALIZED => ->(_) {},

    # No op handlers for currently unsupported methods
    Methods::RESOURCES_SUBSCRIBE => ->(_) {},
    Methods::RESOURCES_UNSUBSCRIBE => ->(_) {},
    Methods::COMPLETION_COMPLETE => ->(_) {},
    Methods::LOGGING_SET_LEVEL => ->(_) {},
    Methods::ELICITATION_CREATE => ->(_) {},
  }
  @transport = transport
end

Instance Attribute Details

#capabilities ⇒ Object

Returns the value of attribute capabilities.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def capabilities
  @capabilities
end

#configuration ⇒ Object

Returns the value of attribute configuration.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def configuration
  @configuration
end

#description ⇒ Object

Returns the value of attribute description.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def description
  @description
end

#icons ⇒ Object

Returns the value of attribute icons.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def icons
  @icons
end

#instructions ⇒ Object

Returns the value of attribute instructions.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def instructions
  @instructions
end

#name ⇒ Object

Returns the value of attribute name.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def name
  @name
end

#prompts ⇒ Object

Returns the value of attribute prompts.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def prompts
  @prompts
end

#resources ⇒ Object

Returns the value of attribute resources.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def resources
  @resources
end

#server_context ⇒ Object

Returns the value of attribute server_context.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def server_context
  @server_context
end

#title ⇒ Object

Returns the value of attribute title.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def title
  @title
end

#tools ⇒ Object

Returns the value of attribute tools.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def tools
  @tools
end

#transport ⇒ Object

Returns the value of attribute transport.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def transport
  @transport
end

#version ⇒ Object

Returns the value of attribute version.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def version
  @version
end

#website_url ⇒ Object

Returns the value of attribute website_url.



43
44
45
 
# File 'lib/mcp/server.rb', line 43

def website_url
  @website_url
end

Instance Method Details

#define_custom_method(method_name:, &block) ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/mcp/server.rb', line 133

def define_custom_method(method_name:, &block)
  if @handlers.key?(method_name)
    raise MethodAlreadyDefinedError, method_name
  end

  @handlers[method_name] = block
end

#define_prompt(name: nil, title: nil, description: nil, arguments: [], &block) ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/mcp/server.rb', line 126

def define_prompt(name: nil, title: nil, description: nil, arguments: [], &block)
  prompt = Prompt.define(name: name, title: title, description: description, arguments: arguments, &block)
  @prompts[prompt.name_value] = prompt

  validate!
end

#define_tool(name: nil, title: nil, description: nil, input_schema: nil, annotations: nil, meta: nil, &block) ⇒ Object 



116
117
118
119
120
121
122
123
124
 
# File 'lib/mcp/server.rb', line 116

def define_tool(name: nil, title: nil, description: nil, input_schema: nil, annotations: nil, meta: nil, &block)
  tool = Tool.define(name: name, title: title, description: description, input_schema: input_schema, annotations: annotations, meta: meta, &block)
  tool_name = tool.name_value

  @tool_names << tool_name
  @tools[tool_name] = tool

  validate!
end

#handle(request) ⇒ Object 



104
105
106
107
108
 
# File 'lib/mcp/server.rb', line 104

def handle(request)
  JsonRpcHandler.handle(request) do |method|
    handle_request(request, method)
  end
end

#handle_json(request) ⇒ Object 



110
111
112
113
114
 
# File 'lib/mcp/server.rb', line 110

def handle_json(request)
  JsonRpcHandler.handle_json(request) do |method|
    handle_request(request, method)
  end
end

#notify_prompts_list_changed ⇒ Object 



149
150
151
152
153
154
155
 
# File 'lib/mcp/server.rb', line 149

def notify_prompts_list_changed
  return unless @transport

  @transport.send_notification(Methods::NOTIFICATIONS_PROMPTS_LIST_CHANGED)
rescue => e
  report_exception(e, { notification: "prompts_list_changed" })
end

#notify_resources_list_changed ⇒ Object 



157
158
159
160
161
162
163
 
# File 'lib/mcp/server.rb', line 157

def notify_resources_list_changed
  return unless @transport

  @transport.send_notification(Methods::NOTIFICATIONS_RESOURCES_LIST_CHANGED)
rescue => e
  report_exception(e, { notification: "resources_list_changed" })
end

#notify_tools_list_changed ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/mcp/server.rb', line 141

def notify_tools_list_changed
  return unless @transport

  @transport.send_notification(Methods::NOTIFICATIONS_TOOLS_LIST_CHANGED)
rescue => e
  report_exception(e, { notification: "tools_list_changed" })
end

#prompts_get_handler(&block) ⇒ Object 



189
190
191
 
# File 'lib/mcp/server.rb', line 189

def prompts_get_handler(&block)
  @handlers[Methods::PROMPTS_GET] = block
end

#prompts_list_handler(&block) ⇒ Object 



185
186
187
 
# File 'lib/mcp/server.rb', line 185

def prompts_list_handler(&block)
  @handlers[Methods::PROMPTS_LIST] = block
end

#resources_list_handler(&block) ⇒ Object 



165
166
167
 
# File 'lib/mcp/server.rb', line 165

def resources_list_handler(&block)
  @handlers[Methods::RESOURCES_LIST] = block
end

#resources_read_handler(&block) ⇒ Object 



169
170
171
 
# File 'lib/mcp/server.rb', line 169

def resources_read_handler(&block)
  @handlers[Methods::RESOURCES_READ] = block
end

#resources_templates_list_handler(&block) ⇒ Object 



173
174
175
 
# File 'lib/mcp/server.rb', line 173

def resources_templates_list_handler(&block)
  @handlers[Methods::RESOURCES_TEMPLATES_LIST] = block
end

#tools_call_handler(&block) ⇒ Object 



181
182
183
 
# File 'lib/mcp/server.rb', line 181

def tools_call_handler(&block)
  @handlers[Methods::TOOLS_CALL] = block
end

#tools_list_handler(&block) ⇒ Object 



177
178
179
 
# File 'lib/mcp/server.rb', line 177

def tools_list_handler(&block)
  @handlers[Methods::TOOLS_LIST] = block
end