Module: RubyLLM::MCP::Native::Messages::Requests

Extended by:
Helpers
Defined in:
lib/ruby_llm/mcp/native/messages/requests.rb

Overview

Request message builders All methods return a JSON-RPC request body ready to be sent

Class Method Summary collapse

Methods included from Helpers

add_cursor, add_progress_token, format_completion_context, generate_id

Class Method Details

.completion_prompt(name:, argument:, value:, context: nil, tracking_progress: false) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 181

def completion_prompt(name:, argument:, value:, context: nil, tracking_progress: false)
  params = {
    ref: {
      type: REF_TYPE_PROMPT,
      name: name
    },
    argument: {
      name: argument,
      value: value
    },
    context: format_completion_context(context)
  }.compact
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_COMPLETION_COMPLETE,
    params: params
  }
end

.completion_resource(uri:, argument:, value:, context: nil, tracking_progress: false) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 159

def completion_resource(uri:, argument:, value:, context: nil, tracking_progress: false)
  params = {
    ref: {
      type: REF_TYPE_RESOURCE,
      uri: uri
    },
    argument: {
      name: argument,
      value: value
    },
    context: format_completion_context(context)
  }.compact
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_COMPLETION_COMPLETE,
    params: params
  }
end

.initialize(protocol_version:, capabilities:) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 14

def initialize(protocol_version:, capabilities:)
  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_INITIALIZE,
    params: {
      protocolVersion: protocol_version,
      capabilities: capabilities,
      clientInfo: {
        name: "RubyLLM-MCP Client",
        version: RubyLLM::MCP::VERSION
      }
    }
  }
end

.logging_set_level(level:, tracking_progress: false) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 203

def logging_set_level(level:, tracking_progress: false)
  params = { level: level }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_LOGGING_SET_LEVEL,
    params: params
  }
end

.ping(tracking_progress: false) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 30

def ping(tracking_progress: false)
  params = add_progress_token({}, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_PING,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end

.prompt_call(name:, arguments: {}, tracking_progress: false) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 144

def prompt_call(name:, arguments: {}, tracking_progress: false)
  params = {
    name: name,
    arguments: arguments
  }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_PROMPTS_GET,
    params: params
  }
end

.prompt_list(cursor: nil, tracking_progress: false) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 131

def prompt_list(cursor: nil, tracking_progress: false)
  params = {}
  params = add_cursor(params, cursor)
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_PROMPTS_LIST,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end

.resource_list(cursor: nil, tracking_progress: false) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 69

def resource_list(cursor: nil, tracking_progress: false)
  params = {}
  params = add_cursor(params, cursor)
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_RESOURCES_LIST,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end

.resource_read(uri:, tracking_progress: false) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 82

def resource_read(uri:, tracking_progress: false)
  params = { uri: uri }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_RESOURCES_READ,
    params: params
  }
end

.resource_template_list(cursor: nil, tracking_progress: false) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 94

def resource_template_list(cursor: nil, tracking_progress: false)
  params = {}
  params = add_cursor(params, cursor)
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_RESOURCES_TEMPLATES_LIST,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end

.resources_subscribe(uri:, tracking_progress: false) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 107

def resources_subscribe(uri:, tracking_progress: false)
  params = { uri: uri }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_RESOURCES_SUBSCRIBE,
    params: params
  }
end

.resources_unsubscribe(uri:, tracking_progress: false) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 119

def resources_unsubscribe(uri:, tracking_progress: false)
  params = { uri: uri }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_RESOURCES_UNSUBSCRIBE,
    params: params
  }
end

.task_cancel(task_id:, tracking_progress: false) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 252

def task_cancel(task_id:, tracking_progress: false)
  params = { taskId: task_id }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TASKS_CANCEL,
    params: params
  }
end

.task_get(task_id:, tracking_progress: false) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 228

def task_get(task_id:, tracking_progress: false)
  params = { taskId: task_id }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TASKS_GET,
    params: params
  }
end

.task_result(task_id:, tracking_progress: false) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 240

def task_result(task_id:, tracking_progress: false)
  params = { taskId: task_id }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TASKS_RESULT,
    params: params
  }
end

.tasks_list(cursor: nil, tracking_progress: false) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 215

def tasks_list(cursor: nil, tracking_progress: false)
  params = {}
  params = add_cursor(params, cursor)
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TASKS_LIST,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end

.tool_call(name:, parameters: {}, tracking_progress: false) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 54

def tool_call(name:, parameters: {}, tracking_progress: false)
  params = {
    name: name,
    arguments: parameters
  }
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TOOLS_CALL,
    params: params
  }
end

.tool_list(cursor: nil, tracking_progress: false) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/ruby_llm/mcp/native/messages/requests.rb', line 41

def tool_list(cursor: nil, tracking_progress: false)
  params = {}
  params = add_cursor(params, cursor)
  params = add_progress_token(params, tracking_progress: tracking_progress)

  {
    jsonrpc: JSONRPC_VERSION,
    id: generate_id,
    method: METHOD_TOOLS_LIST,
    params: params
  }.tap { |body| body.delete(:params) if params.empty? }
end