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(name: "model_context_protocol", version: DEFAULT_VERSION, tools: [], prompts: [], resources: [], resource_templates: [], server_context: nil, configuration: nil, capabilities: nil, transport: nil) ⇒ Server

Returns a new instance of Server.



36
37
38
39
40
41
42
43
44
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
 
# File 'lib/mcp/server.rb', line 36

def initialize(
  name: "model_context_protocol",
  version: DEFAULT_VERSION,
  tools: [],
  prompts: [],
  resources: [],
  resource_templates: [],
  server_context: nil,
  configuration: nil,
  capabilities: nil,
  transport: nil
)
  @name = name
  @version = version
  @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)
  @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 => ->(_) { {} },

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

Instance Attribute Details

#capabilities ⇒ Object

Returns the value of attribute capabilities.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def capabilities
  @capabilities
end

#configuration ⇒ Object

Returns the value of attribute configuration.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def configuration
  @configuration
end

#name ⇒ Object

Returns the value of attribute name.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def name
  @name
end

#prompts ⇒ Object

Returns the value of attribute prompts.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def prompts
  @prompts
end

#resources ⇒ Object

Returns the value of attribute resources.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def resources
  @resources
end

#server_context ⇒ Object

Returns the value of attribute server_context.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def server_context
  @server_context
end

#tools ⇒ Object

Returns the value of attribute tools.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def tools
  @tools
end

#transport ⇒ Object

Returns the value of attribute transport.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def transport
  @transport
end

#version ⇒ Object

Returns the value of attribute version.



34
35
36
 
# File 'lib/mcp/server.rb', line 34

def version
  @version
end

Instance Method Details

#define_custom_method(method_name:, &block) ⇒ Object 



101
102
103
104
105
106
107
 
# File 'lib/mcp/server.rb', line 101

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, description: nil, arguments: [], &block) ⇒ Object 



96
97
98
99
 
# File 'lib/mcp/server.rb', line 96

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

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



91
92
93
94
 
# File 'lib/mcp/server.rb', line 91

def define_tool(name: nil, description: nil, input_schema: nil, annotations: nil, &block)
  tool = Tool.define(name:, description:, input_schema:, annotations:, &block)
  @tools[tool.name_value] = tool
end

#handle(request) ⇒ Object 



79
80
81
82
83
 
# File 'lib/mcp/server.rb', line 79

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

#handle_json(request) ⇒ Object 



85
86
87
88
89
 
# File 'lib/mcp/server.rb', line 85

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

#notify_prompts_list_changed ⇒ Object 



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

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 



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

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 



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

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 



157
158
159
 
# File 'lib/mcp/server.rb', line 157

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

#prompts_list_handler(&block) ⇒ Object 



153
154
155
 
# File 'lib/mcp/server.rb', line 153

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

#resources_list_handler(&block) ⇒ Object 



133
134
135
 
# File 'lib/mcp/server.rb', line 133

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

#resources_read_handler(&block) ⇒ Object 



137
138
139
 
# File 'lib/mcp/server.rb', line 137

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

#resources_templates_list_handler(&block) ⇒ Object 



141
142
143
 
# File 'lib/mcp/server.rb', line 141

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

#tools_call_handler(&block) ⇒ Object 



149
150
151
 
# File 'lib/mcp/server.rb', line 149

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

#tools_list_handler(&block) ⇒ Object 



145
146
147
 
# File 'lib/mcp/server.rb', line 145

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