Class: ActionMCP::Session

Inherits:
ApplicationRecord show all
Includes:
MCPConsoleHelpers
Defined in:
app/models/action_mcp/session.rb,
app/models/action_mcp/session/task.rb,
app/models/action_mcp/session/message.rb,
app/models/action_mcp/session/subscription.rb

Overview

Represents an MCP session, which is a connection between a client and a server. Its role is to manage the communication channel and store information about the session, such as client and server capabilities, protocol version, and session status. It also manages the association with messages and subscriptions related to the session.

Defined Under Namespace

Classes: Message, Subscription, Task

Instance Method Summary collapse

Methods included from MCPConsoleHelpers

#message_flow

Instance Method Details

#close! ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'app/models/action_mcp/session.rb', line 76

def close!
  if messages_count.zero?
    # if there are no messages, we can delete the session immediately
    destroy
    nil
  else
    update!(status: "closed", ended_at: Time.zone.now)
    subscriptions.delete_all # delete all subscriptions
  end
end

#consent_granted_for?(key) ⇒ Boolean

Checks if consent has been granted for a specific key

Parameters:

  • key (String) —

    The consent key (e.g., tool name or resource URI)

Returns:

  • (Boolean) —

    true if consent is granted, false otherwise



319
320
321
322
 
# File 'app/models/action_mcp/session.rb', line 319

def consent_granted_for?(key)
  consents_hash = consents.is_a?(String) ? JSON.parse(consents) : consents
  consents_hash&.key?(key) && consents_hash[key] == true
end

#grant_consent(key) ⇒ Boolean

Grants consent for a specific key

Parameters:

  • key (String) —

    The consent key to grant

Returns:

  • (Boolean) —

    true if saved successfully



327
328
329
330
331
332
 
# File 'app/models/action_mcp/session.rb', line 327

def grant_consent(key)
  self.consents = JSON.parse(consents) if consents.is_a?(String)
  self.consents ||= {}
  self.consents[key] = true
  save!
end

#initialize! ⇒ Object 



133
134
135
136
137
138
139
140
 
# File 'app/models/action_mcp/session.rb', line 133

def initialize!
  # update the session initialized to true
  return false if initialized?

  self.initialized = true
  self.status = "initialized"
  save
end

#read(data) ⇒ Object 



97
98
99
 
# File 'app/models/action_mcp/session.rb', line 97

def read(data)
  messages.create!(data: data, direction: role)
end

#register_prompt(prompt_class_or_name) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'app/models/action_mcp/session.rb', line 201

def register_prompt(prompt_class_or_name)
  prompt_name = normalize_name(prompt_class_or_name, :prompt)
  return false unless prompt_exists?(prompt_name)
  return true if uses_all_prompts?

  self.prompt_registry ||= []
  unless self.prompt_registry.include?(prompt_name)
    self.prompt_registry << prompt_name
    save!
    send_prompts_list_changed_notification
  end
  true
end

#register_resource_template(template_class_or_name) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'app/models/action_mcp/session.rb', line 230

def register_resource_template(template_class_or_name)
  template_name = normalize_name(template_class_or_name, :resource_template)
  return false unless resource_template_exists?(template_name)
  return true if uses_all_resources?

  self.resource_registry ||= []
  unless self.resource_registry.include?(template_name)
    self.resource_registry << template_name
    save!
    send_resources_list_changed_notification
  end
  true
end

#register_tool(tool_class_or_name) ⇒ Object

Registry management methods



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'app/models/action_mcp/session.rb', line 172

def register_tool(tool_class_or_name)
  tool_name = normalize_name(tool_class_or_name, :tool)
  return false unless tool_exists?(tool_name)
  return true if uses_all_tools?

  self.tool_registry ||= []
  unless self.tool_registry.include?(tool_name)
    self.tool_registry << tool_name
    save!
    send_tools_list_changed_notification
  end
  true
end

#registered_prompts ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'app/models/action_mcp/session.rb', line 274

def registered_prompts
  if prompt_registry == [ "*" ]
    # filtered_prompts returns a RegistryScope with Item objects, need to extract the klass
    ActionMCP.configuration.filtered_prompts.map(&:klass)
  else
    (self.prompt_registry || []).filter_map do |prompt_name|
      ActionMCP::PromptsRegistry.find(prompt_name)
    rescue StandardError
      nil
    end
  end
end

#registered_resource_templates ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'app/models/action_mcp/session.rb', line 287

def registered_resource_templates
  if resource_registry == [ "*" ]
    # filtered_resources returns a RegistryScope with Item objects, need to extract the klass
    ActionMCP.configuration.filtered_resources.map(&:klass)
  else
    (self.resource_registry || []).filter_map do |template_name|
      ActionMCP::ResourceTemplatesRegistry.find(template_name)
    rescue StandardError
      nil
    end
  end
end

#registered_tools ⇒ Object

Get registered items for this session



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'app/models/action_mcp/session.rb', line 260

def registered_tools
  # Special case: ['*'] means use all available tools dynamically
  if tool_registry == [ "*" ]
    # filtered_tools returns a RegistryScope with Item objects, need to extract the klass
    ActionMCP.configuration.filtered_tools.map(&:klass)
  else
    (self.tool_registry || []).filter_map do |tool_name|
      ActionMCP::ToolsRegistry.find(tool_name)
    rescue StandardError
      nil
    end
  end
end

#resource_subscribe(uri) ⇒ Object 



148
149
150
 
# File 'app/models/action_mcp/session.rb', line 148

def resource_subscribe(uri)
  subscriptions.find_or_create_by(uri: uri)
end

#resource_unsubscribe(uri) ⇒ Object 



152
153
154
 
# File 'app/models/action_mcp/session.rb', line 152

def resource_unsubscribe(uri)
  subscriptions.find_by(uri: uri)&.destroy
end

#revoke_consent(key) ⇒ void

This method returns an undefined value.

Revokes consent for a specific key

Parameters:

  • key (String) —

    The consent key to revoke



337
338
339
340
341
342
343
 
# File 'app/models/action_mcp/session.rb', line 337

def revoke_consent(key)
  self.consents = JSON.parse(self.consents) if self.consents.is_a?(String)
  return unless consents&.key?(key)

  consents.delete(key)
  save!
end

#send_ping! ⇒ Object 



142
143
144
145
146
 
# File 'app/models/action_mcp/session.rb', line 142

def send_ping!
  Session.logger.silence do
    write(JSON_RPC::Request.new(id: Time.now.to_i, method: "ping"))
  end
end

#send_progress_notification(progressToken:, progress:, total: nil, message: nil) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
 
# File 'app/models/action_mcp/session.rb', line 156

def send_progress_notification(progressToken:, progress:, total: nil, message: nil)
  # Create a transport handler to send the notification
  handler = ActionMCP::Server::TransportHandler.new(self)
  handler.send_progress_notification(
    progressToken: progressToken,
    progress: progress,
    total: total,
    message: message
  )
end

#send_progress_notification_legacy(token:, value:, message: nil) ⇒ Object 



167
168
169
 
# File 'app/models/action_mcp/session.rb', line 167

def send_progress_notification_legacy(token:, value:, message: nil)
  send_progress_notification(progressToken: token, progress: value, message: message)
end

#server_capabilities ⇒ Object 



125
126
127
 
# File 'app/models/action_mcp/session.rb', line 125

def server_capabilities
  parsed_json_attribute(super)
end

#server_capabilities=(value) ⇒ Object 



129
130
131
 
# File 'app/models/action_mcp/session.rb', line 129

def server_capabilities=(value)
  super(parsed_json_attribute(value))
end

#server_capabilities_payload ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'app/models/action_mcp/session.rb', line 113

def server_capabilities_payload
  payload = {
    protocolVersion: protocol_version || ActionMCP::DEFAULT_PROTOCOL_VERSION,
    serverInfo: server_info,
    capabilities: server_capabilities
  }
  # Add instructions at top level if configured
  instructions = ActionMCP.configuration.instructions
  payload[:instructions] = instructions if instructions
  payload
end

#set_protocol_version(version) ⇒ Object 



101
102
103
 
# File 'app/models/action_mcp/session.rb', line 101

def set_protocol_version(version)
  update(protocol_version: version)
end

#store_client_capabilities(capabilities) ⇒ Object 



109
110
111
 
# File 'app/models/action_mcp/session.rb', line 109

def store_client_capabilities(capabilities)
  self.client_capabilities = capabilities
end

#store_client_info(info) ⇒ Object 



105
106
107
 
# File 'app/models/action_mcp/session.rb', line 105

def store_client_info(info)
  self.client_info = info
end

#unregister_prompt(prompt_class_or_name) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'app/models/action_mcp/session.rb', line 215

def unregister_prompt(prompt_class_or_name)
  prompt_name = normalize_name(prompt_class_or_name, :prompt)

  if uses_all_prompts?
    return unless prompt_exists?(prompt_name)
    expand_prompt_registry!
  end

  self.prompt_registry ||= []
  return unless self.prompt_registry.delete(prompt_name)

  save!
  send_prompts_list_changed_notification
end

#unregister_resource_template(template_class_or_name) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'app/models/action_mcp/session.rb', line 244

def unregister_resource_template(template_class_or_name)
  template_name = normalize_name(template_class_or_name, :resource_template)

  if uses_all_resources?
    return unless resource_template_exists?(template_name)
    expand_resource_registry!
  end

  self.resource_registry ||= []
  return unless self.resource_registry.delete(template_name)

  save!
  send_resources_list_changed_notification
end

#unregister_tool(tool_class_or_name) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'app/models/action_mcp/session.rb', line 186

def unregister_tool(tool_class_or_name)
  tool_name = normalize_name(tool_class_or_name, :tool)

  if uses_all_tools?
    return unless tool_exists?(tool_name)
    expand_tool_registry!
  end

  self.tool_registry ||= []
  return unless self.tool_registry.delete(tool_name)

  save!
  send_tools_list_changed_notification
end

#uses_all_prompts? ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
 
# File 'app/models/action_mcp/session.rb', line 305

def uses_all_prompts?
  prompt_registry == [ "*" ]
end

#uses_all_resources? ⇒ Boolean

Returns:

  • (Boolean) 


309
310
311
 
# File 'app/models/action_mcp/session.rb', line 309

def uses_all_resources?
  resource_registry == [ "*" ]
end

#uses_all_tools? ⇒ Boolean

Helper methods to check if using all capabilities

Returns:

  • (Boolean) 


301
302
303
 
# File 'app/models/action_mcp/session.rb', line 301

def uses_all_tools?
  tool_registry == [ "*" ]
end

#write(data) ⇒ Object

MESSAGING dispatch



88
89
90
91
92
93
94
95
 
# File 'app/models/action_mcp/session.rb', line 88

def write(data)
  if data.is_a?(JSON_RPC::Request) || data.is_a?(JSON_RPC::Response) || data.is_a?(JSON_RPC::Notification)
    data = data.to_json
  end
  data = MultiJson.dump(data) if data.is_a?(Hash)

  messages.create!(data: data, direction: writer_role)
end