class RubyLLM::InputRequest

A request for input from the user while a tool works on a call: an MCP server’s question, received by MCP.before_input_request callbacks, or a tool’s own, from Tool#ask. A form request asks for values; a URL request asks the user to visit a page, such as to connect an account.

before_input_request do |request|
  if request.url?
    system "open", request.url
    request.answer
  else
    request.answer(environment: "staging")
  end
end

In a chat, a request no callback answers pauses the tool call until Chat#answer or Chat#decline settles it; see Chat#pending_inputs.

Constants

Field: A value a form request asks for.

Attributes

fields [R]

The values a form request asks for, as Field objects.

message [R]

Why the server needs the input.

tool_call [R]

The ToolCall paused on this request, when it came from a chat.

url [R]

The page a URL request asks the user to visit, or nil.

Public Instance Methods

answer (**values)

Source

# File lib/ruby_llm/input_request.rb, line 120
def answer(**values)
  @response = { action: 'accept', content: (with_defaults(values) unless url?) }.compact
end

Accepts the request. A form request takes the values as keywords, and the fields you leave out take the defaults the server gave them; a URL request takes none, meaning the user agreed to visit the page.

answered? ()

Source

# File lib/ruby_llm/input_request.rb, line 130
def answered?
  !response.nil?
end

Returns whether the request has been answered or declined.

decline ()

Source

# File lib/ruby_llm/input_request.rb, line 125
def decline
  @response = { action: 'decline' }
end

Declines the request.

form? ()

Source

# File lib/ruby_llm/input_request.rb, line 112
def form?
  !url?
end

Returns whether the server asks for fields.

url? ()

Source

# File lib/ruby_llm/input_request.rb, line 107
def url?
  !url.nil?
end

Returns whether the server asks the user to visit url.